net.openai.util.fsm.event
Class StateEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--net.openai.util.fsm.event.StateEvent

All Implemented Interfaces:

java.io.Serializable

public final class StateEvent

extends java.util.EventObject

implements java.io.Serializable

The Event object that will be the interface between the States and their listeners.

See Also:

Serialized Form

Field Summary

static int	END_FLAG_CHANGE This type of StateEvent indicates a toggling of the end state flag on the state.
static int	ENTER_END This type of StateEvent indicates a state is done being entered.
static int	ENTER_START This type of StateEvent indicates a state is about to be entered.
static int	EXIT_END This type of StateEvent indicates a state is done exiting.
static int	EXIT_START This type of StateEvent indicates a state is about to be exited.
static int	START_FLAG_CHANGE This type of StateEvent indicates a toggling of the start state flag on the state.

Fields inherited from class java.util.EventObject

source

Constructor Summary

StateEvent(State source, int type)
Constructs a StateEvent object.

Method Summary

int	getType() Returns the type of this StateEvent.
java.lang.String	toString() Returns a string representation of this event.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

ENTER_START

public static final int ENTER_START

This type of StateEvent indicates a state is about to be entered.

ENTER_END

public static final int ENTER_END

This type of StateEvent indicates a state is done being entered.

EXIT_START

public static final int EXIT_START

This type of StateEvent indicates a state is about to be exited.

EXIT_END

public static final int EXIT_END

This type of StateEvent indicates a state is done exiting.

START_FLAG_CHANGE

public static final int START_FLAG_CHANGE

This type of StateEvent indicates a toggling of the start state flag on the state.

END_FLAG_CHANGE

public static final int END_FLAG_CHANGE

This type of StateEvent indicates a toggling of the end state flag on the state.

Constructor Detail

StateEvent

public StateEvent(State source,
                  int type)

Constructs a StateEvent object.

Method Detail

getType

public final int getType()

Returns the type of this StateEvent.

Returns:

The type of this StateEvent.

toString

public final java.lang.String toString()

Returns a string representation of this event.

Overrides:

toString in class java.util.EventObject

Returns:

A simple string representation of this event.