com.kangirigungi.jstatemachine

Class GuardState<StateId,Event>

java.lang.Object

com.kangirigungi.jstatemachine.GuardState<StateId,Event>

All Implemented Interfaces:

IGuard<StateId,Event>

public class GuardState<StateId,Event>
extends java.lang.Object
implements IGuard<StateId,Event>

Constructor Summary

Constructors

Constructor and Description
GuardState(com.kangirigungi.jstatemachine.IStateMachineEngine<StateId,Event> stateMachine, StateId[] states, boolean deep)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkTransition(IState<StateId,Event> fromState, IState<StateId,Event> toState, Event event) Called when the guard is needed to be executed.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuardState

public GuardState(com.kangirigungi.jstatemachine.IStateMachineEngine<StateId,Event> stateMachine,
          StateId[] states,
          boolean deep)

Method Detail

checkTransition

public boolean checkTransition(IState<StateId,Event> fromState,
                      IState<StateId,Event> toState,
                      Event event)

Description copied from interface: IGuard

Called when the guard is needed to be executed.

Specified by:

checkTransition in interface IGuard<StateId,Event>

Parameters:

fromState - The initial state of the transition. In case of an internal transition, it is the state in which the transition happens.

toState - The final state of the transition. In case of an internal transition, its value is null.

event - The event triggering the transition.

Returns:

The result of the transition.