org.apache.gobblin.fsm

Class FiniteStateMachine.Transition

java.lang.Object

org.apache.gobblin.fsm.FiniteStateMachine.Transition

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

FiniteStateMachine<T>

public class FiniteStateMachine.Transition
extends Object
implements Closeable

A handle used for controlling the transition of the FiniteStateMachine. Note if this handle is lost the FiniteStateMachine will likely go into an invalid state.

Method Summary

Modifier and Type	Method and Description
void	changeEndState(T endState) Change the end state of the transition.
void	close() Close the current transition moving the FiniteStateMachine to the end state and releasing all locks.
void	closeWithoutCallbacks() Close the current transition moving the FiniteStateMachine to the end state and releasing all locks without calling any callbacks.
T	getStartState() Get the state at the beginning of this transition.
void	switchEndStateToErrorState() Change the end state of the transition to the FSM error state.

Methods inherited from class java.lang.Object

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

Method Detail

getStartState

public T getStartState()

Get the state at the beginning of this transition.

changeEndState

public void changeEndState(T endState)
                    throws FiniteStateMachine.UnallowedTransitionException

Change the end state of the transition. The new end state must be a legal transition for the state when the FiniteStateMachine.Transition was created.

Throws:

FiniteStateMachine.UnallowedTransitionException - if the new end state is not an allowed transition.

switchEndStateToErrorState

public void switchEndStateToErrorState()

Change the end state of the transition to the FSM error state.

close

public void close()
           throws FiniteStateMachine.FailedTransitionCallbackException

Close the current transition moving the FiniteStateMachine to the end state and releasing all locks.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

FiniteStateMachine.FailedTransitionCallbackException - when start or end state callbacks fail. Note if this exception is thrown the transition is not complete and the error must be handled to complete it.

closeWithoutCallbacks

public void closeWithoutCallbacks()

Close the current transition moving the FiniteStateMachine to the end state and releasing all locks without calling any callbacks. This method should only be called after a close() has failed and the failure cannot be handled.