me.lucko.helper.event.functional.merged

Interface MergedSubscriptionBuilder<T>

Type Parameters:

T - the handled type

All Superinterfaces:

SubscriptionBuilder<T>

public interface MergedSubscriptionBuilder<T>
extends SubscriptionBuilder<T>

Functional builder for MergedSubscriptions.

Field Summary

Fields inherited from interface me.lucko.helper.event.functional.SubscriptionBuilder

DEFAULT_EXCEPTION_CONSUMER

Method Summary

Modifier and Type	Method and Description
default MergedSubscription<T>	biHandler(BiConsumer<MergedSubscription<T>,? super T> handler) Builds and registers the Handler.
<E extends org.bukkit.event.Event> MergedSubscriptionBuilder<T>	bindEvent(Class<E> eventClass, org.bukkit.event.EventPriority priority, Function<E,T> function) Binds this handler to an event
<E extends org.bukkit.event.Event> MergedSubscriptionBuilder<T>	bindEvent(Class<E> eventClass, Function<E,T> function) Binds this handler to an event
MergedSubscriptionBuilder<T>	exceptionConsumer(BiConsumer<org.bukkit.event.Event,Throwable> consumer) Sets the exception consumer for the handler.
default MergedSubscriptionBuilder<T>	expireAfter(long maxCalls) Sets the number of calls until the handler will automatically be unregistered
default MergedSubscriptionBuilder<T>	expireAfter(long duration, TimeUnit unit) Sets the expiry time on the handler
MergedSubscriptionBuilder<T>	expireIf(BiPredicate<MergedSubscription<T>,T> predicate, ExpiryTestStage... testPoints) Add a expiry predicate.
default MergedSubscriptionBuilder<T>	expireIf(Predicate<T> predicate) Add a expiry predicate.
MergedSubscriptionBuilder<T>	filter(Predicate<T> predicate) Adds a filter to the handler.
default MergedSubscription<T>	handler(Consumer<? super T> handler) Builds and registers the Handler.
MergedHandlerList<T>	handlers() Return the handler list builder to append handlers for the event.
static <S extends org.bukkit.event.Event> MergedSubscriptionBuilder<S>	newBuilder(Class<S> superClass, Class<? extends S>... eventClasses) Makes a MergedHandlerBuilder for a super event class
static <S extends org.bukkit.event.Event> MergedSubscriptionBuilder<S>	newBuilder(Class<S> superClass, org.bukkit.event.EventPriority priority, Class<? extends S>... eventClasses) Makes a MergedHandlerBuilder for a super event class
static <T> MergedSubscriptionBuilder<T>	newBuilder(Class<T> handledClass) Makes a MergedHandlerBuilder for a given super type
static <T> MergedSubscriptionBuilder<T>	newBuilder(com.google.common.reflect.TypeToken<T> type) Makes a MergedHandlerBuilder for a given super type

Method Detail

newBuilder

@Nonnull
static <T> MergedSubscriptionBuilder<T> newBuilder(@Nonnull
                                                            Class<T> handledClass)

Makes a MergedHandlerBuilder 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

newBuilder

@Nonnull
static <T> MergedSubscriptionBuilder<T> newBuilder(@Nonnull
                                                            com.google.common.reflect.TypeToken<T> type)

Makes a MergedHandlerBuilder 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

newBuilder

@Nonnull
 @SafeVarargs
static <S extends org.bukkit.event.Event> MergedSubscriptionBuilder<S> newBuilder(@Nonnull
                                                                                                         Class<S> superClass,
                                                                                                         @Nonnull
                                                                                                         Class<? extends S>... eventClasses)

Makes a MergedHandlerBuilder 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

newBuilder

@Nonnull
 @SafeVarargs
static <S extends org.bukkit.event.Event> MergedSubscriptionBuilder<S> newBuilder(@Nonnull
                                                                                                         Class<S> superClass,
                                                                                                         @Nonnull
                                                                                                         org.bukkit.event.EventPriority priority,
                                                                                                         @Nonnull
                                                                                                         Class<? extends S>... eventClasses)

Makes a MergedHandlerBuilder 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

expireIf

@Nonnull
default MergedSubscriptionBuilder<T> expireIf(@Nonnull
                                                       Predicate<T> predicate)

Description copied from interface: SubscriptionBuilder

Add a expiry predicate.

Specified by:

expireIf in interface SubscriptionBuilder<T>

Parameters:

predicate - the expiry test

Returns:

ths builder instance

expireAfter

@Nonnull
default MergedSubscriptionBuilder<T> expireAfter(long duration,
                                                          @Nonnull
                                                          TimeUnit unit)

Description copied from interface: SubscriptionBuilder

Sets the expiry time on the handler

Specified by:

expireAfter in interface SubscriptionBuilder<T>

Parameters:

duration - the duration until expiry

unit - the unit for the duration

Returns:

the builder instance

expireAfter

@Nonnull
default MergedSubscriptionBuilder<T> expireAfter(long maxCalls)

Description copied from interface: SubscriptionBuilder

Sets the number of calls until the handler will automatically be unregistered

The call counter is only incremented if the event call passes all filters and if the handler completes without throwing an exception.

Specified by:

expireAfter in interface SubscriptionBuilder<T>

Parameters:

maxCalls - the number of times the handler will be called until being unregistered.

Returns:

the builder instance

filter

@Nonnull
MergedSubscriptionBuilder<T> filter(@Nonnull
                                             Predicate<T> predicate)

Description copied from interface: SubscriptionBuilder

Adds a filter to the handler.

An event will only be handled if it passes all filters. Filters are evaluated in the order they are registered.

Specified by:

filter in interface SubscriptionBuilder<T>

Parameters:

predicate - the filter

Returns:

the builder instance

expireIf

@Nonnull
MergedSubscriptionBuilder<T> expireIf(@Nonnull
                                               BiPredicate<MergedSubscription<T>,T> predicate,
                                               @Nonnull
                                               ExpiryTestStage... testPoints)

Add a expiry predicate.

Parameters:

predicate - the expiry test

testPoints - when to test the expiry predicate

Returns:

ths builder instance

bindEvent

@Nonnull
<E extends org.bukkit.event.Event> MergedSubscriptionBuilder<T> bindEvent(@Nonnull
                                                                                   Class<E> eventClass,
                                                                                   @Nonnull
                                                                                   Function<E,T> function)

Binds this handler to an event

Type Parameters:

E - the event class

Parameters:

eventClass - the event class to bind to

function - the function to remap the event

Returns:

the builder instance

bindEvent

@Nonnull
<E extends org.bukkit.event.Event> MergedSubscriptionBuilder<T> bindEvent(@Nonnull
                                                                                   Class<E> eventClass,
                                                                                   @Nonnull
                                                                                   org.bukkit.event.EventPriority priority,
                                                                                   @Nonnull
                                                                                   Function<E,T> function)

Binds this handler to an event

Type Parameters:

E - the event class

Parameters:

eventClass - the event class to bind to

priority - the priority to listen at

function - the function to remap the event

Returns:

the builder instance

exceptionConsumer

@Nonnull
MergedSubscriptionBuilder<T> exceptionConsumer(@Nonnull
                                                        BiConsumer<org.bukkit.event.Event,Throwable> consumer)

Sets the exception consumer for the handler.

If an exception is thrown in the handler, it is passed to this consumer to be swallowed.

Parameters:

consumer - the consumer

Returns:

the builder instance

Throws:

NullPointerException - if the consumer is null

handlers

@Nonnull
MergedHandlerList<T> handlers()

Return the handler list builder to append handlers for the event.

Returns:

the handler list

handler

@Nonnull
default MergedSubscription<T> handler(@Nonnull
                                               Consumer<? super T> handler)

Builds and registers the Handler.

Parameters:

handler - the consumer responsible for handling the event.

Returns:

a registered MergedSubscription instance.

Throws:

NullPointerException - if the handler is null

IllegalStateException - if no events have been bound to

biHandler

@Nonnull
default MergedSubscription<T> biHandler(@Nonnull
                                                 BiConsumer<MergedSubscription<T>,? super T> handler)

Builds and registers the Handler.

Parameters:

handler - the bi-consumer responsible for handling the event.

Returns:

a registered MergedSubscription instance.

Throws:

NullPointerException - if the handler is null

IllegalStateException - if no events have been bound to