BasicState (scxml-java-implementation 1.0.1 API)

java.lang.Object
- com.nosolojava.fsm.impl.model.basic.state.BasicState

All Implemented Interfaces:

State, Serializable, Comparable<State>

Direct Known Subclasses:

BasicHistoryState
```
public class BasicState
extends Object
implements State
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected List<State> historyChildrens

protected boolean historyState

static String ROOT_STATE_NAME

Fields
Modifier and Type	Field and Description
`protected List<State>`	`historyChildrens`
`protected boolean`	`historyState`
`static String`	`ROOT_STATE_NAME`

Constructor Summary

Constructors
Modifier Constructor and Description

protected BasicState(String name, State parent, DoneData doneData, boolean finalState)

Constructors
Modifier	Constructor and Description
`protected`	`BasicState(String name, State parent, DoneData doneData, boolean finalState)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addData(Data data)`
`void`	`addData(List<Data> dataList)`
`Transition`	`addInternalTransition(State source, String event, String targetState)`
`Transition`	`addInternalTransition(State source, String event, String targetState, String guarCondition)`
`Transition`	`addInternalTransition(String event, String targetState)`
`Transition`	`addInternalTransition(String event, String targetState, String guarCondition)`
`void`	`addInvoke(Invoke invoke)`
`void`	`addInvokes(List<Invoke> invokes)`
`void`	`addOnEntryExecutable(Executable varName)`
`void`	`addOnEntryExecutables(List<Executable> varNames)`
`void`	`addOnExitExecutable(Executable executable)`
`void`	`addOnExitExecutables(List<Executable> executables)`
`Transition`	`addTransition(State source, String event, String targetState)`
`Transition`	`addTransition(State source, String event, String targetState, String guardCondition)`
`Transition`	`addTransition(String event, String targetState)`
`Transition`	`addTransition(String event, String targetState, String guarCondition)`
`void`	`addTransition(Transition transition)`
`protected void`	`calculateBreadCrumb(List<State> breadcrumb)`
`void`	`clearAndSetInvokes(List<Invoke> invokes)`
`void`	`clearAndSetOnEntryExecutables(List<Executable> varNames)`
`void`	`clearAndSetOnExitExecutables(List<Executable> executables)`
`int`	`compareTo(State right)`
`static BasicState`	`createBasicState(String name, State parent)`
`static BasicState`	`createFinalState(String name, State parent, DoneData donedata)`
`static BasicState`	`createParallelState(String name, State parent)`
`static BasicState`	`createRootState()`
`boolean`	`equals(Object obj)`
`List<State>`	`getBreadCrumb()`
`List<State>`	`getChildrens()`
`DataModel`	`getDataModel()`
`int`	`getDocumentOrder()`
`DoneData`	`getDoneData()`
`List<State>`	`getHistoryStates()`
`HistoryTypes`	`getHistoryType()`
`InitialState`	`getInitialState()`
`List<Invoke>`	`getInvokes()`
`String`	`getName()`
`List<Executable>`	`getOnEntryExecutables()`
`List<Executable>`	`getOnExitExecutables()`
`State`	`getParent()`
`List<Transition>`	`getTransitions()`
`boolean`	`hasChildrens()`
`int`	`hashCode()`
`boolean`	`isDescendant(State otherState)`
`boolean`	`isFinal()`
`boolean`	`isHistoryState()`
`boolean`	`isParallel()`
`boolean`	`isRootState()`
`static void`	`main(String[] args)`
`void`	`setDocumentOrder(int documentOrder)`
`void`	`setInitialState(InitialState initialState)`
`void`	`setInitialStateName(String initialStateName)`
`void`	`setParallel(boolean parallel)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

historyState
```
protected boolean historyState
```

historyChildrens

protected final List<State> historyChildrens

ROOT_STATE_NAME

public static final String ROOT_STATE_NAME

See Also:: Constant Field Values

Constructor Detail

BasicState

protected BasicState(String name,
                     State parent,
                     DoneData doneData,
                     boolean finalState)
              throws ConfigurationException

Throws:: ConfigurationException

Method Detail

createRootState

public static BasicState createRootState()
                                  throws ConfigurationException

Throws:: ConfigurationException

createBasicState

public static BasicState createBasicState(String name,
                                          State parent)
                                   throws ConfigurationException

Throws:: ConfigurationException

createFinalState

public static BasicState createFinalState(String name,
                                          State parent,
                                          DoneData donedata)
                                   throws ConfigurationException

Throws:: ConfigurationException

createParallelState

public static BasicState createParallelState(String name,
                                             State parent)
                                      throws ConfigurationException

Throws:: ConfigurationException

isRootState
```
public boolean isRootState()
```
Specified by:

isRootState in interface State

addTransition

public Transition addTransition(String event,
                                String targetState)

Specified by:: addTransition in interface State

addTransition

public Transition addTransition(State source,
                                String event,
                                String targetState)

Specified by:: addTransition in interface State

addTransition

public Transition addTransition(State source,
                                String event,
                                String targetState,
                                String guardCondition)

Specified by:: addTransition in interface State

addTransition

public Transition addTransition(String event,
                                String targetState,
                                String guarCondition)

Specified by:: addTransition in interface State

addInternalTransition

public Transition addInternalTransition(String event,
                                        String targetState)

Specified by:: addInternalTransition in interface State

addInternalTransition

public Transition addInternalTransition(String event,
                                        String targetState,
                                        String guarCondition)

Specified by:: addInternalTransition in interface State

addInternalTransition

public Transition addInternalTransition(State source,
                                        String event,
                                        String targetState)

Specified by:: addInternalTransition in interface State

addInternalTransition

public Transition addInternalTransition(State source,
                                        String event,
                                        String targetState,
                                        String guarCondition)

Specified by:: addInternalTransition in interface State

compareTo
```
public int compareTo(State right)
```
Specified by:

compareTo in interface Comparable<State>

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

isDescendant
```
public boolean isDescendant(State otherState)
```
Specified by:

isDescendant in interface State

calculateBreadCrumb

protected void calculateBreadCrumb(List<State> breadcrumb)

getName
```
public String getName()
```
Specified by:

getName in interface State

getTransitions
```
public List<Transition> getTransitions()
```
Specified by:

getTransitions in interface State

addTransition
```
public void addTransition(Transition transition)
```
Specified by:

addTransition in interface State

getOnEntryExecutables
```
public List<Executable> getOnEntryExecutables()
```
Specified by:

getOnEntryExecutables in interface State

addOnEntryExecutable
```
public void addOnEntryExecutable(Executable varName)
```
Specified by:

addOnEntryExecutable in interface State

addOnEntryExecutables
```
public void addOnEntryExecutables(List<Executable> varNames)
```
Specified by:

addOnEntryExecutables in interface State

clearAndSetOnEntryExecutables
```
public void clearAndSetOnEntryExecutables(List<Executable> varNames)
```
Specified by:

clearAndSetOnEntryExecutables in interface State

getOnExitExecutables
```
public List<Executable> getOnExitExecutables()
```
Specified by:

getOnExitExecutables in interface State

addOnExitExecutable
```
public void addOnExitExecutable(Executable executable)
```
Specified by:

addOnExitExecutable in interface State

addOnExitExecutables
```
public void addOnExitExecutables(List<Executable> executables)
```
Specified by:

addOnExitExecutables in interface State

clearAndSetOnExitExecutables
```
public void clearAndSetOnExitExecutables(List<Executable> executables)
```
Specified by:

clearAndSetOnExitExecutables in interface State

getInvokes
```
public List<Invoke> getInvokes()
```
Specified by:

getInvokes in interface State

addInvoke
```
public void addInvoke(Invoke invoke)
```
Specified by:

addInvoke in interface State

addInvokes
```
public void addInvokes(List<Invoke> invokes)
```
Specified by:

addInvokes in interface State

clearAndSetInvokes
```
public void clearAndSetInvokes(List<Invoke> invokes)
```
Specified by:

clearAndSetInvokes in interface State

addData
```
public void addData(Data data)
```
Specified by:

addData in interface State

addData
```
public void addData(List<Data> dataList)
```
Specified by:

addData in interface State

getDataModel
```
public DataModel getDataModel()
```
Specified by:

getDataModel in interface State

getParent
```
public State getParent()
```
Specified by:

getParent in interface State

getBreadCrumb
```
public List<State> getBreadCrumb()
```
Specified by:

getBreadCrumb in interface State

getDocumentOrder
```
public int getDocumentOrder()
```
Specified by:

getDocumentOrder in interface State

setDocumentOrder
```
public void setDocumentOrder(int documentOrder)
```
Specified by:

setDocumentOrder in interface State

hasChildrens
```
public boolean hasChildrens()
```
Specified by:

hasChildrens in interface State

getChildrens
```
public List<State> getChildrens()
```
Specified by:

getChildrens in interface State

getHistoryStates
```
public List<State> getHistoryStates()
```
Specified by:

getHistoryStates in interface State

getInitialState
```
public InitialState getInitialState()
```
Specified by:

getInitialState in interface State

setInitialState

public void setInitialState(InitialState initialState)
                     throws ConfigurationException

Specified by:: setInitialState in interface State
Throws:: ConfigurationException

setInitialStateName

public void setInitialStateName(String initialStateName)
                         throws ConfigurationException

Specified by:: setInitialStateName in interface State
Throws:: ConfigurationException

isHistoryState
```
public boolean isHistoryState()
```
Specified by:

isHistoryState in interface State

getHistoryType
```
public HistoryTypes getHistoryType()
```
Specified by:

getHistoryType in interface State

isParallel
```
public boolean isParallel()
```
Specified by:

isParallel in interface State

setParallel
```
public void setParallel(boolean parallel)
```
Specified by:

setParallel in interface State

getDoneData
```
public DoneData getDoneData()
```
Specified by:

getDoneData in interface State

isFinal
```
public boolean isFinal()
```
Specified by:

isFinal in interface State

main

public static void main(String[] args)
                 throws ConfigurationException

Throws:: ConfigurationException

Class BasicState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

historyState

historyChildrens

ROOT_STATE_NAME

Constructor Detail

BasicState

Method Detail

createRootState

createBasicState

createFinalState

createParallelState

isRootState

addTransition

addTransition

addTransition

addTransition

addInternalTransition

addInternalTransition

addInternalTransition

addInternalTransition

compareTo

hashCode

equals

toString

isDescendant

calculateBreadCrumb

getName

getTransitions

addTransition

getOnEntryExecutables

addOnEntryExecutable

addOnEntryExecutables

clearAndSetOnEntryExecutables

getOnExitExecutables

addOnExitExecutable

addOnExitExecutables

clearAndSetOnExitExecutables

getInvokes

addInvoke

addInvokes

clearAndSetInvokes

addData

addData

getDataModel

getParent

getBreadCrumb

getDocumentOrder

setDocumentOrder

hasChildrens

getChildrens

getHistoryStates

getInitialState

setInitialState

setInitialStateName

isHistoryState

getHistoryType

isParallel

setParallel

getDoneData

isFinal

main