Package net.okocraft.box.api.util

Class SubscribedListenerHolder

java.lang.Object

net.okocraft.box.api.util.SubscribedListenerHolder

public final class SubscribedListenerHolder
extends Object

A utility class for holding SubscribedListeners.

This can be used after BoxAPI is initialized.

Constructor Summary

Constructors

Constructor	Description
SubscribedListenerHolder()

Method Summary

Modifier and Type	Method	Description
void	add(@NotNull SubscribedListener<net.kyori.adventure.key.Key,? extends BoxEvent,Priority> listener)	Adds a SubscribedListener.
void	addAll(@NotNull List<SubscribedListener<net.kyori.adventure.key.Key,? extends BoxEvent,Priority>> listeners)	Adds the SubscribedListeners.
@NotNull @UnmodifiableView List<SubscribedListener<net.kyori.adventure.key.Key,? extends BoxEvent,Priority>>	getListeners()	Gets the SubscribedListeners this instance holds.
void	subscribeAll(@NotNull UnaryOperator<ListenerSubscriber.BulkSubscriber<net.kyori.adventure.key.Key,BoxEvent,Priority>> operator)	Subscribes listeners to BoxAPI.getListenerSubscriber() using ListenerSubscriber.BulkSubscriber and holds SubscribedListeners it returns.
void	unsubscribeAll()	Unsubscribes SubscribedListeners this instance holds.

Methods inherited from class java.lang.Object

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

Constructor Details

SubscribedListenerHolder

public SubscribedListenerHolder()

Method Details

add

public void add(@NotNull
 @NotNull SubscribedListener<net.kyori.adventure.key.Key,? extends BoxEvent,Priority> listener)

Adds a SubscribedListener.

Parameters:

listener - a SubscribedListener

addAll

public void addAll(@NotNull
 @NotNull List<SubscribedListener<net.kyori.adventure.key.Key,? extends BoxEvent,Priority>> listeners)

Adds the SubscribedListeners.

Parameters:

listeners - the SubscribedListeners

getListeners

@Contract(pure=true)
@NotNull
public @NotNull @UnmodifiableView List<SubscribedListener<net.kyori.adventure.key.Key,? extends BoxEvent,Priority>> getListeners()

Gets the SubscribedListeners this instance holds.

Returns:

the SubscribedListeners this instance holds

subscribeAll

public void subscribeAll(@NotNull
 @NotNull UnaryOperator<ListenerSubscriber.BulkSubscriber<net.kyori.adventure.key.Key,BoxEvent,Priority>> operator)

Subscribes listeners to BoxAPI.getListenerSubscriber() using ListenerSubscriber.BulkSubscriber and holds SubscribedListeners it returns.

Parameters:

operator - the UnaryOperator to modify ListenerSubscriber.BulkSubscriber

unsubscribeAll

public void unsubscribeAll()

Unsubscribes SubscribedListeners this instance holds.