com.kangirigungi.jstatemachine

Class GuardOr<StateId,Event>

java.lang.Object

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

All Implemented Interfaces:

IGuard<StateId,Event>

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

Logical or wrapper of two guards.

Author:

Peter Szabados

Constructor Summary

Constructors

Constructor and Description
GuardOr(IGuard<StateId,Event> left, IGuard<StateId,Event> right) Initialize the guard.

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

GuardOr

public GuardOr(IGuard<StateId,Event> left,
       IGuard<StateId,Event> right)

Initialize the guard. The check returns left || right.

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.