TransitionTarget (Apache Commons SCXML 2.0-SNAPSHOT API)

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

All Implemented Interfaces:

Serializable, Observable

Direct Known Subclasses:

EnterableState, History
```
public abstract class TransitionTarget
extends Object
implements Serializable, Observable
```
An abstract base class for elements in SCXML that can serve as a <target> for a <transition>, such as State or Parallel.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

TransitionTarget()
Constructor.

Constructors
Constructor and Description
`TransitionTarget()` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)` Enforce identity equality only
`EnterableState`	`getAncestor(int level)` Get the ancestor of this TransitionTarget at specified level
`String`	`getId()` Get the identifier for this transition target (may be null).
`int`	`getNumberOfAncestors()`
`Integer`	`getObservableId()`
`EnterableState`	`getParent()` Get the parent TransitionTarget.
`int`	`hashCode()` Enforce returning identity based hascode
`boolean`	`isDescendantOf(TransitionTarget context)` Checks whether this transition target (State or Parallel) is a descendant of the transition target context.
`void`	`setId(String id)` Set the identifier for this transition target.
`void`	`setObservableId(Integer observableId)` Sets the observableId for this Observable, which must be unique within the SCXML state machine
`protected void`	`setParent(EnterableState parent)` Set the parent EnterableState.
`protected void`	`updateDescendantsAncestors()` Update TransitionTarget descendants their ancestors

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

- Constructor Detail
  - TransitionTarget
```
public TransitionTarget()
```
    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
  - getId
```
public final String getId()
```
    Get the identifier for this transition target (may be null).
    
    Returns:
    Returns the id.
  - setId
```
public final void setId(String id)
```
    Set the identifier for this transition target.
    
    Parameters:
    id - The id to set.
  - getNumberOfAncestors
```
public int getNumberOfAncestors()
```
    Returns:
    the number of TransitionTarget ancestors
  - getAncestor
```
public EnterableState getAncestor(int level)
```
    Get the ancestor of this TransitionTarget at specified level
    
    Parameters:
    level - the level of the ancestor to return, zero being top
    
    Returns:
    the ancestor at specified level
  - getParent
```
public EnterableState getParent()
```
    Get the parent TransitionTarget.
    
    Returns:
    Returns the parent state (null if parent is <scxml> element)
  - setParent
```
protected void setParent(EnterableState parent)
```
    Set the parent EnterableState.
    The parent of a TransitionTarget must be of type EnterableState as a History (as only non-EnterableState) TransitionTarget cannot have children.
    
    Parameters:
    parent - The parent state to set
  - updateDescendantsAncestors
```
protected void updateDescendantsAncestors()
```
    Update TransitionTarget descendants their ancestors
  - isDescendantOf
```
public final boolean isDescendantOf(TransitionTarget context)
```
    Checks whether this transition target (State or Parallel) is a descendant of the transition target context.
    
    Parameters:
    context - TransitionTarget context - a potential ancestor
    
    Returns:
    true if this is a descendant of context, false otherwise
  - equals
```
public final boolean equals(Object other)
```
    Enforce identity equality only
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    other - other object to compare with
    
    Returns:
    this == other
  - hashCode
```
public final int hashCode()
```
    Enforce returning identity based hascode
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    System.identityHashCode(this)

Class TransitionTarget

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TransitionTarget

Method Detail

getObservableId

setObservableId

getId

setId

getNumberOfAncestors

getAncestor

getParent

setParent

updateDescendantsAncestors

isDescendantOf

equals

hashCode