net.sf.cuf.state

Interface MutableState

All Superinterfaces:

State

All Known Implementing Classes:

SimpleState, ValueState

public interface MutableState
extends State

The MutableState interface describes a mutable (more-or-less) binary state. In addition to a State, a MutableState can be changed via setEnabled() and reset().

Method Summary

Methods

Modifier and Type	Method and Description
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 interface net.sf.cuf.state.State

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

Method Detail

setEnabled

void setEnabled(boolean pEnabled)

Sets the state.

Parameters:

pEnabled - true if the state gets enabled

setEnabled

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.

Parameters:

pEnabled - true if the state gets enabled

pReason - null or reason for the change

reset

void reset()

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