Package dev.siroshun.event4j.api.listener

Interface ListenerSubscriber<K,E,O>

Type Parameters:

K - the key type

E - the event type

O - the order type

public interface ListenerSubscriber<K,E,O>

An interface to subscribe/unsubscribe listeners.

This interface can also be used to get existing listeners.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ListenerSubscriber.BulkSubscriber<K,E,O>	An interface for subscribing multiple listeners at once.

Method Summary

Modifier and Type	Method	Description
@NotNull Collection<SubscribedListener<K,? extends E,O>>	allListeners()	Gets all existing SubscribedListeners.
@NotNull ListenerSubscriber.BulkSubscriber<K,E,O>	bulkSubscriber()	Creates a new ListenerSubscriber.BulkSubscriber for subscribing multiple listeners at once.
<T extends E> @NotNull List<SubscribedListener<K,T,O>>	listenersFor(@NotNull Class<T> eventClass)	Gets the existing SubscribedListeners for the specified event.
<T extends E> @NotNull SubscribedListener<K,T,O>	subscribe(@NotNull Class<T> eventClass, @NotNull Consumer<? super ListenerFactory<K,T,O>> builder)	Subscribes a new listener for the specified event.
<T extends E> @NotNull SubscribedListener<K,T,O>	subscribe(@NotNull Class<T> eventClass, K key, @NotNull Consumer<? super T> consumer)	Subscribes a new listener for the specified event.
<T extends E> @NotNull SubscribedListener<K,T,O>	subscribe(@NotNull Class<T> eventClass, K key, @NotNull Consumer<? super T> consumer, O order)	Subscribes a new listener for the specified event.
void	unsubscribe(@NotNull SubscribedListener<K,? extends E,O> subscribedListener)	Unsubscribes the specified SubscribedListener.
void	unsubscribeAll(@NotNull Collection<SubscribedListener<K,? extends E,O>> subscribedListeners)	Unsubscribes the specified SubscribedListeners.
void	unsubscribeByKey(K key)	Unsubscribes listeners by the specified key.
void	unsubscribeIf(@NotNull Predicate<SubscribedListener<K,? extends E,O>> predicate)	Unsubscribes all listeners that satisfy the given Predicate.

Method Details

allListeners

@NotNull
@NotNull Collection<SubscribedListener<K,? extends E,O>> allListeners()

Gets all existing SubscribedListeners.

Returns:

all existing SubscribedListeners

listenersFor

@NotNull
<T extends E>
@NotNull List<SubscribedListener<K,T,O>> listenersFor(@NotNull
 @NotNull Class<T> eventClass)

Gets the existing SubscribedListeners for the specified event.

Type Parameters:

T - the event type

Parameters:

eventClass - the class of the event

Returns:

the existing SubscribedListeners for the specified event

subscribe

@NotNull
<T extends E> @NotNull SubscribedListener<K,T,O> subscribe(@NotNull
 @NotNull Class<T> eventClass,
 @NotNull
 @NotNull Consumer<? super ListenerFactory<K,T,O>> builder)

Subscribes a new listener for the specified event.

Type Parameters:

T - the event type

Parameters:

eventClass - the class of the event

builder - the Consumer to modify ListenerFactory

Returns:

a SubscribedListener

subscribe

@NotNull
<T extends E> @NotNull SubscribedListener<K,T,O> subscribe(@NotNull
 @NotNull Class<T> eventClass,
 @NotNull
 K key,
 @NotNull
 @NotNull Consumer<? super T> consumer)

Subscribes a new listener for the specified event.

Type Parameters:

T - the event type

Parameters:

eventClass - the class of the event

key - the key

consumer - the Consumer

Returns:

a SubscribedListener

subscribe

@NotNull
<T extends E> @NotNull SubscribedListener<K,T,O> subscribe(@NotNull
 @NotNull Class<T> eventClass,
 @NotNull
 K key,
 @NotNull
 @NotNull Consumer<? super T> consumer,
 @Nullable
 O order)

Subscribes a new listener for the specified event.

Type Parameters:

T - the event type

Parameters:

eventClass - the class of the event

key - the key

consumer - the Consumer

order - the order, passing null to use a default order

Returns:

a SubscribedListener

bulkSubscriber

@Contract("-> new")
@NotNull
@NotNull ListenerSubscriber.BulkSubscriber<K,E,O> bulkSubscriber()

Creates a new ListenerSubscriber.BulkSubscriber for subscribing multiple listeners at once.

Returns:

a new ListenerSubscriber.BulkSubscriber

unsubscribe

void unsubscribe(@NotNull
 @NotNull SubscribedListener<K,? extends E,O> subscribedListener)

Unsubscribes the specified SubscribedListener.

Parameters:

subscribedListener - the SubscribedListener to unsubscribe

unsubscribeAll

void unsubscribeAll(@NotNull
 @NotNull Collection<SubscribedListener<K,? extends E,O>> subscribedListeners)

Unsubscribes the specified SubscribedListeners.

Parameters:

subscribedListeners - the SubscribedListeners to unsubscribe

unsubscribeByKey

void unsubscribeByKey(@NotNull
 K key)

Unsubscribes listeners by the specified key.

Parameters:

key - the key

unsubscribeIf

void unsubscribeIf(@NotNull
 @NotNull Predicate<SubscribedListener<K,? extends E,O>> predicate)

Unsubscribes all listeners that satisfy the given Predicate.

Parameters:

predicate - a predicate which returns true for listeners to be unsubscribed