fr.lri.swingstates.debug

Class StateMachineEvent

java.lang.Object

java.util.EventObject

fr.lri.swingstates.debug.StateMachineEvent

All Implemented Interfaces:

java.io.Serializable

public class StateMachineEvent
extends java.util.EventObject

An event which indicates that an action occurred in a state machine. This event is used both for the following state machine events:

• the state machine is reset,
• the state machine is resumed,
• the state machine is suspended,
• the state machine fires a transition changing the current state,
• the state machine fires a transition making it loop on the current state.

A StateMachineEvent object is fired to every StateMachineEventListener or StateMachineEventAdapter object which is registered to receive the "interesting" mouse events using the state machine's addSMListener method. (StateMachineEventAdapter objects implement the StateMachineEventListener interface.) Each such listener object gets a StateMachineEvent containing the state machine event.

The current state of this state machine can be retrieved using StateMachineEvent.getCurrentState().

The getPreviousState() and getTransition() retrieve the previous state and the transition.

Author:

Caroline Appert

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StateMachineEvent(StateMachine stateMachine) Builds a StateMachineEvent originated by a state machine that has just been inited.
StateMachineEvent(StateMachine stateMachine, Transition t, State cState) Builds a StateMachineEvent originated by a state machine that has just fired a transition that makes it loop on the current state.
StateMachineEvent(StateMachine stateMachine, Transition t, State pState, State cState) Builds a StateMachineEvent.

Method Summary

Methods

Modifier and Type	Method and Description
State	getCurrentState() Returns the current state of the state machine that originated this StateMachineEvent.
State	getPreviousState() Returns the previous state of the state machine that originated this StateMachineEvent.
StateMachine	getSmSource() Returns the state machine that originated this event.
Transition	getTransition() Returns the transition that has just been fired by this state machine.
java.lang.String	toString()

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StateMachineEvent

public StateMachineEvent(StateMachine stateMachine,
                 Transition t,
                 State pState,
                 State cState)

Builds a StateMachineEvent.

Parameters:

stateMachine - The state machine that originated this event.

t - The transition of the state machine that has just been fired.

pState - The state of the state machine before t has been fired.

cState - The current state of the state machine.

StateMachineEvent

public StateMachineEvent(StateMachine stateMachine,
                 Transition t,
                 State cState)

Builds a StateMachineEvent originated by a state machine that has just fired a transition that makes it loop on the current state. The previousState field is equal to the currentState field.

Parameters:

stateMachine - The state machine that originated this event.

t - The transition of the state machine that has just been fired.

cState - The current state of the state machine.

StateMachineEvent

public StateMachineEvent(StateMachine stateMachine)

Builds a StateMachineEvent originated by a state machine that has just been inited.

Parameters:

stateMachine - The state machine that originated this event.

Method Detail

getCurrentState

public State getCurrentState()

Returns the current state of the state machine that originated this StateMachineEvent.

Returns:

the current state of the state machine that originated this StateMachineEvent.

getPreviousState

public State getPreviousState()

Returns the previous state of the state machine that originated this StateMachineEvent.

Returns:

the previous state of the state machine that originated this StateMachineEvent. null when this StateMachineEvent has been originated by a state machine when it has been attached to a SMControlAttachable object, detached from a SMControlAttachable object, resumed, reset or suspended.

getTransition

public Transition getTransition()

Returns the transition that has just been fired by this state machine.

Returns:

the transition that has just been fired by this state machine. The state machine originated this event because this transition has been fired. null when this StateMachineEvent has been originated by a state machine when it has been attached to a canvas, detached from a canvas, resumed, reset or suspended.

getSmSource

public StateMachine getSmSource()

Returns the state machine that originated this event.

Returns:

the state machine that originated this event.

toString

public java.lang.String toString()

Overrides:

toString in class java.util.EventObject