SimpleTransition (Apache Commons SCXML 2.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.scxml2.model.Executable
- - org.apache.commons.scxml2.model.SimpleTransition

All Implemented Interfaces:

Serializable, NamespacePrefixesHolder, Observable

Direct Known Subclasses:

Transition
```
public class SimpleTransition
extends Executable
implements NamespacePrefixesHolder, Observable
```
The class in this SCXML object model that corresponds to the simple <transition> SCXML element, without Transition rules for "events" or "guard-conditions". Used for <history> or <history> elements.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

SimpleTransition()
Constructor.

Constructors
Constructor and Description
`SimpleTransition()` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`Map<String,String>`	`getNamespaces()` Get the XML namespaces at this action node in the SCXML document.
`String`	`getNext()` Get the ID of the transition target (may be null, if, for example, the target is specified inline).
`Integer`	`getObservableId()`
`TransitionalState`	`getParent()` Get the TransitionalState (State or Parallel) parent.
`Set<TransitionTarget>`	`getTargets()` Get the set of transition targets (may be an empty list).
`TransitionalState`	`getTransitionDomain()` Returns the transition domain of this transition If this transition is target-less OR if its transition domain is the SCXML document itself, null is returned.
`TransitionType`	`getType()`
`boolean`	`isTypeInternal()` Returns the effective Transition type.
`void`	`setNamespaces(Map<String,String> namespaces)` Set the XML namespaces at this action node in the SCXML document.
`void`	`setNext(String next)` Set the transition target by specifying its ID.
`void`	`setObservableId(Integer observableId)` Sets the observableId for this Observable, which must be unique within the SCXML state machine
`void`	`setParent(TransitionalState parent)` Set the TransitionalState (State or Parallel) parent For transitions of Initial or History elements their TransitionalState parent must be set.
`void`	`setType(TransitionType type)` Sets the Transition type

Methods inherited from class org.apache.commons.scxml2.model.Executable
addAction, getActions, setParent

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

- Constructor Detail
  - SimpleTransition
```
public SimpleTransition()
```
    Constructor.
- Method Detail
  - getObservableId
```
public final Integer getObservableId()
```
    Specified by:
    
    getObservableId in interface Observable
    
    Returns:
    Returns the id for this Observable which is unique within the SCXML state machine
  - setObservableId
```
public final void setObservableId(Integer observableId)
```
    Sets the observableId for this Observable, which must be unique within the SCXML state machine
    
    Parameters:
    observableId - the observableId
  - getParent
```
public TransitionalState getParent()
```
    Get the TransitionalState (State or Parallel) parent.
    
    Overrides:
    
    getParent in class Executable
    
    Returns:
    Returns the parent.
  - setParent
```
public final void setParent(TransitionalState parent)
```
    Set the TransitionalState (State or Parallel) parent
    For transitions of Initial or History elements their TransitionalState parent must be set.
    
    Parameters:
    parent - The parent to set.
  - getType
```
public final TransitionType getType()
```
    Returns:
    true if Transition type == internal or false if type == external (default)
  - setType
```
public final void setType(TransitionType type)
```
    Sets the Transition type
    
    Parameters:
    type - the Transition type
  - isTypeInternal
```
public final boolean isTypeInternal()
```
    Returns the effective Transition type.
    A transition type is only effectively internal if:
    - its getType() == TransitionType.internal
    - its source state getParent() State.isComposite()
    - all its getTargets() are proper descendants of its getParent()
    Otherwise it is treated (for determining its exit states) as if it is of type TransitionType.external
    Returns:
    true if the effective Transition type is TransitionType.internal
    See Also:
    http://www.w3.org/TR/2014/CR-scxml-20140313/#SelectingTransitions
  - getTransitionDomain
```
public TransitionalState getTransitionDomain()
```
    Returns the transition domain of this transition
    If this transition is target-less OR if its transition domain is the SCXML document itself, null is returned.
    
    This method therefore only is useful to be invoked if the transition has targets!
    
    If the transition has targets then the transition domain is the compound State parent such that:
    - all states that are exited or entered as a result of taking this transition are descendants of it
    - no descendant of it has this property
    If there is no such compound state parent, the transition domain effectively becomes the SCXML document itself, which is not a (Transitional)State, and thus null will be returned instead.
    Returns:
    The transition domain of this transition
  - getNamespaces
```
public final Map<String,String> getNamespaces()
```
    Get the XML namespaces at this action node in the SCXML document.
    
    Specified by:
    
    getNamespaces in interface NamespacePrefixesHolder
    
    Returns:
    Returns the map of namespaces.
  - setNamespaces
```
public final void setNamespaces(Map<String,String> namespaces)
```
    Set the XML namespaces at this action node in the SCXML document.
    
    Specified by:
    
    setNamespaces in interface NamespacePrefixesHolder
    
    Parameters:
    namespaces - The document namespaces.
  - getTargets
```
public final Set<TransitionTarget> getTargets()
```
    Get the set of transition targets (may be an empty list).
    
    Returns:
    Returns the target(s) as specified in SCXML markup.
    Remarks: Is empty for "stay" transitions.
    Since:
    
    0.7
  - getNext
```
public final String getNext()
```
    Get the ID of the transition target (may be null, if, for example, the target is specified inline).
    
    Returns:
    String Returns the transition target ID
    See Also:
    getTargets()
  - setNext
```
public final void setNext(String next)
```
    Set the transition target by specifying its ID.
    
    Parameters:
    next - The the transition target ID

Class SimpleTransition

Constructor Summary

Method Summary

Methods inherited from class org.apache.commons.scxml2.model.Executable

Methods inherited from class java.lang.Object

Constructor Detail

SimpleTransition

Method Detail

getObservableId

setObservableId

getParent

setParent

getType

setType

isTypeInternal

getTransitionDomain

getNamespaces

setNamespaces

getTargets

getNext

setNext