Package com.helger.base.callback

Class CallbackList<CALLBACKTYPE extends ICallback>

java.lang.Object

com.helger.base.callback.CallbackList<CALLBACKTYPE>

Type Parameters:

CALLBACKTYPE - The callback type.

All Implemented Interfaces:

ICallbackList<CALLBACKTYPE>, ICloneable<CallbackList<CALLBACKTYPE>>, IHasSize, Iterable<CALLBACKTYPE>

@ThreadSafe
public class CallbackList<CALLBACKTYPE extends ICallback>
extends Object
implements ICallbackList<CALLBACKTYPE>, ICloneable<CallbackList<CALLBACKTYPE>>

This class manages a list of callbacks. In reality it is a Set of callbacks.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
CallbackList()	Default constructor with an empty callback list.
CallbackList(@Nullable CallbackList<CALLBACKTYPE> aOther)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
@NonNull EChange	add(@NonNull CALLBACKTYPE aCallback)	Add a callback.
final @NonNull EChange	addAll(@NonNull CALLBACKTYPE... aCallbacks)	Add an array of elements to this collection.
void	forEach(@NonNull Consumer<? super CALLBACKTYPE> aConsumer)
@NonNull EContinue	forEachBreakable(@NonNull Function<? super CALLBACKTYPE,EContinue> aFunction)	Iterate all callbacks and invoke the provided function.
@NonNull List<CALLBACKTYPE>	getAllCallbacks()
@Nullable CALLBACKTYPE	getCallbackAtIndex(int nIndex)	Get the callback at the specified index.
@NonNull CallbackList<CALLBACKTYPE>	getClone()
boolean	isEmpty()
@NonNull Iterator<CALLBACKTYPE>	iterator()
@NonNull EChange	removeAll()	Remove all callbacks
@NonNull EChange	removeObject(@Nullable CALLBACKTYPE aCallback)	Remove the specified callback
@NonNull EChange	set(@NonNull CALLBACKTYPE aCallback)	Clear all elements and add only the passed value.
@NonNull EChange	set(@NonNull CallbackList<CALLBACKTYPE> rhs)	Clear all elements and add all provided values.
int	size()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.base.iface.IHasSize

isNotEmpty

Methods inherited from interface java.lang.Iterable

spliterator

Constructor Details

CallbackList

public CallbackList()

Default constructor with an empty callback list.

CallbackList

public CallbackList(@Nullable CallbackList<CALLBACKTYPE> aOther)

Copy constructor.

Parameters:

aOther - The callback list to copy from. May be null.

Method Details

set

public @NonNull EChange set(@NonNull CallbackList<CALLBACKTYPE> rhs)

Clear all elements and add all provided values. If no value is provided,the collection is empty afterwards.

Parameters:

rhs - the callback list to set. May not be null.

Returns:

EChange

set

public @NonNull EChange set(@NonNull CALLBACKTYPE aCallback)

Clear all elements and add only the passed value.

Parameters:

aCallback - The callback to be used. May not be null.

Returns:

EChange

add

public @NonNull EChange add(@NonNull CALLBACKTYPE aCallback)

Add a callback.

Parameters:

aCallback - May not be null.

Returns:

EChange

addAll

@SafeVarargs
public final @NonNull EChange addAll(@NonNull CALLBACKTYPE... aCallbacks)

Add an array of elements to this collection.

Parameters:

aCallbacks - The elements to be added. May be null.

Returns:

EChange

removeObject

public @NonNull EChange removeObject(@Nullable CALLBACKTYPE aCallback)

Remove the specified callback

Parameters:

aCallback - May be null.

Returns:

EChange

removeAll

public @NonNull EChange removeAll()

Remove all callbacks

Returns:

EChange

getAllCallbacks

@ReturnsMutableCopy
public @NonNull List<CALLBACKTYPE> getAllCallbacks()

Specified by:

getAllCallbacks in interface ICallbackList<CALLBACKTYPE extends ICallback>

Returns:

A mutable copy of all registered callbacks. Never null.

getCallbackAtIndex

public @Nullable CALLBACKTYPE getCallbackAtIndex(@Nonnegative
 int nIndex)

Get the callback at the specified index.

Specified by:

getCallbackAtIndex in interface ICallbackList<CALLBACKTYPE extends ICallback>

Parameters:

nIndex - The index to retrieve. Must be ≥ 0.

Returns:

null if the index is out of bounds.

size

@Nonnegative
public int size()

Specified by:

size in interface IHasSize

Returns:

The number of registered callbacks. Always ≥ 0.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IHasSize

Returns:

true if no callbacks are registered, false otherwise.

See Also:

• IHasSize.size()
• IHasSize.isNotEmpty()

getClone

public @NonNull CallbackList<CALLBACKTYPE> getClone()

Specified by:

getClone in interface ICloneable<CALLBACKTYPE extends ICallback>

Returns:

A clone of this callback list. Never null.

iterator

public @NonNull Iterator<CALLBACKTYPE> iterator()

Specified by:

iterator in interface Iterable<CALLBACKTYPE extends ICallback>

forEach

public void forEach(@NonNull Consumer<? super CALLBACKTYPE> aConsumer)

Specified by:

forEach in interface Iterable<CALLBACKTYPE extends ICallback>

forEachBreakable

public @NonNull EContinue forEachBreakable(@NonNull Function<? super CALLBACKTYPE,EContinue> aFunction)

Iterate all callbacks and invoke the provided function. Iteration can be stopped by returning EContinue.BREAK.

Parameters:

aFunction - The function to be invoked on each callback. May not be null.

Returns:

EContinue.BREAK if iteration was stopped, EContinue.CONTINUE otherwise.

toString

public String toString()

Overrides:

toString in class Object