me.lucko.helper

Class Events

java.lang.Object

me.lucko.helper.Events

public final class Events
extends Object

A functional event listening utility.

Method Summary

Modifier and Type	Method and Description
static void	call(Event event) Submit the event on the current thread
static <T extends Event> T	callAndReturn(T event) Submit the event on the current thread
static void	callAsync(Event event) Submit the event on a new async thread.
static <T extends Event> T	callAsyncAndJoin(T event) Submit the event on a new async thread.
static void	callSync(Event event) Submit the event on the main server thread.
static <T extends Event> T	callSyncAndJoin(T event) Submit the event on the main server thread.
static <S extends Event> MergedSubscriptionBuilder<S>	merge(Class<S> superClass, Class<? extends S>... eventClasses) Makes a MergedSubscriptionBuilder for a super event class
static <S extends Event> MergedSubscriptionBuilder<S>	merge(Class<S> superClass, EventPriority priority, Class<? extends S>... eventClasses) Makes a MergedSubscriptionBuilder for a super event class
static <T> MergedSubscriptionBuilder<T>	merge(Class<T> handledClass) Makes a MergedSubscriptionBuilder for a given super type
static <T> MergedSubscriptionBuilder<T>	merge(TypeToken<T> type) Makes a MergedSubscriptionBuilder for a given super type
static <T extends Event> SingleSubscriptionBuilder<T>	subscribe(Class<T> eventClass) Makes a SingleSubscriptionBuilder for a given event
static <T extends Event> SingleSubscriptionBuilder<T>	subscribe(Class<T> eventClass, EventPriority priority) Makes a SingleSubscriptionBuilder for a given event

Methods inherited from class java.lang.Object

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

Method Detail

subscribe

@Nonnull
public static <T extends Event> SingleSubscriptionBuilder<T> subscribe(@Nonnull
                                                                                Class<T> eventClass)

Makes a SingleSubscriptionBuilder for a given event

Type Parameters:

T - the event type

Parameters:

eventClass - the class of the event

Returns:

a SingleSubscriptionBuilder to construct the event handler

Throws:

NullPointerException - if eventClass is null

subscribe

@Nonnull
public static <T extends Event> SingleSubscriptionBuilder<T> subscribe(@Nonnull
                                                                                Class<T> eventClass,
                                                                                @Nonnull
                                                                                EventPriority priority)

Makes a SingleSubscriptionBuilder for a given event

Type Parameters:

T - the event type

Parameters:

eventClass - the class of the event

priority - the priority to listen at

Returns:

a SingleSubscriptionBuilder to construct the event handler

Throws:

NullPointerException - if eventClass or priority is null

merge

@Nonnull
public static <T> MergedSubscriptionBuilder<T> merge(@Nonnull
                                                              Class<T> handledClass)

Makes a MergedSubscriptionBuilder for a given super type

Type Parameters:

T - the super type class

Parameters:

handledClass - the super type of the event handler

Returns:

a MergedSubscriptionBuilder to construct the event handler

merge

@Nonnull
public static <T> MergedSubscriptionBuilder<T> merge(@Nonnull
                                                              TypeToken<T> type)

Makes a MergedSubscriptionBuilder for a given super type

Type Parameters:

T - the super type class

Parameters:

type - the super type of the event handler

Returns:

a MergedSubscriptionBuilder to construct the event handler

merge

@Nonnull
 @SafeVarargs
public static <S extends Event> MergedSubscriptionBuilder<S> merge(@Nonnull
                                                                                          Class<S> superClass,
                                                                                          @Nonnull
                                                                                          Class<? extends S>... eventClasses)

Makes a MergedSubscriptionBuilder for a super event class

Type Parameters:

S - the super class type

Parameters:

superClass - the abstract super event class

eventClasses - the event classes to be bound to

Returns:

a MergedSubscriptionBuilder to construct the event handler

merge

@Nonnull
 @SafeVarargs
public static <S extends Event> MergedSubscriptionBuilder<S> merge(@Nonnull
                                                                                          Class<S> superClass,
                                                                                          @Nonnull
                                                                                          EventPriority priority,
                                                                                          @Nonnull
                                                                                          Class<? extends S>... eventClasses)

Makes a MergedSubscriptionBuilder for a super event class

Type Parameters:

S - the super class type

Parameters:

superClass - the abstract super event class

priority - the priority to listen at

eventClasses - the event classes to be bound to

Returns:

a MergedSubscriptionBuilder to construct the event handler

call

public static void call(@Nonnull
                        Event event)

Submit the event on the current thread

Parameters:

event - the event to call

callAsync

public static void callAsync(@Nonnull
                             Event event)

Submit the event on a new async thread.

Parameters:

event - the event to call

callSync

public static void callSync(@Nonnull
                            Event event)

Submit the event on the main server thread.

Parameters:

event - the event to call

callAndReturn

@Nonnull
public static <T extends Event> T callAndReturn(@Nonnull
                                                         T event)

Submit the event on the current thread

Parameters:

event - the event to call

callAsyncAndJoin

@Nonnull
public static <T extends Event> T callAsyncAndJoin(@Nonnull
                                                            T event)

Submit the event on a new async thread.

Parameters:

event - the event to call

callSyncAndJoin

@Nonnull
public static <T extends Event> T callSyncAndJoin(@Nonnull
                                                           T event)

Submit the event on the main server thread.

Parameters:

event - the event to call