org.eclipse.ocl.examples.pivot
Enum PseudostateKind

java.lang.Object
  java.lang.Enum<PseudostateKind>
      org.eclipse.ocl.examples.pivot.PseudostateKind

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PseudostateKind>, org.eclipse.emf.common.util.Enumerator

public enum PseudostateKind
extends java.lang.Enum<PseudostateKind>
implements org.eclipse.emf.common.util.Enumerator

A representation of the literals of the enumeration 'Pseudostate Kind', and utility methods for working with them. PseudostateKind is an enumeration type.

See Also:

PivotPackage.getPseudostateKind()

Generated

Enum Constant Summary

CHOICE
The 'Choice' literal object.

DEEP_HISTORY
The 'Deep History' literal object.

ENTRY_POINT
The 'Entry Point' literal object.

EXIT_POINT
The 'Exit Point' literal object.

FORK
The 'Fork' literal object.

INITIAL
The 'Initial' literal object.

JOIN
The 'Join' literal object.

JUNCTION
The 'Junction' literal object.

SHALLOW_HISTORY
The 'Shallow History' literal object.

TERMINATE
The 'Terminate' literal object.

Field Summary

static int	CHOICE_VALUE The 'Choice' literal value.
static int	DEEP_HISTORY_VALUE The 'Deep History' literal value.
static int	ENTRY_POINT_VALUE The 'Entry Point' literal value.
static int	EXIT_POINT_VALUE The 'Exit Point' literal value.
static int	FORK_VALUE The 'Fork' literal value.
static int	INITIAL_VALUE The 'Initial' literal value.
static int	JOIN_VALUE The 'Join' literal value.
static int	JUNCTION_VALUE The 'Junction' literal value.
static int	SHALLOW_HISTORY_VALUE The 'Shallow History' literal value.
static int	TERMINATE_VALUE The 'Terminate' literal value.
static java.util.List<PseudostateKind>	VALUES A public read-only list of all the 'Pseudostate Kind' enumerators.

Method Summary

static PseudostateKind	get(int value) Returns the 'Pseudostate Kind' literal with the specified integer value.
static PseudostateKind	get(java.lang.String literal) Returns the 'Pseudostate Kind' literal with the specified literal value.
static PseudostateKind	getByName(java.lang.String name) Returns the 'Pseudostate Kind' literal with the specified name.
java.lang.String	getLiteral()
java.lang.String	getName()
int	getValue()
java.lang.String	toString() Returns the literal value of the enumerator, which is its string representation.
static PseudostateKind	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PseudostateKind[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INITIAL

public static final PseudostateKind INITIAL

The 'Initial' literal object.

See Also:

INITIAL_VALUE

Generated

Ordered

DEEP_HISTORY

public static final PseudostateKind DEEP_HISTORY

The 'Deep History' literal object.

See Also:

DEEP_HISTORY_VALUE

Generated

Ordered

SHALLOW_HISTORY

public static final PseudostateKind SHALLOW_HISTORY

The 'Shallow History' literal object.

See Also:

SHALLOW_HISTORY_VALUE

Generated

Ordered

JOIN

public static final PseudostateKind JOIN

The 'Join' literal object.

See Also:

JOIN_VALUE

Generated

Ordered

FORK

public static final PseudostateKind FORK

The 'Fork' literal object.

See Also:

FORK_VALUE

Generated

Ordered

JUNCTION

public static final PseudostateKind JUNCTION

The 'Junction' literal object.

See Also:

JUNCTION_VALUE

Generated

Ordered

CHOICE

public static final PseudostateKind CHOICE

The 'Choice' literal object.

See Also:

CHOICE_VALUE

Generated

Ordered

ENTRY_POINT

public static final PseudostateKind ENTRY_POINT

The 'Entry Point' literal object.

See Also:

ENTRY_POINT_VALUE

Generated

Ordered

EXIT_POINT

public static final PseudostateKind EXIT_POINT

The 'Exit Point' literal object.

See Also:

EXIT_POINT_VALUE

Generated

Ordered

TERMINATE

public static final PseudostateKind TERMINATE

The 'Terminate' literal object.

See Also:

TERMINATE_VALUE

Generated

Ordered

Field Detail

INITIAL_VALUE

public static final int INITIAL_VALUE

The 'Initial' literal value. An initial pseudostate represents a default vertex that is the source for a single transition to the default state of a composite state. There can be at most one initial vertex in a region. The outgoing transition from the initial vertex may have a behavior, but not a trigger or guard.

See Also:

INITIAL, Constant Field Values

Generated

Ordered

DEEP_HISTORY_VALUE

public static final int DEEP_HISTORY_VALUE

The 'Deep History' literal value. DeepHistory represents the most recent active configuration of the composite state that directly contains this pseudostate; e.g. the state configuration that was active when the composite state was last exited. A composite state can have at most one deep history vertex. At most one transition may originate from the history connector to the default deep history state. This transition is taken in case the composite state had never been active before. Entry actions of states entered on the path to the state represented by a deep history are performed.

See Also:

DEEP_HISTORY, Constant Field Values

Generated

Ordered

SHALLOW_HISTORY_VALUE

public static final int SHALLOW_HISTORY_VALUE

The 'Shallow History' literal value. ShallowHistory represents the most recent active substate of its containing state (but not the substates of that substate). A composite state can have at most one shallow history vertex. A transition coming into the shallow history vertex is equivalent to a transition coming into the most recent active substate of a state. At most one transition may originate from the history connector to the default shallow history state. This transition is taken in case the composite state had never been active before. Entry actions of states entered on the path to the state represented by a shallow history are performed.

See Also:

SHALLOW_HISTORY, Constant Field Values

Generated

Ordered

JOIN_VALUE

public static final int JOIN_VALUE

The 'Join' literal value. Join vertices serve to merge several transitions emanating from source vertices in different orthogonal regions. The transitions entering a join vertex cannot have guards or triggers.

See Also:

JOIN, Constant Field Values

Generated

Ordered

FORK_VALUE

public static final int FORK_VALUE

The 'Fork' literal value. Fork vertices serve to split an incoming transition into two or more transitions terminating on orthogonal target vertices (i.e. vertices in different regions of a composite state). The segments outgoing from a fork vertex must not have guards or triggers.

See Also:

FORK, Constant Field Values

Generated

Ordered

JUNCTION_VALUE

public static final int JUNCTION_VALUE

The 'Junction' literal value. Junction vertices are semantic-free vertices that are used to chain together multiple transitions. They are used to construct compound transition paths between states. For example, a junction can be used to converge multiple incoming transitions into a single outgoing transition representing a shared transition path (this is known as an merge). Conversely, they can be used to split an incoming transition into multiple outgoing transition segments with different guard conditions. This realizes a static conditional branch. (In the latter case, outgoing transitions whose guard conditions evaluate to false are disabled. A predefined guard denoted 'else' may be defined for at most one outgoing transition. This transition is enabled if all the guards labeling the other transitions are false.) Static conditional branches are distinct from dynamic conditional branches that are realized by choice vertices (described below).

See Also:

JUNCTION, Constant Field Values

Generated

Ordered

CHOICE_VALUE

public static final int CHOICE_VALUE

The 'Choice' literal value. Choice vertices which, when reached, result in the dynamic evaluation of the guards of the triggers of its outgoing transitions. This realizes a dynamic conditional branch. It allows splitting of transitions into multiple outgoing paths such that the decision on which path to take may be a function of the results of prior actions performed in the same run-tocompletion step. If more than one of the guards evaluates to true, an arbitrary one is selected. If none of the guards evaluates to true, then the model is considered ill-formed. (To avoid this, it is recommended to define one outgoing transition with the predefined else guard for every choice vertex.) Choice vertices should be distinguished from static branch points that are based on junction points (described above).

See Also:

CHOICE, Constant Field Values

Generated

Ordered

ENTRY_POINT_VALUE

public static final int ENTRY_POINT_VALUE

The 'Entry Point' literal value. An entry point pseudostate is an entry point of a state machine or composite state. In each region of the state machine or composite state it has a single transition to a vertex within the same region.

See Also:

ENTRY_POINT, Constant Field Values

Generated

Ordered

EXIT_POINT_VALUE

public static final int EXIT_POINT_VALUE

The 'Exit Point' literal value. An exit point pseudostate is an exit point of a state machine or composite state. Entering an exit point within any region of the composite state or state machine referenced by a submachine state implies the exit of this composite state or submachine state and the triggering of the transition that has this exit point as source in the state machine enclosing the submachine or composite state.

See Also:

EXIT_POINT, Constant Field Values

Generated

Ordered

TERMINATE_VALUE

public static final int TERMINATE_VALUE

The 'Terminate' literal value. Entering a terminate pseudostate implies that the execution of this state machine by means of its context object is terminated. The state machine does not exit any states nor does it perform any exit actions other than those associated with the transition leading to the terminate pseudostate. Entering a terminate pseudostate is equivalent to invoking a DestroyObjectAction.

See Also:

TERMINATE, Constant Field Values

Generated

Ordered

VALUES

public static final java.util.List<PseudostateKind> VALUES

A public read-only list of all the 'Pseudostate Kind' enumerators.

Generated

Method Detail

values

public static PseudostateKind[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PseudostateKind c : PseudostateKind.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PseudostateKind valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

get

public static PseudostateKind get(java.lang.String literal)

Returns the 'Pseudostate Kind' literal with the specified literal value.

Generated

getByName

public static PseudostateKind getByName(java.lang.String name)

Returns the 'Pseudostate Kind' literal with the specified name.

Generated

get

public static PseudostateKind get(int value)

Returns the 'Pseudostate Kind' literal with the specified integer value.

Generated

getValue

public int getValue()

Specified by:

getValue in interface org.eclipse.emf.common.util.Enumerator

Generated

getName

public java.lang.String getName()

Specified by:

getName in interface org.eclipse.emf.common.util.Enumerator

Generated

getLiteral

public java.lang.String getLiteral()

Specified by:

getLiteral in interface org.eclipse.emf.common.util.Enumerator

Generated

toString

public java.lang.String toString()

Returns the literal value of the enumerator, which is its string representation.

Overrides:

toString in class java.lang.Enum<PseudostateKind>

Generated