oracle.ide.panels
Class FSMStateInfo

java.lang.Object
  oracle.ide.panels.FSMStateInfo

public class FSMStateInfo

extends java.lang.Object

This class is a wrapper for Traversable instances and is the return type for the FSM methods that trigger a transition to a different FSM state.

All this class does is associate runtime information with the Traversable object that is part of the state machine's operational specification. This runtime information can be produced dynamically by the FSM and needs to be immutable (so that hashCode() and equals() can be implemented properly); those are the reasons that a separate FSMStateInfo object is returned. Developers writing a Traversable therefore do not need to be concerned with how the runtime FSM information is associated with the Traversable.

Method Summary

boolean	equals(java.lang.Object o)
protected boolean	equalsImpl(FSMStateInfo info) This implementation of equalsImpl(...) requires that the state name and index are identical in order for the FSMStateInfo objects to be equal.
java.lang.Object	getStateID() The name of the state in the FSM associated with this FSMStateInfo.
int	getStateIndex() Returns the index of the state within the FSM that the state came from.
Step	getStep() Returns the Step object for this FSMStateInfo.
Traversable	getTraversable(CommitNotifier commitNotifier) Returns the Traversable instance that is associated with this FSMStateInfo.
int	hashCode()
boolean	isFinalState() Returns true if this FSMStateInfo corresponds to a final state in the FSM.

Methods inherited from class java.lang.Object

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

Method Detail

getStateID

public java.lang.Object getStateID()

The name of the state in the FSM associated with this FSMStateInfo.

getStateIndex

public int getStateIndex()

Returns the index of the state within the FSM that the state came from.

isFinalState

public boolean isFinalState()

Returns true if this FSMStateInfo corresponds to a final state in the FSM.

getStep

public Step getStep()

Returns the Step object for this FSMStateInfo.

getTraversable

public Traversable getTraversable(CommitNotifier commitNotifier)

Returns the Traversable instance that is associated with this FSMStateInfo. This will trigger the creation of a new Traversable if this FSMStateInfo has not previously created a Traversable. Once a Traversable is created, the getTraversable method will always return the same Traversable instance.

hashCode

public int hashCode()

equals

public boolean equals(java.lang.Object o)

equalsImpl

protected final boolean equalsImpl(FSMStateInfo info)

This implementation of equalsImpl(...) requires that the state name and index are identical in order for the FSMStateInfo objects to be equal. The wrapped Traversable object is not compared, and this is intentional.