com.helger.commons.callback

Interface ICallbackList<CALLBACKTYPE extends ICallback>

Type Parameters:

CALLBACKTYPE - The callback type.

All Superinterfaces:

Serializable

All Known Implementing Classes:

CallbackList

public interface ICallbackList<CALLBACKTYPE extends ICallback>
extends Serializable

Read-only interface for a list of ICallback objects.
Note: Does not implement Iterable because the returned iterator would either be an Iterator over the list in which case you can use getAllCallbacks() directly or the returned Iterator would not be thread-safe and that is not an option for this type.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
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()
boolean	hasCallbacks()

Method Detail

getAllCallbacks

@Nonnull
 @ReturnsMutableCopy
ICommonsList<CALLBACKTYPE> getAllCallbacks()

Returns:

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

getCallbackAtIndex

@Nullable
CALLBACKTYPE getCallbackAtIndex(@Nonnegative
                                           int nIndex)

Get the callback at the specified index.

Parameters:

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

Returns:

null if the provided index is invalid.

getCallbackCount

@Nonnegative
int getCallbackCount()

Returns:

The number of contained callbacks. Always ≥ 0.

hasCallbacks

boolean hasCallbacks()

Returns:

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

forEach

void forEach(@Nonnull
             Consumer<CALLBACKTYPE> aConsumer)

Invoke all registered callbacks in a safe manner.

Parameters:

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

forEachWithReturn

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

Invoke all registered callbacks in a safe manner.

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.