com.tangosol.util.fsm

Class NonBlockingFiniteStateMachine.SubsequentEvent<S extends Enum<S>>

java.lang.Object

com.tangosol.util.fsm.NonBlockingFiniteStateMachine.SubsequentEvent<S>

Type Parameters:

S - the state type of the FiniteStateMachine

All Implemented Interfaces:

Event<S>, LifecycleAwareEvent<S>

Enclosing class:

NonBlockingFiniteStateMachine<S extends Enum<S>>

public static class NonBlockingFiniteStateMachine.SubsequentEvent<S extends Enum<S>>
extends Object
implements LifecycleAwareEvent<S>

A NonBlockingFiniteStateMachine.SubsequentEvent is an Event that ensures that another (wrapped) Event to occur if an only if the FiniteStateMachine is at a certain transition count. Should an attempt to process the wrapped Event occur at another transition count, processing of the said event is ignored.

NonBlockingFiniteStateMachine.SubsequentEvents are designed to provide the ability for future scheduled Events to be skipped if another Event has been processed between the time when the NonBlockingFiniteStateMachine.SubsequentEvent was requested to be processed and when it was actually processed. That is, the purpose of this is to allow an Event to be skipped if other Events interleave between the time when the said Event was actually scheduled and when it was actually meant to be processed.

Constructor Summary

Constructors

Constructor and Description
SubsequentEvent(Event<S> event) Constructs a NonBlockingFiniteStateMachine.SubsequentEvent.

Method Summary

Modifier and Type	Method and Description
S	getDesiredState(S currentState, ExecutionContext context) Determines the desired state of the FiniteStateMachine for the Event given the current state of the FiniteStateMachine.
boolean	onAccept(ExecutionContext context) Called by a FiniteStateMachine when the LifecycleAwareEvent is initially about to be accepted for processing.
void	onProcessed(ExecutionContext context) Called by a FiniteStateMachine when the LifecycleAwareEvent has been processed.
void	onProcessing(ExecutionContext context) Called by a FiniteStateMachine when the LifecycleAwareEvent is about to be processed.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SubsequentEvent

public SubsequentEvent(Event<S> event)

Constructs a NonBlockingFiniteStateMachine.SubsequentEvent.

Parameters:

event - the actual event to process

Method Detail

onAccept

public boolean onAccept(ExecutionContext context)

Called by a FiniteStateMachine when the LifecycleAwareEvent is initially about to be accepted for processing.

Specified by:

onAccept in interface LifecycleAwareEvent<S extends Enum<S>>

Parameters:

context - the ExecutionContext for the Event

Returns:

true if the Event should be accepted, or false if the FiniteStateMachine should ignore the LifecycleAwareEvent

onProcessed

public void onProcessed(ExecutionContext context)

Called by a FiniteStateMachine when the LifecycleAwareEvent has been processed.

Specified by:

onProcessed in interface LifecycleAwareEvent<S extends Enum<S>>

Parameters:

context - the ExecutionContext for the Event

onProcessing

public void onProcessing(ExecutionContext context)

Called by a FiniteStateMachine when the LifecycleAwareEvent is about to be processed.

Specified by:

onProcessing in interface LifecycleAwareEvent<S extends Enum<S>>

Parameters:

context - the ExecutionContext for the Event

getDesiredState

public S getDesiredState(S currentState,
                         ExecutionContext context)

Determines the desired state of the FiniteStateMachine for the Event given the current state of the FiniteStateMachine.

Specified by:

getDesiredState in interface Event<S extends Enum<S>>

Parameters:

currentState - the current state of the FiniteStateMachine

context - the ExecutionContext for the Event

Returns:

the desired state of the FiniteStateMachine or null if no transition is required

toString

public String toString()

Overrides:

toString in class Object