net.imadz.lifecycle.meta.builder.impl

Class StateMetaBuilderImpl

java.lang.Object

net.imadz.meta.impl.MetaDataBuilderBase<SELF,PARENT>

net.imadz.lifecycle.meta.builder.impl.AnnotationMetaBuilderBase<SELF,PARENT>

net.imadz.lifecycle.meta.builder.impl.InheritableAnnotationMetaBuilderBase<StateMetadata,StateMachineMetadata>

net.imadz.lifecycle.meta.builder.impl.StateMetaBuilderImpl

All Implemented Interfaces:

Dumpable, AnnotationMetaBuilder<StateMetadata,StateMachineMetadata>, StateMetaBuilder, Inheritable<StateMetadata>, MetaType<StateMetadata>, MultiKeyed, Recoverable, StateMetadata, Flavored, MetaData, MetaDataBuilder<StateMetadata,StateMachineMetadata>

public class StateMetaBuilderImpl
extends InheritableAnnotationMetaBuilderBase<StateMetadata,StateMachineMetadata>
implements StateMetaBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface net.imadz.lifecycle.meta.type.StateMetadata

StateMetadata.StateTypeEnum

Field Summary

Fields inherited from class net.imadz.lifecycle.meta.builder.impl.InheritableAnnotationMetaBuilderBase

logger

Fields inherited from class net.imadz.lifecycle.meta.builder.impl.AnnotationMetaBuilderBase

registry

Fields inherited from class net.imadz.meta.impl.MetaDataBuilderBase

containerType, flavorMap, keySet, parent, path, properties

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StateMetaBuilderImpl(StateMachineMetaBuilder parent, String name)

Method Summary

Modifier and Type	Method and Description
void	addPossibleReachingEvent(EventMetadata event)
StateMetaBuilder	build(Class<?> clazz, StateMachineMetadata parent)
void	configureCompositeStateMachine(Class<?> stateClass)
void	configureFunctions(Class<?> stateClass)
void	configureRelationConstrants(Class<?> clazz)
void	dump(Dumper dumper) Dump out the contents using the given indentation.
protected boolean	extendsSuperKeySet()
protected StateMetadata	findSuper(Class<?> metaClass)
StateMachineMetadata	getCompositeStateMachine()
EventMetadata	getCorruptEvent()
FunctionMetadata[]	getDeclaredFunctionMetadata()
FunctionMetadata	getDeclaredFunctionMetadata(Object functionKey)
RelationConstraintMetadata[]	getDeclaredInboundWhiles()
RelationConstraintMetadata[]	getDeclaredValidWhiles()
EventMetadata	getEvent(Object eventKey)
FunctionMetadata	getFunctionMetadata(Object functionKey)
RelationConstraintMetadata[]	getInboundWhiles()
StateMetadata	getLinkTo()
StateMetadata	getOwningState()
EventMetadata[]	getPossibleLeavingEvents()
EventMetadata[]	getPossibleReachingEvents()
EventMetadata	getRecoverEvent()
EventMetadata	getRedoEvent()
String	getSimpleName()
StateMachineMetadata	getStateMachine()
StateMetadata.StateTypeEnum	getType()
RelationConstraintMetadata[]	getValidWhiles()
boolean	hasCorruptEvent()
boolean	hasInboundWhiles()
boolean	hasMultipleStateCandidatesOn(Object eventKey)
boolean	hasRecoverEvent()
boolean	hasRedoEvent()
boolean	hasValidWhiles()
boolean	isCompositeState()
boolean	isEventValid(Object eventKey)
boolean	isFinal()
boolean	isInitial()
void	setType(StateMetadata.StateTypeEnum type)
void	verifyMetaData(VerificationFailureSet verificationSet)
protected void	verifySuper(Class<?> clazz)

Methods inherited from class net.imadz.lifecycle.meta.builder.impl.InheritableAnnotationMetaBuilderBase

configureSuper, getDeclaredAnnotation, getSuper, getSuperMetaClass, hasDeclaredAnnotation, hasLifecycleOverrideAnnotation, hasSuper, hasSuper, isOverriding, setOverriding, setSuper

Methods inherited from class net.imadz.lifecycle.meta.builder.impl.AnnotationMetaBuilderBase

addKeys, getPrimaryKey, getRegistry, newVerificationException, newVerificationException, newVerificationFailure, newVerificationFailure, setPrimaryKey, setRegistry

Methods inherited from class net.imadz.meta.impl.MetaDataBuilderBase

addFlavor, addKey, addKeys, equals, getDottedPath, getFlavor, getFlavorMetaData, getKeySet, getMetaData, getName, getParent, getProperty, handleError, hasFlavor, hasFlavorMetaData, hashCode, hasKey, removeFlavor, setContainerType, setProperty, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.imadz.meta.MetaDataBuilder

addFlavor, addKey, addKeys, getMetaData, handleError, hasKey, removeFlavor

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

getSuper, hasSuper, isOverriding

Methods inherited from interface net.imadz.meta.MetaData

getDottedPath, getKeySet, getParent, getPrimaryKey

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

getKeySet

Constructor Detail

StateMetaBuilderImpl

protected StateMetaBuilderImpl(StateMachineMetaBuilder parent,
                               String name)

Method Detail

verifyMetaData

public void verifyMetaData(VerificationFailureSet verificationSet)

Specified by:

verifyMetaData in interface MetaData

hasRedoEvent

public boolean hasRedoEvent()

Specified by:

hasRedoEvent in interface Recoverable

getRedoEvent

public EventMetadata getRedoEvent()

Specified by:

getRedoEvent in interface Recoverable

hasRecoverEvent

public boolean hasRecoverEvent()

Specified by:

hasRecoverEvent in interface Recoverable

getRecoverEvent

public EventMetadata getRecoverEvent()

Specified by:

getRecoverEvent in interface Recoverable

hasCorruptEvent

public boolean hasCorruptEvent()

Specified by:

hasCorruptEvent in interface Recoverable

getCorruptEvent

public EventMetadata getCorruptEvent()

Specified by:

getCorruptEvent in interface Recoverable

dump

public void dump(Dumper dumper)

Description copied from interface: Dumpable

Dump out the contents using the given indentation. Any subelements should be additionally indented. argument out

Specified by:

dump in interface Dumpable

getStateMachine

public StateMachineMetadata getStateMachine()

Specified by:

getStateMachine in interface StateMetaBuilder

Specified by:

getStateMachine in interface StateMetadata

getSimpleName

public String getSimpleName()

Specified by:

getSimpleName in interface StateMetadata

isInitial

public boolean isInitial()

Specified by:

isInitial in interface StateMetadata

isFinal

public boolean isFinal()

Specified by:

isFinal in interface StateMetadata

getPossibleLeavingEvents

public EventMetadata[] getPossibleLeavingEvents()

Specified by:

getPossibleLeavingEvents in interface StateMetadata

getDeclaredFunctionMetadata

public FunctionMetadata[] getDeclaredFunctionMetadata()

Specified by:

getDeclaredFunctionMetadata in interface StateMetadata

getEvent

public EventMetadata getEvent(Object eventKey)

Specified by:

getEvent in interface StateMetadata

isEventValid

public boolean isEventValid(Object eventKey)

Specified by:

isEventValid in interface StateMetadata

hasInboundWhiles

public boolean hasInboundWhiles()

Specified by:

hasInboundWhiles in interface StateMetadata

getDeclaredInboundWhiles

public RelationConstraintMetadata[] getDeclaredInboundWhiles()

Specified by:

getDeclaredInboundWhiles in interface StateMetadata

Returns:

related state dependencies, expected to be used post-state-change validation

getInboundWhiles

public RelationConstraintMetadata[] getInboundWhiles()

Specified by:

getInboundWhiles in interface StateMetadata

hasValidWhiles

public boolean hasValidWhiles()

Specified by:

hasValidWhiles in interface StateMetadata

getValidWhiles

public RelationConstraintMetadata[] getValidWhiles()

Specified by:

getValidWhiles in interface StateMetadata

Returns:

related state dependencies, expected to be used pre-state-change validation, which will validate the validity of the state. Once the state is not valid, events will fail until the state has been fixed by synchronizationEvent. And if parent object life cycle exists, then this state should be valid ONLY in a subset of parent life cycle states, so does the parent object, the validation will go up along the parent's parent recursively.

getDeclaredValidWhiles

public RelationConstraintMetadata[] getDeclaredValidWhiles()

Specified by:

getDeclaredValidWhiles in interface StateMetadata

isCompositeState

public boolean isCompositeState()

Specified by:

isCompositeState in interface StateMetadata

getOwningState

public StateMetadata getOwningState()

Specified by:

getOwningState in interface StateMetadata

getCompositeStateMachine

public StateMachineMetadata getCompositeStateMachine()

Specified by:

getCompositeStateMachine in interface StateMetadata

getLinkTo

public StateMetadata getLinkTo()

Specified by:

getLinkTo in interface StateMetadata

build

public StateMetaBuilder build(Class<?> clazz,
                              StateMachineMetadata parent)
                       throws VerificationException

Specified by:

build in interface AnnotationMetaBuilder<StateMetadata,StateMachineMetadata>

Specified by:

build in interface StateMetaBuilder

Overrides:

build in class AnnotationMetaBuilderBase<StateMetadata,StateMachineMetadata>

Throws:

VerificationException

configureFunctions

public void configureFunctions(Class<?> stateClass)
                        throws VerificationException

Specified by:

configureFunctions in interface StateMetaBuilder

Throws:

VerificationException

configureCompositeStateMachine

public void configureCompositeStateMachine(Class<?> stateClass)
                                    throws VerificationException

Specified by:

configureCompositeStateMachine in interface StateMetaBuilder

Throws:

VerificationException

configureRelationConstrants

public void configureRelationConstrants(Class<?> clazz)
                                 throws VerificationException

Specified by:

configureRelationConstrants in interface StateMetaBuilder

Throws:

VerificationException

getDeclaredFunctionMetadata

public FunctionMetadata getDeclaredFunctionMetadata(Object functionKey)

Specified by:

getDeclaredFunctionMetadata in interface StateMetadata

hasMultipleStateCandidatesOn

public boolean hasMultipleStateCandidatesOn(Object eventKey)

Specified by:

hasMultipleStateCandidatesOn in interface StateMetadata

getFunctionMetadata

public FunctionMetadata getFunctionMetadata(Object functionKey)

Specified by:

getFunctionMetadata in interface StateMetadata

verifySuper

protected void verifySuper(Class<?> clazz)
                    throws VerificationException

Overrides:

verifySuper in class InheritableAnnotationMetaBuilderBase<StateMetadata,StateMachineMetadata>

Throws:

VerificationException

findSuper

protected StateMetadata findSuper(Class<?> metaClass)
                           throws VerificationException

Specified by:

findSuper in class InheritableAnnotationMetaBuilderBase<StateMetadata,StateMachineMetadata>

Throws:

VerificationException

extendsSuperKeySet

protected boolean extendsSuperKeySet()

Overrides:

extendsSuperKeySet in class InheritableAnnotationMetaBuilderBase<StateMetadata,StateMachineMetadata>

addPossibleReachingEvent

public void addPossibleReachingEvent(EventMetadata event)

Specified by:

addPossibleReachingEvent in interface StateMetaBuilder

getPossibleReachingEvents

public EventMetadata[] getPossibleReachingEvents()

Specified by:

getPossibleReachingEvents in interface StateMetadata

getType

public StateMetadata.StateTypeEnum getType()

Specified by:

getType in interface StateMetadata

setType

public void setType(StateMetadata.StateTypeEnum type)

Specified by:

setType in interface StateMetadata