Package org.chenile.stm.model

Class StateDescriptor

java.lang.Object

org.chenile.stm.model.StateDescriptor

All Implemented Interfaces:

TransientActionsAwareDescriptor

Direct Known Subclasses:

AutomaticStateDescriptor, ManualStateDescriptor

public class StateDescriptor
extends Object
implements TransientActionsAwareDescriptor

Field Summary

Fields

Modifier and Type	Field	Description
protected STMAction<?>	entryAction
protected STMAction<?>	exitAction
protected boolean	finalState
private FlowDescriptor	flow
private String	flowId
protected String	id
protected boolean	initialState
protected boolean	manualState	Is this state manual? (or a view state?)
protected Map<String,String>	metadata
private Map<String,Transition>	transitions

Constructor Summary

Constructors

Constructor	Description
StateDescriptor()

Method Summary

Modifier and Type	Method	Description
StateDescriptor	addMetaData(String name, String value)
StateDescriptor	addTransition(Transition transition)
boolean	checkIfonlyRetrievalTransitions()
StateDescriptor	entryAction(STMAction<?> entryAction)
StateDescriptor	exitAction(STMAction<?> exitAction)
FlowDescriptor	flow()
Set<String>	getAllTransitionsIds()
STMAction<?>	getEntryAction()
STMAction<?>	getExitAction()
FlowDescriptor	getFlow()
String	getFlowId()
String	getId()
Map<String,String>	getMetadata()
Map<String,Transition>	getTransitions()
StateDescriptor	id(String id)
boolean	isFinalState()
boolean	isInitialState()
boolean	isManualState()
StateDescriptor	makeFinalState()
StateDescriptor	makeInitialState()
void	merge(StateDescriptor sd)
Transition	on(String eventId)
void	setEntryAction(STMAction<?> entryAction)
void	setExitAction(STMAction<?> exitAction)
void	setFinalState(boolean endState)
void	setFlow(FlowDescriptor flow)
void	setFlowId(String flowId)
void	setId(String id)
void	setInitialState(boolean initialState)
void	setManualState(boolean manualState)
void	setMetadata(Map<String,String> metadata)
void	setTransitions(Map<String,Transition> transitions)
String	toString()
String	toXml()
void	validate()
void	validate(STMFlowStore flowStore)

Methods inherited from class java.lang.Object

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

Field Details

id

protected String id

initialState

protected boolean initialState

entryAction

protected STMAction<?> entryAction

finalState

protected boolean finalState

metadata

protected Map<String,String> metadata

exitAction

protected STMAction<?> exitAction

manualState

protected boolean manualState

Is this state manual? (or a view state?)

transitions

private Map<String,Transition> transitions

flowId

private String flowId

flow

private FlowDescriptor flow

Constructor Details

StateDescriptor

public StateDescriptor()

Method Details

isFinalState

public boolean isFinalState()

addMetaData

public StateDescriptor addMetaData(String name,
 String value)

getMetadata

public Map<String,String> getMetadata()

setFinalState

public void setFinalState(boolean endState)

makeFinalState

public StateDescriptor makeFinalState()

getEntryAction

public STMAction<?> getEntryAction()

setEntryAction

public void setEntryAction(STMAction<?> entryAction)

Specified by:

setEntryAction in interface TransientActionsAwareDescriptor

entryAction

public StateDescriptor entryAction(STMAction<?> entryAction)

getExitAction

public STMAction<?> getExitAction()

setMetadata

public void setMetadata(Map<String,String> metadata)

setExitAction

public void setExitAction(STMAction<?> exitAction)

Specified by:

setExitAction in interface TransientActionsAwareDescriptor

exitAction

public StateDescriptor exitAction(STMAction<?> exitAction)

isManualState

public boolean isManualState()

setManualState

public void setManualState(boolean manualState)

getFlowId

public String getFlowId()

setFlowId

public void setFlowId(String flowId)

setId

public void setId(String id)

id

public StateDescriptor id(String id)

getId

public String getId()

setInitialState

public void setInitialState(boolean initialState)

isInitialState

public boolean isInitialState()

makeInitialState

public StateDescriptor makeInitialState()

setTransitions

public void setTransitions(Map<String,Transition> transitions)

getTransitions

public Map<String,Transition> getTransitions()

addTransition

public StateDescriptor addTransition(Transition transition)
                              throws STMException

Throws:

STMException

on

public Transition on(String eventId)
              throws STMException

Throws:

STMException

toString

public String toString()

Overrides:

toString in class Object

checkIfonlyRetrievalTransitions

public boolean checkIfonlyRetrievalTransitions()

validate

public void validate()
              throws STMException

Throws:

STMException

validate

public void validate(STMFlowStore flowStore)
              throws STMException

Throws:

STMException

getAllTransitionsIds

public Set<String> getAllTransitionsIds()

merge

public void merge(StateDescriptor sd)

toXml

public String toXml()

flow

public FlowDescriptor flow()

getFlow

public FlowDescriptor getFlow()

setFlow

public void setFlow(FlowDescriptor flow)