mirror of https://github.com/Minestom/Minestom.git
38 lines
1.2 KiB
Java
38 lines
1.2 KiB
Java
package net.minestom.server.event;
|
|
|
|
import org.jetbrains.annotations.ApiStatus;
|
|
import org.jetbrains.annotations.NotNull;
|
|
|
|
/**
|
|
* Represents a key to a listenable event, retrievable from {@link EventNode#getHandle(Class)}.
|
|
* Useful to avoid map lookups.
|
|
* <p>
|
|
* It is recommended to store instances of this class in {@code static final} fields.
|
|
*
|
|
* @param <E> the event type
|
|
*/
|
|
@ApiStatus.Experimental
|
|
public sealed interface ListenerHandle<E extends Event> permits EventNodeImpl.Handle {
|
|
/**
|
|
* Calls the given event.
|
|
* Will try to fast exit the execution when possible if {@link #hasListener()} return {@code false}.
|
|
* <p>
|
|
* Anonymous and subclasses are not supported, events must have the exact type {@code E}.
|
|
*
|
|
* @param event the event to call
|
|
*/
|
|
void call(@NotNull E event);
|
|
|
|
/**
|
|
* Gets if any listener has been registered for the given handle.
|
|
* May trigger an update if the cached data is not correct.
|
|
* <p>
|
|
* Useful if you are able to avoid expensive computation in the case where
|
|
* the event is unused. Be aware that {@link #call(Event)}
|
|
* has similar optimization built-in.
|
|
*
|
|
* @return true if the event has 1 or more listeners
|
|
*/
|
|
boolean hasListener();
|
|
}
|