me.lucko.helper.event.functional.protocol

Interface ProtocolSubscriptionBuilder

All Superinterfaces:

SubscriptionBuilder<com.comphenix.protocol.events.PacketEvent>

public interface ProtocolSubscriptionBuilder
extends SubscriptionBuilder<com.comphenix.protocol.events.PacketEvent>

Functional builder for ProtocolSubscriptions.

Field Summary

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

DEFAULT_EXCEPTION_CONSUMER

Method Summary

Modifier and Type	Method and Description
default ProtocolSubscription	biHandler(BiConsumer<ProtocolSubscription,? super com.comphenix.protocol.events.PacketEvent> handler) Builds and registers the Handler.
ProtocolSubscriptionBuilder	exceptionConsumer(BiConsumer<? super com.comphenix.protocol.events.PacketEvent,Throwable> consumer) Sets the exception consumer for the handler.
default ProtocolSubscriptionBuilder	expireAfter(long maxCalls) Sets the number of calls until the handler will automatically be unregistered
default ProtocolSubscriptionBuilder	expireAfter(long duration, TimeUnit unit) Sets the expiry time on the handler
ProtocolSubscriptionBuilder	expireIf(BiPredicate<ProtocolSubscription,com.comphenix.protocol.events.PacketEvent> predicate, ExpiryTestStage... testPoints) Add a expiry predicate.
default ProtocolSubscriptionBuilder	expireIf(Predicate<com.comphenix.protocol.events.PacketEvent> predicate) Add a expiry predicate.
ProtocolSubscriptionBuilder	filter(Predicate<com.comphenix.protocol.events.PacketEvent> predicate) Adds a filter to the handler.
default ProtocolSubscription	handler(Consumer<? super com.comphenix.protocol.events.PacketEvent> handler) Builds and registers the Handler.
ProtocolHandlerList	handlers() Return the handler list builder to append handlers for the event.
static ProtocolSubscriptionBuilder	newBuilder(com.comphenix.protocol.events.ListenerPriority priority, com.comphenix.protocol.PacketType... packets) Makes a HandlerBuilder for the given packets
static ProtocolSubscriptionBuilder	newBuilder(com.comphenix.protocol.PacketType... packets) Makes a HandlerBuilder for the given packets

Method Detail

newBuilder

@Nonnull
static ProtocolSubscriptionBuilder newBuilder(@Nonnull
                                                       com.comphenix.protocol.PacketType... packets)

Makes a HandlerBuilder for the given packets

Parameters:

packets - the packets to handle

Returns:

a ProtocolSubscriptionBuilder to construct the event handler

newBuilder

@Nonnull
static ProtocolSubscriptionBuilder newBuilder(@Nonnull
                                                       com.comphenix.protocol.events.ListenerPriority priority,
                                                       @Nonnull
                                                       com.comphenix.protocol.PacketType... packets)

Makes a HandlerBuilder for the given packets

Parameters:

priority - the priority to listen at

packets - the packets to handle

Returns:

a ProtocolSubscriptionBuilder to construct the event handler

expireIf

@Nonnull
default ProtocolSubscriptionBuilder expireIf(@Nonnull
                                                      Predicate<com.comphenix.protocol.events.PacketEvent> predicate)

Description copied from interface: SubscriptionBuilder

Add a expiry predicate.

Specified by:

expireIf in interface SubscriptionBuilder<com.comphenix.protocol.events.PacketEvent>

Parameters:

predicate - the expiry test

Returns:

ths builder instance

expireAfter

@Nonnull
default ProtocolSubscriptionBuilder expireAfter(long duration,
                                                         @Nonnull
                                                         TimeUnit unit)

Description copied from interface: SubscriptionBuilder

Sets the expiry time on the handler

Specified by:

expireAfter in interface SubscriptionBuilder<com.comphenix.protocol.events.PacketEvent>

Parameters:

duration - the duration until expiry

unit - the unit for the duration

Returns:

the builder instance

expireAfter

@Nonnull
default ProtocolSubscriptionBuilder 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<com.comphenix.protocol.events.PacketEvent>

Parameters:

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

Returns:

the builder instance

filter

@Nonnull
ProtocolSubscriptionBuilder filter(@Nonnull
                                            Predicate<com.comphenix.protocol.events.PacketEvent> 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<com.comphenix.protocol.events.PacketEvent>

Parameters:

predicate - the filter

Returns:

the builder instance

expireIf

@Nonnull
ProtocolSubscriptionBuilder expireIf(@Nonnull
                                              BiPredicate<ProtocolSubscription,com.comphenix.protocol.events.PacketEvent> 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
ProtocolSubscriptionBuilder exceptionConsumer(@Nonnull
                                                       BiConsumer<? super com.comphenix.protocol.events.PacketEvent,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
ProtocolHandlerList handlers()

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

Returns:

the handler list

handler

@Nonnull
default ProtocolSubscription handler(@Nonnull
                                              Consumer<? super com.comphenix.protocol.events.PacketEvent> handler)

Builds and registers the Handler.

Parameters:

handler - the consumer responsible for handling the event.

Returns:

a registered ProtocolSubscription instance.

Throws:

NullPointerException - if the handler is null

biHandler

@Nonnull
default ProtocolSubscription biHandler(@Nonnull
                                                BiConsumer<ProtocolSubscription,? super com.comphenix.protocol.events.PacketEvent> handler)

Builds and registers the Handler.

Parameters:

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

Returns:

a registered ProtocolSubscription instance.

Throws:

NullPointerException - if the handler is null