Class StateMachine
- All Implemented Interfaces:
TagValueListener
,TagValueWrapper
Each State can be specified to deliver events to a particular TagValueListener.
Transitions can be specified to occur between States when specific events are encountered. These events can be Tags delivered by startTag as well as the endTag/endRecord events. Events that result in exit from the current State can be specified to be notifiable to the State listener.
In addition, tables of transitions can be defined and specified as the fallback when the a corresponding Transition cannot be found for the tag. This is useful for specifying the destination States that are globally applicable for particular tags. As the fallbacks can be chained, you can end up with a hierarchy of Transition Tables, some being State-specific, others applicable to groups of States and finally one being global.
- Author:
- David Huen
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclass
Implementation of a State in a state machinestatic interface
Interface implemented by State listeners that want notification when a transition leaves the State.class
a basic listener for a State.static interface
Interface for a State within this StateMachineclass
class to represent a State Transitionclass
Table of Transition destination States and their corresponding Tags. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected TagValueListener
protected static final String
protected static final String
protected static final String
protected static final String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateState
(String label) void
The current record has ended.void
endTag()
End the current tag.get listener to which all calls will be delegatedvoid
setDelegate
(TagValueListener delegate) TagValueWrapper interfacevoid
A new record is about to start.void
TagValueListener interfacevoid
value
(TagValueContext ctxt, Object value) A value has been seen.
-
Field Details
-
START_RECORD_TAG
- See Also:
-
END_RECORD_TAG
- See Also:
-
END_TAG
- See Also:
-
MAGICAL_STATE
- See Also:
-
delegate
-
-
Constructor Details
-
StateMachine
public StateMachine()
-
-
Method Details
-
getMagicalState
-
createState
-
getState
-
createTransitionTable
-
setDelegate
TagValueWrapper interface- Specified by:
setDelegate
in interfaceTagValueWrapper
-
getDelegate
Description copied from interface:TagValueWrapper
get listener to which all calls will be delegated- Specified by:
getDelegate
in interfaceTagValueWrapper
-
startTag
TagValueListener interface- Specified by:
startTag
in interfaceTagValueListener
- Parameters:
tag
- the Object representing the new tag- Throws:
ParserException
- if the tag could not be started
-
endTag
Description copied from interface:TagValueListener
End the current tag.- Specified by:
endTag
in interfaceTagValueListener
- Throws:
ParserException
- if the tag could not be ended
-
startRecord
Description copied from interface:TagValueListener
A new record is about to start.- Specified by:
startRecord
in interfaceTagValueListener
- Throws:
ParserException
- if the record can not be started
-
endRecord
Description copied from interface:TagValueListener
The current record has ended.- Specified by:
endRecord
in interfaceTagValueListener
- Throws:
ParserException
- if the record can not be ended
-
value
Description copied from interface:TagValueListener
A value has been seen.- Specified by:
value
in interfaceTagValueListener
- Parameters:
ctxt
- a TagValueContext that could be used to push a sub-documentvalue
- the value Object observed- Throws:
ParserException
- if the value could not be processed
-