Status (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.Status

All Implemented Interfaces:

Serializable
```
public class Status
extends Object
implements Serializable
```
The immutable encapsulation of the current state of a state machine.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

Status(StateConfiguration configuration)

Method Summary

Methods
Modifier and Type	Method and Description
`Set<EnterableState>`	`getActiveStates()` Get the active states configuration.
`Final`	`getFinalState()`
`Set<EnterableState>`	`getStates()` Get the atomic states configuration (leaf only).
`boolean`	`isFinal()`
`boolean`	`isInState(String state)`

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

- Constructor Detail
  - Status
```
public Status(StateConfiguration configuration)
```
- Method Detail
  - isFinal
```
public boolean isFinal()
```
    Returns:
    Whether the state machine terminated AND we reached a top level Final state.
  - getFinalState
```
public Final getFinalState()
```
    Returns:
    Returns the single top level final state in which the state machine terminated, or null otherwise
  - getStates
```
public Set<EnterableState> getStates()
```
    Get the atomic states configuration (leaf only).
    
    Returns:
    Returns the atomic states configuration - simple (leaf) states only.
  - getActiveStates
```
public Set<EnterableState> getActiveStates()
```
    Get the active states configuration.
    
    Returns:
    active states configuration including simple states and their complex ancestors up to the root.
  - isInState
```
public boolean isInState(String state)
```

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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