me.lucko.helper.event.functional.single

Interface SingleSubscriptionBuilder<T extends Event>

Type Parameters:

T - the event type

All Superinterfaces:

SubscriptionBuilder<T>

public interface SingleSubscriptionBuilder<T extends Event>
extends SubscriptionBuilder<T>

Functional builder for SingleSubscriptions.

Field Summary

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

DEFAULT_EXCEPTION_CONSUMER

Method Summary

Modifier and Type	Method and Description
default SingleSubscription<T>	biHandler(BiConsumer<SingleSubscription<T>,? super T> handler) Builds and registers the Handler.
SingleSubscriptionBuilder<T>	exceptionConsumer(BiConsumer<? super T,Throwable> consumer) Sets the exception consumer for the handler.
default SingleSubscriptionBuilder<T>	expireAfter(long maxCalls) Sets the number of calls until the handler will automatically be unregistered
default SingleSubscriptionBuilder<T>	expireAfter(long duration, TimeUnit unit) Sets the expiry time on the handler
SingleSubscriptionBuilder<T>	expireIf(BiPredicate<SingleSubscription<T>,T> predicate, ExpiryTestStage... testPoints) Add a expiry predicate.
default SingleSubscriptionBuilder<T>	expireIf(Predicate<T> predicate) Add a expiry predicate.
SingleSubscriptionBuilder<T>	filter(Predicate<T> predicate) Adds a filter to the handler.
default SingleSubscription<T>	handler(Consumer<? super T> handler) Builds and registers the Handler.
SingleHandlerList<T>	handlers() Return the handler list builder to append handlers for the event.
SingleSubscriptionBuilder<T>	handleSubclasses() Sets that the handler should accept subclasses of the event type.
static <T extends Event> SingleSubscriptionBuilder<T>	newBuilder(Class<T> eventClass) Makes a HandlerBuilder for a given event
static <T extends Event> SingleSubscriptionBuilder<T>	newBuilder(Class<T> eventClass, EventPriority priority) Makes a HandlerBuilder for a given event

Method Detail

newBuilder

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

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

newBuilder

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

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

expireIf

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

Description copied from interface: SubscriptionBuilder

Add a expiry predicate.

Specified by:

expireIf in interface SubscriptionBuilder<T extends Event>

Parameters:

predicate - the expiry test

Returns:

ths builder instance

expireAfter

@Nonnull
default SingleSubscriptionBuilder<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 extends Event>

Parameters:

duration - the duration until expiry

unit - the unit for the duration

Returns:

the builder instance

expireAfter

@Nonnull
default SingleSubscriptionBuilder<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 extends Event>

Parameters:

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

Returns:

the builder instance

filter

@Nonnull
SingleSubscriptionBuilder<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 extends Event>

Parameters:

predicate - the filter

Returns:

the builder instance

expireIf

@Nonnull
SingleSubscriptionBuilder<T> expireIf(@Nonnull
                                               BiPredicate<SingleSubscription<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

exceptionConsumer

@Nonnull
SingleSubscriptionBuilder<T> exceptionConsumer(@Nonnull
                                                        BiConsumer<? super T,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

handleSubclasses

@Nonnull
SingleSubscriptionBuilder<T> handleSubclasses()

Sets that the handler should accept subclasses of the event type.

Returns:

the builder instance

handlers

@Nonnull
SingleHandlerList<T> handlers()

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

Returns:

the handler list

handler

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

Builds and registers the Handler.

Parameters:

handler - the consumer responsible for handling the event.

Returns:

a registered SingleSubscription instance.

Throws:

NullPointerException - if the handler is null

biHandler

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

Builds and registers the Handler.

Parameters:

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

Returns:

a registered SingleSubscription instance.

Throws:

NullPointerException - if the handler is null