Upstream/Minestom
1
0
Fork 0
mirror of https://github.com/Minestom/Minestom.git synced 2024-11-05 18:32:28 +01:00
Code Issues Projects Releases Wiki Activity

Update doc

Browse Source
This commit is contained in:
TheMode 2021-08-20 05:21:53 +02:00
parent 04be72c429
commit 88a3a7d37c
2 changed files with 27 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
src/main/java/net/minestom/server/event/EventNode.java
View File

@ -182,21 +182,36 @@ public interface EventNode<T extends Event> {
}
/**
* Executes the given event on this node. The event must pass all conditions before
* it will be forwarded to the listeners.
* <p>
* Calling an event on a node will execute all child nodes, however, an event may be
* called anywhere on the event graph and it will propagate down from there only.
* Calls an event starting from this node.
*
* @param event the event to execute
* @param event the event to call
*/
default void call(@NotNull T event) {
//noinspection unchecked
call(event, getHandle((Class<T>) event.getClass()));
}
<E extends T> void call(@NotNull E event, ListenerHandle<E> handle);
/**
* Calls an event starting from this node.
* <p>
* The event handle can be retrieved using {@link #getHandle(Class)}
* and is useful to avoid map lookups for high-frequency events.
*
* @param event the event to call
* @param handle the event handle linked to this node
* @param <E> the event type
* @throws IllegalArgumentException if {@param handle}'s owner is not {@code this}
*/
<E extends T> void call(@NotNull E event, @NotNull ListenerHandle<E> handle);
<E extends T> ListenerHandle<E> getHandle(Class<E> handleType);
/**
* Gets the handle of an event type.
*
* @param handleType the handle type
* @param <E> the event type
* @return the handle linked to {@param handleType}
*/
<E extends T> @NotNull ListenerHandle<E> getHandle(@NotNull Class<E> handleType);
/**
* Execute a cancellable event with a callback to execute if the event is successful.

7
src/main/java/net/minestom/server/event/EventNodeImpl.java
View File

@ -38,9 +38,9 @@ class EventNodeImpl<T extends Event> implements EventNode<T> {
}
@Override
public <E extends T> void call(@NotNull E event, ListenerHandle<E> handle) {
public <E extends T> void call(@NotNull E event, @NotNull ListenerHandle<E> handle) {
var castedHandle = (Handle<T>) handle;
Check.stateCondition(castedHandle.node != this, "Invalid handle owner");
Check.argCondition(castedHandle.node != this, "Invalid handle owner");
List<Consumer<T>> listeners = castedHandle.listeners;
if (!castedHandle.updated) {
synchronized (GLOBAL_CHILD_LOCK) {
@ -56,7 +56,8 @@ class EventNodeImpl<T extends Event> implements EventNode<T> {
}
@Override
public <E extends T> ListenerHandle<E> getHandle(Class<E> handleType) {
public <E extends T> @NotNull ListenerHandle<E> getHandle(@NotNull Class<E> handleType) {
//noinspection unchecked
return (ListenerHandle<E>) handleMap.computeIfAbsent(handleType,
aClass -> new Handle<>(this, (Class<T>) aClass));
}