net.kyori.event

Interface EventSubscriber<E>

Type Parameters:

E - the event type

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface EventSubscriber<E>

A functional interface representing an object that can handle a given type of event.

Method Summary

Modifier and Type	Method and Description
default boolean	consumeCancelledEvents() Gets if cancelled events should be posted to this subscriber.
default @Nullable java.lang.reflect.Type	genericType() Gets the generic type of this subscriber, if it is known.
void	invoke(E event) Invokes this event subscriber.
default int	postOrder() Gets the post order this subscriber should be called at.

Method Detail

invoke

void invoke(E event)
     throws java.lang.Throwable

Invokes this event subscriber.

Called by the event bus when a new event is "posted" to this subscriber.

Parameters:

event - the event that was posted

Throws:

java.lang.Throwable - any exception thrown during handling

postOrder

default int postOrder()

Gets the post order this subscriber should be called at.

Returns:

the post order of this subscriber

See Also:

PostOrders

consumeCancelledEvents

default boolean consumeCancelledEvents()

Gets if cancelled events should be posted to this subscriber.

Returns:

if cancelled events should be posted

genericType

default @Nullable java.lang.reflect.Type genericType()

Gets the generic type of this subscriber, if it is known.

Returns:

the generic type of the subscriber