Package com.helger.commons.callback

Class CallbackList<CALLBACKTYPE extends ICallback>

java.lang.Object

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

Type Parameters:

CALLBACKTYPE - The callback type.

All Implemented Interfaces:

ICallbackList<CALLBACKTYPE>, ICommonsIterable<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()
CallbackList(CallbackList<CALLBACKTYPE> aOther)

Method Summary

Modifier and Type	Method	Description
EChange	add(CALLBACKTYPE aCallback)	Add a callback.
EChange	addAll(CALLBACKTYPE... aCallbacks)	Add an array of elements to this collection.
void	forEach(Consumer<? super CALLBACKTYPE> aConsumer)
EContinue	forEachBreakable(Function<? super CALLBACKTYPE,EContinue> aFunction)	A special version of Iterable.forEach(Consumer) that can break iteration if a certain requirement is fulfilled.
ICommonsList<CALLBACKTYPE>	getAllCallbacks()
CALLBACKTYPE	getCallbackAtIndex(int nIndex)	Get the callback at the specified index.
CallbackList<CALLBACKTYPE>	getClone()
boolean	isEmpty()
Iterator<CALLBACKTYPE>	iterator()
EChange	removeAll()	Remove all callbacks
EChange	removeObject(CALLBACKTYPE aCallback)	Remove the specified callback
EChange	set(CALLBACKTYPE aCallback)	Clear all elements and add only the passed value.
EChange	set(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.commons.collection.impl.ICommonsIterable

containsAny, containsNone, containsOnly, findAll, findAllInstanceOf, findAllMapped, findAllMapped, findAllMapped, findFirst, findFirst, findFirstIndex, findFirstMapped, findFirstMapped, findLastIndex, forEachByIndex, forEachThrowing, getCount, getCount

Methods inherited from interface com.helger.commons.lang.IHasSize

isNotEmpty

Methods inherited from interface java.lang.Iterable

spliterator

Constructor Detail

CallbackList

public CallbackList()

CallbackList

public CallbackList(@Nullable
                    CallbackList<CALLBACKTYPE> aOther)

Method Detail

set

@Nonnull
public 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

@Nonnull
public 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

@Nonnull
public EChange add(@Nonnull
                   CALLBACKTYPE aCallback)

Add a callback.

Parameters:

aCallback - May not be null.

Returns:

EChange

addAll

@Nonnull
@SafeVarargs
public final 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

@Nonnull
public EChange removeObject(@Nullable
                            CALLBACKTYPE aCallback)

Remove the specified callback

Parameters:

aCallback - May be null.

Returns:

EChange

removeAll

@Nonnull
public EChange removeAll()

Remove all callbacks

Returns:

EChange

getAllCallbacks

@Nonnull
@ReturnsMutableCopy
public ICommonsList<CALLBACKTYPE> getAllCallbacks()

Specified by:

getAllCallbacks in interface ICallbackList<CALLBACKTYPE extends ICallback>

Returns:

A list of all callbacks. Never null and only containing non-null elements.

getCallbackAtIndex

@Nullable
public CALLBACKTYPE getCallbackAtIndex(@Nonnegative
                                       int nIndex)

Description copied from interface: ICallbackList

Get the callback at the specified index.

Specified by:

getCallbackAtIndex in interface ICallbackList<CALLBACKTYPE extends ICallback>

Parameters:

nIndex - The index to be retrieved. Should be ≥ 0.

Returns:

null if the provided index is invalid.

size

@Nonnegative
public int size()

Specified by:

size in interface IHasSize

Returns:

The number of contained elements. Always ≥ 0.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IHasSize

Returns:

true if no items are present, false if at least a single item is present.

See Also:

IHasSize.size(), IHasSize.isNotEmpty()

getClone

@Nonnull
public CallbackList<CALLBACKTYPE> getClone()

Specified by:

getClone in interface ICloneable<CALLBACKTYPE extends ICallback>

Returns:

A 100% deep-copy of the implementing class.

iterator

@Nonnull
public 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

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

Description copied from interface: ICommonsIterable

A special version of Iterable.forEach(Consumer) that can break iteration if a certain requirement is fulfilled.

Specified by:

forEachBreakable in interface ICommonsIterable<CALLBACKTYPE extends ICallback>

Parameters:

aFunction - The consumer to be invoked. May not be null.

Returns:

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

toString

public String toString()

Overrides:

toString in class Object