EnterableState (Apache Commons SCXML 2.0-SNAPSHOT API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.commons.scxml2.model.TransitionTarget
- - org.apache.commons.scxml2.model.EnterableState

All Implemented Interfaces:

Serializable, DocumentOrder, Observable

Direct Known Subclasses:

Final, TransitionalState
```
public abstract class EnterableState
extends TransitionTarget
implements DocumentOrder
```
An abstract base class for state elements in SCXML that can be entered, such as State, Parallel or Final.

See Also:
Serialized Form

Field Summary
- Fields inherited from interface org.apache.commons.scxml2.model.DocumentOrder
  documentOrderComparator, reverseDocumentOrderComparator

Constructor Summary

Constructors
Constructor and Description

EnterableState()

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addOnEntry(OnEntry onEntry)` Adds an OnEntry element
`void`	`addOnExit(OnExit onExit)` Add an OnExit element
`List<OnEntry>`	`getOnEntries()` Get the OnEntry elements.
`List<OnExit>`	`getOnExits()` Get the OnExit elements
`int`	`getOrder()`
`abstract boolean`	`isAtomicState()` Check whether this is an atomic state.
`void`	`setOrder(int order)` Sets the document order of this state

Methods inherited from class org.apache.commons.scxml2.model.TransitionTarget
equals, getAncestor, getId, getNumberOfAncestors, getObservableId, getParent, hashCode, isDescendantOf, setId, setObservableId, setParent, updateDescendantsAncestors

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

- Constructor Detail
  - EnterableState
```
public EnterableState()
```
- Method Detail
  - getOrder
```
public final int getOrder()
```
    Specified by:
    
    getOrder in interface DocumentOrder
    
    Returns:
    the document order of this state
    See Also:
    DocumentOrder
  - setOrder
```
public final void setOrder(int order)
```
    Sets the document order of this state
    
    Parameters:
    order - the document order
    See Also:
    DocumentOrder
  - getOnEntries
```
public final List<OnEntry> getOnEntries()
```
    Get the OnEntry elements.
    
    Returns:
    Returns the onEntry elements
  - addOnEntry
```
public final void addOnEntry(OnEntry onEntry)
```
    Adds an OnEntry element
    
    Parameters:
    onEntry - The onEntry to add.
  - getOnExits
```
public final List<OnExit> getOnExits()
```
    Get the OnExit elements
    
    Returns:
    Returns the onExit elements
  - addOnExit
```
public final void addOnExit(OnExit onExit)
```
    Add an OnExit element
    
    Parameters:
    onExit - The onExit to add.
  - isAtomicState
```
public abstract boolean isAtomicState()
```
    Check whether this is an atomic state.
    An atomic state is a state of type Final or of type State without children,
    
    Returns:
    Returns true if this is an atomic state.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2005–2015 The Apache Software Foundation. All rights reserved.