net.openai.ai.hybrid.fsmagent
Class HaltState

java.lang.Object
  |
  +--net.openai.util.fsm.State
        |
        +--net.openai.ai.hybrid.fsmagent.AgentState
              |
              +--net.openai.ai.hybrid.fsmagent.HaltState
All Implemented Interfaces:
java.io.Serializable

public class HaltState
extends AgentState

This AgentState halts the execution of the Agent.

See Also:
Serialized Form

Constructor Summary
HaltState()
          Constructs a new HaltState.
 
Method Summary
 void enter(java.lang.Object input)
          Called by the FSMAgent's Finite State Machine when the HaltState is entered.
protected  java.lang.Object executeState()
          The main body of execution for the HaltState.
 java.lang.Object exit()
          Overridden and finalized because there is no need to implement this method.
 
Methods inherited from class net.openai.ai.hybrid.fsmagent.AgentState
displayMessage, getAgent
 
Methods inherited from class net.openai.util.fsm.State
addStateListener, addTransition, addTransition, getEndStateFlag, getName, getStartStateFlag, getTransitions, removeStateListener, removeTransition, setEndStateFlag, setName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HaltState

public HaltState()
Constructs a new HaltState.

Method Detail

enter

public void enter(java.lang.Object input)
Called by the FSMAgent's Finite State Machine when the HaltState is entered. Override this method to capture the input for the HaltState.

Specified by:
enter in class State
Parameters:
input - Any input from the previous state.

exit

public final java.lang.Object exit()
Overridden and finalized because there is no need to implement this method. This method will never be called by the FSMAgent because The agent will have halted before it reaches this point.

Specified by:
exit in class State
Returns:
Always null.

executeState

protected final java.lang.Object executeState()
                                       throws java.lang.Exception
The main body of execution for the HaltState. This simply causes the agent to halt.

Specified by:
executeState in class AgentState
Returns:
Always null. This call will never return, so there is no need to actually return anything.
java.lang.Exception


Copyright - 2001 OpenAI Labs. All Rights Reserved.