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:

ICloneable<CallbackList<CALLBACKTYPE>>

public class CallbackList<CALLBACKTYPE extends ICallback>
extends Object
implements ICloneable<CallbackList<CALLBACKTYPE>>

This class manages a list of callbacks.

Author:

Philip Helger

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CallbackList<CALLBACKTYPE>	addCallback(CALLBACKTYPE aCallback) Add a callback.
List<CALLBACKTYPE>	getAllCallbacks()
CALLBACKTYPE	getCallbackAtIndex(int nIndex)
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 List<CALLBACKTYPE> getAllCallbacks()

Returns:

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

getCallbackAtIndex

@Nullable
public CALLBACKTYPE getCallbackAtIndex(@Nonnegative
                                       int nIndex)

getCallbackCount

@Nonnegative
public int getCallbackCount()

hasCallbacks

public boolean hasCallbacks()

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.

toString

public String toString()

Overrides:

toString in class Object