com.tangosol.util.fsm

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

java.lang.Object

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

All Implemented Interfaces:

Event<S>, Instruction

Enclosing class:

NonBlockingFiniteStateMachine<S extends Enum<S>>

public static class NonBlockingFiniteStateMachine.DelayedTransitionTo<S extends Enum<S>>
extends Object
implements Instruction, Event<S>

A NonBlockingFiniteStateMachine.DelayedTransitionTo is a specialized Instruction for NonBlockingFiniteStateMachines that enables a StateEntryAction to request a delayed transition to another state, unlike a Instruction.TransitionTo Instruction which occurs immediately.

See Also:

Instruction.TransitionTo

Nested Class Summary

Nested classes/interfaces inherited from interface com.tangosol.util.fsm.Instruction

Instruction.ProcessEvent<S extends Enum<S>>, Instruction.TransitionTo<S extends Enum<S>>

Field Summary

Fields inherited from interface com.tangosol.util.fsm.Instruction

NOTHING, STOP

Constructor Summary

Constructors

Constructor and Description
DelayedTransitionTo(S desiredState) Constructs a NonBlockingFiniteStateMachine.DelayedTransitionTo without a specified time (to be schedule as soon as possible).
DelayedTransitionTo(S desiredState, long lDuration, TimeUnit timeUnit) Constructs a NonBlockingFiniteStateMachine.DelayedTransitionTo with the specified time.

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.
long	getDuration() Obtains the amount of time to wait before the transition to the desired state should occur
TimeUnit	getTimeUnit() Obtains the TimeUnit for the getDuration()

Methods inherited from class java.lang.Object

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

Constructor Detail

DelayedTransitionTo

public DelayedTransitionTo(S desiredState)

Constructs a NonBlockingFiniteStateMachine.DelayedTransitionTo without a specified time (to be schedule as soon as possible).

Parameters:

desiredState - the desired state to which to transition

DelayedTransitionTo

public DelayedTransitionTo(S desiredState,
                           long lDuration,
                           TimeUnit timeUnit)

Constructs a NonBlockingFiniteStateMachine.DelayedTransitionTo with the specified time.

Parameters:

desiredState - the desired state to which to transition

lDuration - the amount of time to wait before the desired transition should occur

timeUnit - the unit of time measure

Method Detail

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

getDuration

public long getDuration()

Obtains the amount of time to wait before the transition to the desired state should occur

Returns:

the amount of time in the getTimeUnit()

getTimeUnit

public TimeUnit getTimeUnit()

Obtains the TimeUnit for the getDuration()

Returns:

the TimeUnit