net.openai.ai.hybrid.fsmagent
Class InputForwardingState

java.lang.Object
  |
  +--net.openai.util.fsm.State
        |
        +--net.openai.ai.hybrid.fsmagent.AgentState
              |
              +--net.openai.ai.hybrid.fsmagent.InputForwardingState

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

MigrateState, SleepState

public abstract class InputForwardingState

extends AgentState

An AgentState that will forward its input from the enter() method to the output of its exit() method.

See Also:

Serialized Form

Constructor Summary

InputForwardingState()

Method Summary

void	enter(java.lang.Object input) Called by the FSMAgent's Finite State Machine when the InputFowardingState is entered.
java.lang.Object	exit() Called by the FSMAgent's Finite State Machine when the InputForwardingState is finished.
protected java.lang.Object	getInputData() Returns the internal input data that was input into the enter state.

Methods inherited from class net.openai.ai.hybrid.fsmagent.AgentState

displayMessage, executeState, 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

InputForwardingState

public InputForwardingState()

Method Detail

enter

public void enter(java.lang.Object input)

Called by the FSMAgent's Finite State Machine when the InputFowardingState is entered.

Specified by:

enter in class State

Parameters:

input - Any output from the previous state. This same object will be returned by the exit() method.

exit

public java.lang.Object exit()

Called by the FSMAgent's Finite State Machine when the InputForwardingState is finished. The object returned is the same as the object given to the enter() method.

Specified by:

exit in class State

Returns:

The forwarded object from the enter() method.

getInputData

protected java.lang.Object getInputData()

Returns the internal input data that was input into the enter state.