IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.automaton
Interface State

All Superinterfaces:
Handler
All Known Implementing Classes:
DSEState

public interface State
extends Handler

This interface define a State in the automaton.


Method Summary
 void abort()
          This method is invoked to abort the State.
 void activate()
          This method is invoked to activiate this State.
 Vector getEntryActions()
          Return a vector containing the entryActions in this State
 java.lang.String getName()
          Get the name of the State.
 Processor getProcessor()
          Return the Processor who owns this state.
 Hashtable getTransitions()
          Return a hashtable containing the transitions in this State
 java.lang.String getType()
          Returns the value of the State's type property.
 java.lang.String getTypeIdInfo()
          Returns the value of the State's typeIdInfo property.
 java.lang.Object initializeFrom(Tag aTag)
          Abstract method to be implemented by concrete instantiations that will initialize the State from a Tag.
 void resume()
          This method is invoked to resume a suspended State.
 void setEntryActions(Vector entryActions)
          Associate the state with a vector of entryActions.
 void setIgnoreEntryActions(boolean newIgnoreEntryActions)
          Sets the value of the ignoreEntryActions flag.
 void setName(java.lang.String aName)
          Set the name of the State.
 void setProcessor(Processor aProcessor)
          Set the processor who owns this state.
 void setTransitions(Hashtable transitions)
          Associate the state with a hashtable of transitions.
 void setType(java.lang.String newType)
          Sets the value of the type property.
 void setTypeIdInfo(java.lang.String newTypeIdInfo)
          Sets the value of the typeIdInfo property.
 void suspend()
          This method is invoked to suspend this State.
 void terminate()
          Provides housekeeping for the State object as a notifier instance.
 
Methods inherited from interface com.ibm.dse.base.Handler
dispatchEvent, handleEvent, handleEvent, stopHandlingEvent, stopHandlingEvent
 

Method Detail

abort

public void abort()
           throws DSEProcessorException
This method is invoked to abort the State.

Throws:
DSEProcessorException

activate

public void activate()
              throws DSEInvalidArgumentException,
                     DSEProcessorException
This method is invoked to activiate this State.

Throws:
DSEInvalidArgumentException
DSEProcessorException

getEntryActions

public Vector getEntryActions()
Return a vector containing the entryActions in this State

Returns:
com.ibm.dse.base.Vector

getName

public java.lang.String getName()
Get the name of the State.

Returns:
java.lang.String

getProcessor

public Processor getProcessor()
Return the Processor who owns this state.

Returns:
com.ibm.dse.automaton.Processor

getTransitions

public Hashtable getTransitions()
Return a hashtable containing the transitions in this State

Returns:
com.ibm.dse.base.Hashtable

getType

public java.lang.String getType()
Returns the value of the State's type property.

Returns:
java.lang.String

getTypeIdInfo

public java.lang.String getTypeIdInfo()
Returns the value of the State's typeIdInfo property.

Returns:
java.lang.String

initializeFrom

public java.lang.Object initializeFrom(Tag aTag)
                                throws java.io.IOException,
                                       DSEException
Abstract method to be implemented by concrete instantiations that will initialize the State from a Tag. This method is an Externalizable interface method.

Throws:
java.io.IOException
DSEException

resume

public void resume()
This method is invoked to resume a suspended State.


setEntryActions

public void setEntryActions(Vector entryActions)
Associate the state with a vector of entryActions.

Parameters:
entryActions - com.ibm.dse.base.Vector

setIgnoreEntryActions

public void setIgnoreEntryActions(boolean newIgnoreEntryActions)
Sets the value of the ignoreEntryActions flag.

Parameters:
newIgnoreEntryActions - boolean

setName

public void setName(java.lang.String aName)
Set the name of the State.

Parameters:
aName - java.lang.String

setProcessor

public void setProcessor(Processor aProcessor)
Set the processor who owns this state.

Parameters:
aProcessor - com.ibm.dse.automaton.Processor

setTransitions

public void setTransitions(Hashtable transitions)
Associate the state with a hashtable of transitions.


setType

public void setType(java.lang.String newType)
Sets the value of the type property.

Parameters:
newType - java.lang.String

setTypeIdInfo

public void setTypeIdInfo(java.lang.String newTypeIdInfo)
Sets the value of the typeIdInfo property.

Parameters:
newTypeIdInfo - java.lang.String

suspend

public void suspend()
This method is invoked to suspend this State.


terminate

public void terminate()
Provides housekeeping for the State object as a notifier instance. This is called either from the application or from the context when it is destroyed or unchained. Subclasses should overwrite this implementation to perform the actions required to release the resources acquired by the notifier.


IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005