org.springframework.statemachine.persist

Class AbstractStateMachinePersister<S,E,T>

java.lang.Object

org.springframework.statemachine.persist.AbstractStateMachinePersister<S,E,T>

Type Parameters:

S - the type of state

E - the type of event

T - the type of context object

All Implemented Interfaces:

StateMachinePersister<S,E,T>

Direct Known Subclasses:

DefaultStateMachinePersister, RedisStateMachinePersister

public abstract class AbstractStateMachinePersister<S,E,T>
extends java.lang.Object
implements StateMachinePersister<S,E,T>

Base implementation of a StateMachinePersister easing persist and restore operations with a StateMachinePersist.

Author:

Janne Valkealahti

Constructor Summary

Constructors

Constructor and Description
AbstractStateMachinePersister(StateMachinePersist<S,E,T> stateMachinePersist) Instantiates a new abstract state machine persister.

Method Summary

Modifier and Type	Method and Description
protected StateMachineContext<S,E>	buildStateMachineContext(StateMachine<S,E> stateMachine) Builds the state machine context which is used for persist operation.
void	persist(StateMachine<S,E> stateMachine, T contextObj) Persist a state machine with a given context object.
StateMachine<S,E>	restore(StateMachine<S,E> stateMachine, T contextObj) Reset a state machine with a given context object.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractStateMachinePersister

public AbstractStateMachinePersister(StateMachinePersist<S,E,T> stateMachinePersist)

Instantiates a new abstract state machine persister.

Parameters:

stateMachinePersist - the state machine persist

Method Detail

persist

public final void persist(StateMachine<S,E> stateMachine,
                          T contextObj)
                   throws java.lang.Exception

Description copied from interface: StateMachinePersister

Persist a state machine with a given context object.

Specified by:

persist in interface StateMachinePersister<S,E,T>

Parameters:

stateMachine - the state machine

contextObj - the context ojb

Throws:

java.lang.Exception - the exception in case or any persist error

restore

public final StateMachine<S,E> restore(StateMachine<S,E> stateMachine,
                                       T contextObj)
                                throws java.lang.Exception

Description copied from interface: StateMachinePersister

Reset a state machine with a given context object. Returned machine has been reseted and is ready to be used.

Specified by:

restore in interface StateMachinePersister<S,E,T>

Parameters:

stateMachine - the state machine

contextObj - the context ojb

Returns:

the state machine

Throws:

java.lang.Exception - the exception in case or any persist error

buildStateMachineContext

protected StateMachineContext<S,E> buildStateMachineContext(StateMachine<S,E> stateMachine)

Builds the state machine context which is used for persist operation.

Parameters:

stateMachine - the state machine

Returns:

the state machine context