net.sf.cuf.state

Class SimpleState

java.lang.Object

net.sf.cuf.state.AbstractState

net.sf.cuf.state.SimpleState

All Implemented Interfaces:

MutableState, State

Direct Known Subclasses:

ValueState

public class SimpleState
extends AbstractState
implements MutableState

This class implements a MutableState and holds the necessary state information inside the SimpleState object.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	mInSetEnabled Marker if we are in setEnabled().

Fields inherited from class net.sf.cuf.state.AbstractState

mIsEnabled, mIsInitialized, mListenerList, mName, mReason

Constructor Summary

Constructors

Constructor and Description
SimpleState() The default constructor creates an uninitialized state, which is not enabled.
SimpleState(boolean pIsEnabled) Creates an initialized state.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	inSetEnabled() Marker method that indicates if the object is just firing a state change due to a call of setEnabled().
void	reset() Resets a MutableState to not initilized.
void	setEnabled(boolean pEnabled) Sets the state.
void	setEnabled(boolean pEnabled, Object pReason) Sets the state with a reason object.

Methods inherited from class net.sf.cuf.state.AbstractState

addChangeListener, checkDisposed, dispose, fireStateChanged, getChangeReason, getDependents, getName, isDisposed, isEnabled, isInitialized, removeChangeListener, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.cuf.state.State

addChangeListener, dispose, getChangeReason, getDependents, getName, isDisposed, isEnabled, isInitialized, removeChangeListener, setName

Field Detail

mInSetEnabled

protected boolean mInSetEnabled

Marker if we are in setEnabled().

Constructor Detail

SimpleState

public SimpleState()

The default constructor creates an uninitialized state, which is not enabled. The state gets initialized as soon as setEnabled() is called.

SimpleState

public SimpleState(boolean pIsEnabled)

Creates an initialized state.

Parameters:

pIsEnabled - true if our state should be enabled

Method Detail

setEnabled

public void setEnabled(boolean pEnabled)

Sets the state.

Specified by:

setEnabled in interface MutableState

Parameters:

pEnabled - true if the state gets enabled

setEnabled

public void setEnabled(boolean pEnabled,
              Object pReason)

Sets the state with a reason object. The reason object may be null, and is returned to a getChangeReason() call during the callback. Only if the state change our listeners are notified.

Specified by:

setEnabled in interface MutableState

Parameters:

pEnabled - true if the state gets enabled

pReason - null or reason for the change

inSetEnabled

protected boolean inSetEnabled()

Marker method that indicates if the object is just firing a state change due to a call of setEnabled(). This is useful for objects that are listeners to the State and are not interested in state changes triggered by themselfs calling setEnabled().

Returns:

true if we during a state change due to setEnabled(), false otherwise.

reset

public void reset()

Resets a MutableState to not initilized. Calling this method will not trigger a notification of the listeners.

Specified by:

reset in interface MutableState