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>, ICloneable<CallbackList<CALLBACKTYPE>>, Serializable

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

This class manages a list of callbacks.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CallbackList()
CallbackList(CallbackList<CALLBACKTYPE> aOther)

Method Summary

Modifier and Type	Method and Description
CallbackList<CALLBACKTYPE>	addCallback(CALLBACKTYPE aCallback) Add a callback.
void	forEach(Consumer<CALLBACKTYPE> aConsumer) Invoke all registered callbacks in a safe manner.
EContinue	forEachWithReturn(Function<CALLBACKTYPE,EContinue> aFunction) Invoke all registered callbacks in a safe manner.
ICommonsList<CALLBACKTYPE>	getAllCallbacks()
CALLBACKTYPE	getCallbackAtIndex(int nIndex) Get the callback at the specified index.
int	getCallbackCount()
CallbackList<CALLBACKTYPE>	getClone()
boolean	hasCallbacks()
EChange	removeAllCallbacks() Remove all callbacks
EChange	removeCallback(CALLBACKTYPE aCallback) Remove the specified callback
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CallbackList

public CallbackList()

CallbackList

public CallbackList(@Nonnull
                    CallbackList<CALLBACKTYPE> aOther)

Method Detail

addCallback

@Nonnull
public CallbackList<CALLBACKTYPE> addCallback(@Nonnull
                                                        CALLBACKTYPE aCallback)

Add a callback.

Parameters:

aCallback - May not be null.

Returns:

this

removeCallback

@Nonnull
public EChange removeCallback(@Nullable
                                        CALLBACKTYPE aCallback)

Remove the specified callback

Parameters:

aCallback - May be null.

Returns:

EChange

removeAllCallbacks

@Nonnull
public EChange removeAllCallbacks()

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.

getCallbackCount

@Nonnegative
public int getCallbackCount()

Specified by:

getCallbackCount in interface ICallbackList<CALLBACKTYPE extends ICallback>

Returns:

The number of contained callbacks. Always ≥ 0.

hasCallbacks

public boolean hasCallbacks()

Specified by:

hasCallbacks in interface ICallbackList<CALLBACKTYPE extends ICallback>

Returns:

true if at least a single callback is present, false otherwise.

getClone

@Nonnull
public CallbackList<CALLBACKTYPE> getClone()

Specified by:

getClone in interface ICloneable<CallbackList<CALLBACKTYPE extends ICallback>>

Returns:

A 100% deep-copy of the implementing class.

forEach

public void forEach(@Nonnull
                    Consumer<CALLBACKTYPE> aConsumer)

Description copied from interface: ICallbackList

Invoke all registered callbacks in a safe manner.

Specified by:

forEach in interface ICallbackList<CALLBACKTYPE extends ICallback>

Parameters:

aConsumer - The action to be performed with the respective callback. This method cannot return a value. May not be null.

forEachWithReturn

@Nonnull
public EContinue forEachWithReturn(@Nonnull
                                             Function<CALLBACKTYPE,EContinue> aFunction)

Description copied from interface: ICallbackList

Invoke all registered callbacks in a safe manner.

Specified by:

forEachWithReturn in interface ICallbackList<CALLBACKTYPE extends ICallback>

Parameters:

aFunction - The action to be performed with the respective callback. The first callback that returns EContinue.BREAK stops the process. May not be null.

Returns:

EContinue.CONTINUE if all callbacks returned EContinue.CONTINUE, EContinue.BREAK if at least one invocation returned EContinue.BREAK.

toString

public String toString()

Overrides:

toString in class Object