se.ericsson.eto.norarc.javaframe
Class State

java.lang.Object
  extended byse.ericsson.eto.norarc.javaframe.State
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
CompositeState

public class State
extends java.lang.Object
implements java.io.Serializable

The class for the singular States of the StateMachines.

See Also:
Serialized Form

Field Summary
 CompositeState enclosingState
           
 java.lang.String stateName
           
 
Constructor Summary
State()
          State constructor with default name.
State(java.lang.String sn)
          State constructor with user supplied name.
 
Method Summary
 void enterState(StateMachine curfsm)
          Changes the current State of the StateMachine to this singular State.
protected  void entry(StateMachine curfsm)
          Will be executed every time this State is entered.
protected  void exit(StateMachine curfsm)
          Will be executed every time this State is exited.
 void output(Message sig, Mediator receiver, StateMachine curfsm)
          outputs a Message to a given (local) Mediator.
 java.lang.String stateName()
          The name of the this State.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

enclosingState

public CompositeState enclosingState

stateName

public java.lang.String stateName
Constructor Detail

State

public State(java.lang.String sn)
State constructor with user supplied name.

Parameters:
sn - The name of this State.

State

public State()
State constructor with default name.

Method Detail

stateName

public final java.lang.String stateName()
The name of the this State.

Returns:
The symbolic name this State.

output

public final void output(Message sig,
                         Mediator receiver,
                         StateMachine curfsm)
outputs a Message to a given (local) Mediator. The method is to be used within the method enterState(), execTrans(), or outofInnerCompositeState().

Parameters:
sig - The Message to be sent.
receiver - The Mediator that will receive (and forward) the Message.
curfsm - The StateMachine that is conceptually performing this operation.

entry

protected void entry(StateMachine curfsm)
Will be executed every time this State is entered. Default is empty. Note: not to be called from user code.


exit

protected void exit(StateMachine curfsm)
Will be executed every time this State is exited. Default is empty. Note: not to be called from user code.


enterState

public void enterState(StateMachine curfsm)
Changes the current State of the StateMachine to this singular State. Note: a singular State do not have an entry index. Note: enterState should not be redefined for a singular State.

Parameters:
curfsm - The StateMachine that gets the new singular State.