ca.uqac.lif.ecp.statechart

Class NestedState<T extends Event>

java.lang.Object

ca.uqac.lif.ecp.statechart.State<T>

ca.uqac.lif.ecp.statechart.NestedState<T>

public class NestedState<T extends Event>
extends State<T>

A state that encloses multiple statecharts. Graphically, it is represented as a box that contains other states and transitions. If the nested state contains multiple statecharts, these are interpreted as orthogonal regions.

Author:

Sylvain Hallé

Field Summary

Fields

Modifier and Type	Field and Description
protected Statechart<T>	m_parent The statechart that contains this nested state

Fields inherited from class ca.uqac.lif.ecp.statechart.State

m_id, m_name, s_counterLock, s_idCounter

Constructor Summary

Constructors

Modifier	Constructor and Description
	NestedState(java.lang.String name) Creates a new box state with a given name
protected	NestedState(java.lang.String name, int id) Creates a new box state with a given name and a predefined ID
	NestedState(java.lang.String name, Statechart<T>... s) Creates a new box state with a given name and enclosed statechart

Method Summary

Modifier and Type	Method and Description
NestedState<T>	addStatechart(Statechart<T> s) Sets the enclosed statechart that this box state contains
NestedState<T>	clone(Statechart<T> parent)
State<T>	getAnyAtomicChild() Returns an arbitrary state inside this nested state that is not a NestedState.
java.util.List<Statechart<T>>	getContents() Gets the statecharts contained within this nested state
void	reset() Resets this state
NestedState<T>	setParent(Statechart<T> statechart) Sets the parent of this nested state.

Methods inherited from class ca.uqac.lif.ecp.statechart.State

equals, getId, getName, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

m_parent

protected Statechart<T extends Event> m_parent

The statechart that contains this nested state

Constructor Detail

NestedState

public NestedState(java.lang.String name)

Creates a new box state with a given name

Parameters:

name - The name

NestedState

protected NestedState(java.lang.String name,
                      int id)

Creates a new box state with a given name and a predefined ID

Parameters:

name - The name

id - The ID

NestedState

public NestedState(java.lang.String name,
                   Statechart<T>... s)

Creates a new box state with a given name and enclosed statechart

Parameters:

name - The name

s - The statecharts

Method Detail

addStatechart

public NestedState<T> addStatechart(Statechart<T> s)

Sets the enclosed statechart that this box state contains

Parameters:

s - The statechart

Returns:

This nested state

setParent

public NestedState<T> setParent(Statechart<T> statechart)

Sets the parent of this nested state. The parent is the statechart that contains the nested state.

Parameters:

statechart - The parent

Returns:

This nested state

reset

public void reset()

Description copied from class: State

Resets this state

Overrides:

reset in class State<T extends Event>

clone

public NestedState<T> clone(Statechart<T> parent)

Overrides:

clone in class State<T extends Event>

getContents

public java.util.List<Statechart<T>> getContents()

Gets the statecharts contained within this nested state

Returns:

The list of statecharts

getAnyAtomicChild

public State<T> getAnyAtomicChild()

Returns an arbitrary state inside this nested state that is not a NestedState. The method recurses inside statecharts. This method is mostly used for the graphical rendering of a statechart.

Returns:

A state, or null if no such state exists