com.sun.grizzly.utils
Class StateHolder<E>

java.lang.Object
  com.sun.grizzly.utils.StateHolder<E>

public class StateHolder<E>
extends Object

Class, which holds the state. Provides API for state change notification, state read/write access locking.

Author:

Alexey Stashok

Constructor Summary

StateHolder()
Constructs StateHolder.

StateHolder(boolean isLockEnabled)
Constructs StateHolder.

StateHolder(boolean isLockEnabled, E initialState)
Constructs StateHolder.

Method Summary

void	addConditionListener(ConditionListener<E,?> conditionListener) Add new ConditionListener to listen this StateHolder's state changes.
E	getState() Gets current state Current StateHolder locking mode will be used
E	getState(boolean locked) Gets current state
ReentrantReadWriteLock	getStateLocker() Gets Read/Write locker, which is used by this StateHolder
boolean	isLockEnabled() Gets current locking mode
protected void	notifyConditionListeners(E state)
ConditionListener	notifyWhenConditionMatchState(Condition<E> condition, Object notificationObject) Register listener, which will be notified, when state will match the condition.
ConditionListener<E,Object>	notifyWhenStateIsEqual(E state, Object notificationObject) Register listener, which will be notified, when state will be equal to passed one.
ConditionListener<E,Object>	notifyWhenStateIsNotEqual(E state, Object notificationObject) Register listener, which will be notified, when state will become not equal to passed one.
void	removeConditionListener(ConditionListener<E,?> conditionListener)
void	setState(E state) Sets current state Current StateHolder locking mode will be used
void	setState(E state, boolean locked) Sets current state

Methods inherited from class java.lang.Object

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

Constructor Detail

StateHolder

public StateHolder()

Constructs StateHolder. StateHolder will work in not-locking mode.

StateHolder

public StateHolder(boolean isLockEnabled)

Constructs StateHolder.

Parameters:

isLockEnabled - locking mode

StateHolder

public StateHolder(boolean isLockEnabled,
                   E initialState)

Constructs StateHolder.

Parameters:

isLockEnabled - locking mode

Method Detail

getState

public E getState()

Gets current state Current StateHolder locking mode will be used

Returns:

state

getState

public E getState(boolean locked)

Gets current state

Parameters:

locked - if true, get will be invoked in locking mode, false - non-locked

Returns:

state

setState

public void setState(E state)

Sets current state Current StateHolder locking mode will be used

Parameters:

state -

setState

public void setState(E state,
                     boolean locked)

Sets current state

Parameters:

state -

locked - if true, set will be invoked in locking mode, false - non-locking

getStateLocker

public ReentrantReadWriteLock getStateLocker()

Gets Read/Write locker, which is used by this StateHolder

Returns:

locker

isLockEnabled

public boolean isLockEnabled()

Gets current locking mode

Returns:

true, if mode is set to locking, false otherwise

notifyWhenStateIsEqual

public ConditionListener<E,Object> notifyWhenStateIsEqual(E state,
                                                          Object notificationObject)

Register listener, which will be notified, when state will be equal to passed one. Once listener will be notified - it will be removed from this StateHolder's listener set.

Parameters:

state - State, listener is interested in

notificationObject - Object, which will be notified. This StateHolder implementation works with Runnable, Callable, CountDownLatch, Object listeners

Returns:

ConditionListener, if current state is not equal to required and listener was registered, null if current state is equal to required. In both cases listener will be notified

notifyWhenStateIsNotEqual

public ConditionListener<E,Object> notifyWhenStateIsNotEqual(E state,
                                                             Object notificationObject)

Register listener, which will be notified, when state will become not equal to passed one. Once listener will be notified - it will be removed from this StateHolder's listener set.

Parameters:

state - State, listener is interested in

notificationObject - Object, which will be notified. This StateHolder implementation works with Runnable, Callable, CountDownLatch, Object listeners

Returns:

ConditionListener, if current state is equal to required and listener was registered, null if current state is not equal to required. In both cases listener will be notified

notifyWhenConditionMatchState

public ConditionListener notifyWhenConditionMatchState(Condition<E> condition,
                                                       Object notificationObject)

Register listener, which will be notified, when state will match the condition. Once listener will be notified - it will be removed from this StateHolder's listener set.

Parameters:

condition - Condition, the listener is interested in

notificationObject - Object, which will be notified. This StateHolder implementation works with Runnable, Callable, CountDownLatch, Object listeners

Returns:

ConditionListener, if current state doesn't match the condition and listener was registered, null if current state matches the condition. In both cases listener will be notified

addConditionListener

public void addConditionListener(ConditionListener<E,?> conditionListener)

Add new ConditionListener to listen this StateHolder's state changes.

Parameters:

conditionListener -

removeConditionListener

public void removeConditionListener(ConditionListener<E,?> conditionListener)

notifyConditionListeners

protected void notifyConditionListeners(E state)