net.imadz.lifecycle.meta.type

Interface StateMachineMetadata

All Superinterfaces:

Dumpable, Inheritable<StateMachineMetadata>, MetaData, MetaType<StateMachineMetadata>, MultiKeyed, Recoverable

All Known Subinterfaces:

StateMachineMetaBuilder

All Known Implementing Classes:

StateMachineMetaBuilderImpl

public interface StateMachineMetadata
extends Recoverable, MetaType<StateMachineMetadata>

Method Summary

Modifier and Type	Method and Description
ConditionMetadata[]	getAllCondtions()
EventMetadata[]	getAllEvents()
StateMetadata[]	getAllStates()
StateMachineMetadata[]	getCompositeStateMachines()
ConditionMetadata	getCondtion(Object conditionKey)
ConditionMetadata[]	getDeclaredConditions()
EventMetadata	getDeclaredEvent(Object eventKey)
EventMetadata[]	getDeclaredEventSet()
RelationMetadata	getDeclaredRelationMetadata(Object relationKey)
StateMetadata	getDeclaredState(Object stateKey)
StateMetadata[]	getDeclaredStateSet()
EventMetadata	getEvent(Object eventKey)
StateMetadata[]	getFinalStates()
StateMetadata	getInitialState()
StateMetadata	getOwningState()
StateMachineMetadata	getOwningStateMachine()
StateMachineMetadata	getParent()
LifecycleMetaRegistry	getRegistry()
RelationMetadata	getRelationMetadata(Object relationKey)
StateMetadata	getState(Object stateKey)
EventMetadata	getStateSynchronizationEvent()
boolean	hasCondition(Object conditionKey)
boolean	hasEvent(Object eventKey)
boolean	hasParent()
boolean	hasRelation(Object relationKey)
boolean	isComposite()
StateMachineObject<?>	newInstance(Class<?> clazz)

Methods inherited from interface net.imadz.lifecycle.meta.Recoverable

getCorruptEvent, getRecoverEvent, getRedoEvent, hasCorruptEvent, hasRecoverEvent, hasRedoEvent

Methods inherited from interface net.imadz.lifecycle.meta.Inheritable

getSuper, hasSuper, isOverriding

Methods inherited from interface net.imadz.meta.MetaData

getDottedPath, getKeySet, getPrimaryKey, verifyMetaData

Methods inherited from interface net.imadz.common.Dumpable

dump

Methods inherited from interface net.imadz.lifecycle.meta.MultiKeyed

getKeySet

Method Detail

hasParent

boolean hasParent()

getParent

StateMachineMetadata getParent()

Specified by:

getParent in interface MetaData

hasRelation

boolean hasRelation(Object relationKey)

getDeclaredRelationMetadata

RelationMetadata getDeclaredRelationMetadata(Object relationKey)

Parameters:

relationKey -

Returns:

RelationMetadata in current StateMachine

getRelationMetadata

RelationMetadata getRelationMetadata(Object relationKey)

Parameters:

relationKey -

Returns:

RelationMetadata in StateMachine hierarchy.

getDeclaredStateSet

StateMetadata[] getDeclaredStateSet()

getDeclaredState

StateMetadata getDeclaredState(Object stateKey)

getAllStates

StateMetadata[] getAllStates()

Returns:

all states in current StateMachine, current StateMachine's composite StateMachine, super StateMachine, super StateMachine's composite StateMachine.

getState

StateMetadata getState(Object stateKey)

Parameters:

stateKey -

Returns:

state in allStates by specified stateKey.

getInitialState

StateMetadata getInitialState()

getFinalStates

StateMetadata[] getFinalStates()

getDeclaredEventSet

EventMetadata[] getDeclaredEventSet()

getDeclaredEvent

EventMetadata getDeclaredEvent(Object eventKey)

getAllEvents

EventMetadata[] getAllEvents()

Returns:

events in current StateMachine, current StateMachine's CompositeStateMachine, super StateMachines, super StateMachines'composite StateMachines.

getEvent

EventMetadata getEvent(Object eventKey)

Parameters:

eventKey -

Returns:

event in allEventSet by specified eventKey

getStateSynchronizationEvent

EventMetadata getStateSynchronizationEvent()

newInstance

StateMachineObject<?> newInstance(Class<?> clazz)
                           throws VerificationException

Parameters:

clazz - defined with @LifecycleMeta, and with @Event , @StateIndicator, @Relation.

Returns:

a concrete instance of StateMachineMetadata, whose abstract part is concreted by the clazz param.

Throws:

VerificationException

isComposite

boolean isComposite()

getOwningStateMachine

StateMachineMetadata getOwningStateMachine()

Returns:

a state machine template, in whose state defining this state machine

getOwningState

StateMetadata getOwningState()

getCompositeStateMachines

StateMachineMetadata[] getCompositeStateMachines()

getDeclaredConditions

ConditionMetadata[] getDeclaredConditions()

Returns:

condition metadata defined in current state machine and current composite state machines.

getAllCondtions

ConditionMetadata[] getAllCondtions()

Returns:

all condition metadata defined in current state machine, current composite state machines, super state machine, super state machine's composite state machines.

getCondtion

ConditionMetadata getCondtion(Object conditionKey)

Parameters:

conditionKey -

Returns:

condition metadata in the state machine's inheritance hierarchy, including composite state machines.

hasCondition

boolean hasCondition(Object conditionKey)

Parameters:

conditionKey -

Returns:

true if the condition can by found in the state machine's inheritance hierarchy and composite state machines.

getRegistry

LifecycleMetaRegistry getRegistry()

hasEvent

boolean hasEvent(Object eventKey)