net.kyori.event

Class SimpleEventBus<E>

java.lang.Object

net.kyori.event.SimpleEventBus<E>

All Implemented Interfaces:

EventBus<E>

public class SimpleEventBus<E>
extends java.lang.Object
implements EventBus<E>

A simple implementation of an event bus.

Constructor Summary

Constructors

Constructor and Description
SimpleEventBus(@NonNull java.lang.Class<E> type)

Method Summary

Modifier and Type	Method and Description
protected boolean	eventCancelled(E event) Returns if a given event instance is currently "cancelled".
protected @Nullable java.lang.reflect.Type	eventGenericType(E event) Gets the generic Type of a given event.
@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.
protected boolean	shouldPost(E event, @NonNull EventSubscriber<?> subscriber) Tests if the event should be posted to the subscriber.
@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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SimpleEventBus

public SimpleEventBus(@NonNull java.lang.Class<E> type)

Method Detail

eventType

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

Description copied from interface: EventBus

Gets the event type of the bus.

This is represented by the E type parameter.

Specified by:

eventType in interface EventBus<E>

Returns:

the event type

eventCancelled

protected boolean eventCancelled(E event)

Returns if a given event instance is currently "cancelled".

The default implementation of this method uses the Cancellable interface to determine if an event is cancelled.

Parameters:

event - the event

Returns:

true if the event is cancelled

eventGenericType

protected @Nullable java.lang.reflect.Type eventGenericType(E event)

Gets the generic Type of a given event.

The default implementation of this method uses the ReifiedEvent interface to read the generic type of an event.

Parameters:

event - the event

Returns:

the generic event type, or null if unknown

shouldPost

protected boolean shouldPost(E event,
                             @NonNull EventSubscriber<?> subscriber)

Tests if the event should be posted to the subscriber.

The default implementation of this method tests for cancellation status and matching event/subscriber generic types.

Parameters:

event - the event

subscriber - the subscriber

Returns:

true if the event should be posted

post

public @NonNull PostResult post(E event)

Description copied from interface: EventBus

Posts an event to all registered subscribers.

Specified by:

post in interface EventBus<E>

Parameters:

event - the event

Returns:

the post result of the operation

register

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

Description copied from interface: EventBus

Registers the given subscriber to receive events.

Specified by:

register in interface EventBus<E>

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

public void unregister(@NonNull EventSubscriber<?> subscriber)

Description copied from interface: EventBus

Unregisters a previously registered subscriber.

Specified by:

unregister in interface EventBus<E>

Parameters:

subscriber - the subscriber

unregister

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

Description copied from interface: EventBus

Unregisters all subscribers matching the predicate.

Specified by:

unregister in interface EventBus<E>

Parameters:

predicate - the predicate to test subscribers for removal

unregisterAll

public void unregisterAll()

Description copied from interface: EventBus

Unregisters all subscribers.

Specified by:

unregisterAll in interface EventBus<E>

hasSubscribers

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

Description copied from interface: EventBus

Determines whether or not the specified event has subscribers.

Specified by:

hasSubscribers in interface EventBus<E>

Type Parameters:

T - the event type

Parameters:

clazz - the event clazz

Returns:

whether or not the specified event has subscribers

subscribers

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

Description copied from interface: EventBus

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

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

Specified by:

subscribers in interface EventBus<E>

Returns:

a multimap of the current subscribers