org.arl.fjage

Class FSMBehavior.State

java.lang.Object

org.arl.fjage.FSMBehavior.State

Direct Known Subclasses:

FSMBuilder.FSMState

Enclosing class:

FSMBehavior

public static class FSMBehavior.State
extends java.lang.Object

FSM state behavior.

Field Summary

Fields

Modifier and Type	Field and Description
FSMBehavior	fsm Parent FSM.
java.util.logging.Logger	log Logger for the behavior to log messages to.

Constructor Summary

Constructors

Constructor and Description
State(java.lang.Object name) Creates a named state.
State(java.lang.Object name, java.lang.Runnable runnable) Creates a named state.

Method Summary

Modifier and Type	Method and Description
void	action() This method is repeatedly called when the state is active.
void	block() Blocks the behavior.
void	block(long millis) Blocks the behavior.
Agent	getAgent() Gets the agent that owns the FSM.
java.lang.Object	getCurrentState() Gets the current state name of the FSM.
java.lang.Object	getName() Gets the name of the FSM state.
boolean	isBlocked() Checks if the behavior is blocked.
void	onEnter() This method is called when the state is entered.
void	onEvent(java.lang.Object event, java.lang.Object eventInfo) This method is called when an event is triggered.
void	onExit() This method is called when the state is exited.
void	reenterState() Requests re-entry of the current state in the FSM.
void	restart() Restarts the behavior.
void	setNextState(java.lang.Object name) Changes the FSM state to the specified state.
void	terminate() Terminates the FSM.
java.lang.String	toString() Returns a string representation of the state.
void	trigger(java.lang.Object event) Triggers an event on the FSM.
void	trigger(java.lang.Object event, java.lang.Object eventInfo) Triggers an event on the FSM.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

fsm

public FSMBehavior fsm

Parent FSM.

log

public java.util.logging.Logger log

Logger for the behavior to log messages to. This logger defaults to the same logger as the owning agent's logger.

Constructor Detail

State

public State(java.lang.Object name)

Creates a named state. The name may later be reassigned when the state is added to the FSM.

Parameters:

name - name of the state.

State

public State(java.lang.Object name,
             java.lang.Runnable runnable)

Creates a named state. The name may later be reassigned when the state is added to the FSM.

Parameters:

name - name of the state.

runnable - Runnable to run.

Method Detail

action

public void action()

This method is repeatedly called when the state is active. The default implementation simply blocks the behavior unless a runnable was provided during instantiation.

onEnter

public void onEnter()

This method is called when the state is entered.

onExit

public void onExit()

This method is called when the state is exited.

onEvent

public void onEvent(java.lang.Object event,
                    java.lang.Object eventInfo)

This method is called when an event is triggered.

Parameters:

event - an object naming the event.

eventInfo - an object providing extra information on the event.

getName

public java.lang.Object getName()

Gets the name of the FSM state.

Returns:

name of the state.

toString

public java.lang.String toString()

Returns a string representation of the state.

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

setNextState

public void setNextState(java.lang.Object name)

Changes the FSM state to the specified state.

Parameters:

name - name of the state to change to.

terminate

public void terminate()

Terminates the FSM.

block

public void block()

Blocks the behavior.

See Also:

Behavior.block()

block

public void block(long millis)

Blocks the behavior.

See Also:

Behavior.block(long)

restart

public void restart()

Restarts the behavior.

See Also:

Behavior.restart()

isBlocked

public boolean isBlocked()

Checks if the behavior is blocked.

See Also:

Behavior.isBlocked()

reenterState

public void reenterState()

Requests re-entry of the current state in the FSM.

See Also:

FSMBehavior.reenterState()

getCurrentState

public java.lang.Object getCurrentState()

Gets the current state name of the FSM.

Returns:

current state name, or null if the state is not part of a FSM.

trigger

public void trigger(java.lang.Object event)

Triggers an event on the FSM.

Parameters:

event - an object naming the event.

See Also:

FSMBehavior.trigger(Object)

trigger

public void trigger(java.lang.Object event,
                    java.lang.Object eventInfo)

Triggers an event on the FSM.

Parameters:

event - an object naming the event.

eventInfo - an object providing extra information on the event.

See Also:

FSMBehavior.trigger(Object, Object)

getAgent

public Agent getAgent()

Gets the agent that owns the FSM.

Returns:

owning agent, or null if the state is not part of a running FSM.