net.kyori.event

Interface EventBus<E>

Type Parameters:

E - the event type

All Known Implementing Classes:

SimpleEventBus

public interface EventBus<E>

Base interface of the library, representing an object which accepts registration of EventSubscribers, and supports posting events to them.

EventSubscribers will receive all events which are applicable (can be casted) to their registered type.

Method Summary

Modifier and Type	Method and Description
@NonNull java.lang.Class<E>	eventType() Gets the event type of the bus.
<T extends E> boolean	hasSubscribers(@NonNull java.lang.Class<T> clazz) Determines whether or not the specified event has subscribers.
@NonNull PostResult	post(E event) Posts an event to all registered subscribers.
<T extends E> void	register(@NonNull java.lang.Class<T> clazz, @NonNull EventSubscriber<? super T> subscriber) Registers the given subscriber to receive events.
@NonNull com.google.common.collect.SetMultimap<java.lang.Class<?>,EventSubscriber<?>>	subscribers() Gets an immutable multimap containing all of the subscribers currently registered.
void	unregister(@NonNull EventSubscriber<?> subscriber) Unregisters a previously registered subscriber.
void	unregister(@NonNull java.util.function.Predicate<EventSubscriber<?>> predicate) Unregisters all subscribers matching the predicate.
void	unregisterAll() Unregisters all subscribers.

Method Detail

eventType

@NonNull java.lang.Class<E> eventType()

Gets the event type of the bus.

This is represented by the E type parameter.

Returns:

the event type

post

@NonNull PostResult post(E event)

Posts an event to all registered subscribers.

Parameters:

event - the event

Returns:

the post result of the operation

register

<T extends E> void register(@NonNull java.lang.Class<T> clazz,
                            @NonNull EventSubscriber<? super T> subscriber)

Registers the given subscriber to receive events.

Type Parameters:

T - the event type

Parameters:

clazz - the registered type. the subscriber will only receive events which can be casted to this type.

subscriber - the subscriber

unregister

void unregister(@NonNull EventSubscriber<?> subscriber)

Unregisters a previously registered subscriber.

Parameters:

subscriber - the subscriber

unregister

void unregister(@NonNull java.util.function.Predicate<EventSubscriber<?>> predicate)

Unregisters all subscribers matching the predicate.

Parameters:

predicate - the predicate to test subscribers for removal

unregisterAll

void unregisterAll()

Unregisters all subscribers.

hasSubscribers

<T extends E> boolean hasSubscribers(@NonNull java.lang.Class<T> clazz)

Determines whether or not the specified event has subscribers.

Type Parameters:

T - the event type

Parameters:

clazz - the event clazz

Returns:

whether or not the specified event has subscribers

subscribers

@NonNull com.google.common.collect.SetMultimap<java.lang.Class<?>,EventSubscriber<?>> subscribers()

Gets an immutable multimap containing all of the subscribers currently registered.

Each subscriber is mapped to the type defined when it was initially registered.

Returns:

a multimap of the current subscribers