java.lang.Object

cruise.umple.compiler.State

All Implemented Interfaces:: Node

public class State
extends java.lang.Object
implements Node

One of the values in which a state machine can be at any given point in time NEW CLASS****************************************

Constructor Summary

Constructors

Constructor Description

State(java.lang.String aName, StateMachine aStateMachine)

Method Summary

Modifier and Type	Method	Description
`boolean`	`addAction(Action aAction)`
`void`	`addAction(Action newAction, int index)`
`boolean`	`addActionAt(Action aAction, int index)`
`boolean`	`addActivity(Activity aActivity)`
`Activity`	`addActivity(java.lang.String aActivityCode)`
`boolean`	`addActivityAt(Activity aActivity, int index)`
`boolean`	`addNestedStateMachine(StateMachine aNestedStateMachine)`
`boolean`	`addNestedStateMachineAt(StateMachine aNestedStateMachine, int index)`
`Transition`	`addNextTransition(State aFromState)`
`boolean`	`addNextTransition(Transition aNextTransition)`
`boolean`	`addNextTransitionAt(Transition aNextTransition, int index)`
`boolean`	`addOrMoveActionAt(Action aAction, int index)`
`boolean`	`addOrMoveActivityAt(Activity aActivity, int index)`
`boolean`	`addOrMoveNestedStateMachineAt(StateMachine aNestedStateMachine, int index)`
`boolean`	`addOrMoveNextTransitionAt(Transition aNextTransition, int index)`
`boolean`	`addOrMoveStateMachineTraceItemAt(StateMachineTraceItem aStateMachineTraceItem, int index)`
`boolean`	`addOrMoveTransitionAt(Transition aTransition, int index)`
`boolean`	`addStateMachineTraceItem(StateMachineTraceItem aStateMachineTraceItem)`
`boolean`	`addStateMachineTraceItemAt(StateMachineTraceItem aStateMachineTraceItem, int index)`
`Transition`	`addTransition(State aNextState)`
`Transition`	`addTransition(State nextState, int index)`
`boolean`	`addTransition(Transition aTransition)`
`boolean`	`addTransitionAt(Transition aTransition, int index)`
`void`	`clear()`
`State`	`clone(java.util.List<Transition> inTransitions, StateMachine inStateMachine)`
`void`	`delete()`
`boolean`	`deleteTransition(Transition aTransition)`	Issue 519
`StateMachine`	`exitableSelfTransition(State nextState)`
`StateMachine`	`exitableStateMachine(State nextState)`
`Action`	`getAction(int index)`
`java.util.List<Action>`	`getActions()`
`java.util.List<Action>`	`getActionsByType(java.lang.String actionType)`
`java.util.List<Activity>`	`getActivities()`
`Activity`	`getActivity(int index)`
`State`	`getConcurrentParentState()`	Issue 935 A helper function to obtain the concurrent parent state
`State`	`getConcurrentRegion()`	Issue 140 A helper function to obtain the concurrent region
`java.lang.String`	`getDisplayColor()`
`boolean`	`getFinalState()`
`boolean`	`getHasEntryAction()`
`boolean`	`getHasExitAction()`
`boolean`	`getIsConcurrent()`
`boolean`	`getIsDeepHistoryState()`
`boolean`	`getIsHistoryState()`
`boolean`	`getIsInternal()`	for code generation only e.g.
`boolean`	`getIsStartState()`
`boolean`	`getIsVisited()`
`java.lang.String`	`getName()`
`StateMachine`	`getNestedStateMachine(int index)`
`java.util.List<StateMachine>`	`getNestedStateMachines()`
`java.util.List<Transition>`	`getNextTransition()`
`Transition`	`getNextTransition(int index)`
`Position`	`getPosition()`	State mostRecentState; //will be in dot notation, if used by historyState, only look at first part?
`StateMachine`	`getRootStateMachine()`	Issue 1351 A helper function to obtain the root state machine
`StateMachine`	`getStateMachine()`
`StateMachineTraceItem`	`getStateMachineTraceItem(int index)`
`java.util.List<StateMachineTraceItem>`	`getStateMachineTraceItems()`
`StateMachineTraceItem`	`getTrace(java.lang.String method, UmpleClass uClass, Transition t)`
`TraceItem`	`getTraced(java.lang.String method, UmpleClass uClass)`	Retrieve the StateMachineTraceItem associated with this State
`Transition`	`getTransition(int index)`
`java.util.List<Transition>`	`getTransitions()`
`java.util.List<Transition>`	`getTransitionsFor(Event e)`
`java.lang.String`	`getType()`
`boolean`	`hasActions()`
`boolean`	`hasActivities()`
`boolean`	`hasNestedStateMachines()`
`boolean`	`hasNextTransition()`
`boolean`	`hasStateMachineTraceItems()`
`boolean`	`hasTransitions()`
`int`	`indexOfAction(Action aAction)`
`int`	`indexOfActivity(Activity aActivity)`
`int`	`indexOfNestedStateMachine(StateMachine aNestedStateMachine)`
`int`	`indexOfNextTransition(Transition aNextTransition)`
`int`	`indexOfStateMachineTraceItem(StateMachineTraceItem aStateMachineTraceItem)`
`int`	`indexOfTransition(Transition aTransition)`
`boolean`	`isFinalState()`
`boolean`	`isIsConcurrent()`
`boolean`	`isIsDeepHistoryState()`
`boolean`	`isIsHistoryState()`
`boolean`	`isIsInternal()`
`boolean`	`isIsStartState()`
`boolean`	`isIsVisited()`
`boolean`	`isSameState(State state, StateMachine relativeTo)`
`boolean`	`isSubstateOf(State possibleSuperState)`	return true of this is a substate of or same as possibleSuperState
`boolean`	`isVisited()`
`static int`	`minimumNumberOfActions()`
`static int`	`minimumNumberOfActivities()`
`static int`	`minimumNumberOfNestedStateMachines()`
`static int`	`minimumNumberOfNextTransition()`
`static int`	`minimumNumberOfStateMachineTraceItems()`
`static int`	`minimumNumberOfTransitions()`
`java.lang.String`	`newTimedEventName(State toState)`
`int`	`numberOfActions()`
`int`	`numberOfActivities()`
`int`	`numberOfNestedStateMachines()`
`int`	`numberOfNextTransition()`
`int`	`numberOfStateMachineTraceItems()`
`int`	`numberOfTransitions()`
`boolean`	`removeAction(Action aAction)`
`boolean`	`removeActivity(Activity aActivity)`
`boolean`	`removeNestedStateMachine(StateMachine aNestedStateMachine)`
`boolean`	`removeNextTransition(Transition aNextTransition)`
`boolean`	`removeStateMachineTraceItem(StateMachineTraceItem aStateMachineTraceItem)`
`boolean`	`removeTransition(Transition aTransition)`
`boolean`	`setDisplayColor(java.lang.String aDisplayColor)`
`boolean`	`setFinalState(boolean aFinalState)`
`boolean`	`setIsDeepHistoryState(boolean aIsDeepHistoryState)`
`boolean`	`setIsHistoryState(boolean aIsHistoryState)`
`boolean`	`setIsInternal(boolean aIsInternal)`
`boolean`	`setIsStartState(boolean aIsStartState)`
`boolean`	`setIsVisited(boolean aIsVisited)`
`boolean`	`setName(java.lang.String aName)`
`boolean`	`setPosition(Position aPosition)`
`boolean`	`setStateMachine(StateMachine aStateMachine)`
`java.lang.String`	`toString()`
`void`	`visit()`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- State
  
  public State(java.lang.String aName, StateMachine aStateMachine)
Method Details
- setName
  
  public boolean setName(java.lang.String aName)
- setIsStartState
  
  public boolean setIsStartState(boolean aIsStartState)
- setIsInternal
  
  public boolean setIsInternal(boolean aIsInternal)
- setIsHistoryState
  
  public boolean setIsHistoryState(boolean aIsHistoryState)
- setIsDeepHistoryState
  
  public boolean setIsDeepHistoryState(boolean aIsDeepHistoryState)
- setFinalState
  
  public boolean setFinalState(boolean aFinalState)
- setIsVisited
  
  public boolean setIsVisited(boolean aIsVisited)
- setDisplayColor
  
  public boolean setDisplayColor(java.lang.String aDisplayColor)
- setPosition
  
  public boolean setPosition(Position aPosition)
- getName
  
  public java.lang.String getName()
- getIsConcurrent
  
  public boolean getIsConcurrent()
- getIsStartState
  
  public boolean getIsStartState()
- getIsInternal
  
  public boolean getIsInternal()
  
  for code generation only e.g. ouside scope of nested state
- getIsHistoryState
  
  public boolean getIsHistoryState()
- getIsDeepHistoryState
  
  public boolean getIsDeepHistoryState()
- getFinalState
  
  public boolean getFinalState()
- getIsVisited
  
  public boolean getIsVisited()
- getDisplayColor
  
  public java.lang.String getDisplayColor()
- getPosition
  
  public Position getPosition()
  
  State mostRecentState; //will be in dot notation, if used by historyState, only look at first part?
- isIsConcurrent
  
  public boolean isIsConcurrent()
- isIsStartState
  
  public boolean isIsStartState()
- isIsInternal
  
  public boolean isIsInternal()
- isIsHistoryState
  
  public boolean isIsHistoryState()
- isIsDeepHistoryState
  
  public boolean isIsDeepHistoryState()
- isFinalState
  
  public boolean isFinalState()
- isIsVisited
  
  public boolean isIsVisited()
- getActivity
  
  public Activity getActivity(int index)
- getActivities
  
  public java.util.List<Activity> getActivities()
- numberOfActivities
  
  public int numberOfActivities()
- hasActivities
  
  public boolean hasActivities()
- indexOfActivity
  
  public int indexOfActivity(Activity aActivity)
- getAction
  
  public Action getAction(int index)
- getActions
  
  public java.util.List<Action> getActions()
- numberOfActions
  
  public int numberOfActions()
- hasActions
  
  public boolean hasActions()
- indexOfAction
  
  public int indexOfAction(Action aAction)
- getStateMachine
  
  public StateMachine getStateMachine()
- getNestedStateMachine
  
  public StateMachine getNestedStateMachine(int index)
- getNestedStateMachines
  
  public java.util.List<StateMachine> getNestedStateMachines()
- numberOfNestedStateMachines
  
  public int numberOfNestedStateMachines()
- hasNestedStateMachines
  
  public boolean hasNestedStateMachines()
- indexOfNestedStateMachine
  
  public int indexOfNestedStateMachine(StateMachine aNestedStateMachine)
- getTransition
  
  public Transition getTransition(int index)
- getTransitions
  
  public java.util.List<Transition> getTransitions()
- numberOfTransitions
  
  public int numberOfTransitions()
- hasTransitions
  
  public boolean hasTransitions()
- indexOfTransition
  
  public int indexOfTransition(Transition aTransition)
- getNextTransition
  
  public Transition getNextTransition(int index)
- getNextTransition
  
  public java.util.List<Transition> getNextTransition()
- numberOfNextTransition
  
  public int numberOfNextTransition()
- hasNextTransition
  
  public boolean hasNextTransition()
- indexOfNextTransition
  
  public int indexOfNextTransition(Transition aNextTransition)
- getStateMachineTraceItem
  
  public StateMachineTraceItem getStateMachineTraceItem(int index)
- getStateMachineTraceItems
  
  public java.util.List<StateMachineTraceItem> getStateMachineTraceItems()
- numberOfStateMachineTraceItems
  
  public int numberOfStateMachineTraceItems()
- hasStateMachineTraceItems
  
  public boolean hasStateMachineTraceItems()
- indexOfStateMachineTraceItem
  
  public int indexOfStateMachineTraceItem(StateMachineTraceItem aStateMachineTraceItem)
- minimumNumberOfActivities
  
  public static int minimumNumberOfActivities()
- addActivity
  
  public Activity addActivity(java.lang.String aActivityCode)
- addActivity
  
  public boolean addActivity(Activity aActivity)
- removeActivity
  
  public boolean removeActivity(Activity aActivity)
- addActivityAt
  
  public boolean addActivityAt(Activity aActivity, int index)
- addOrMoveActivityAt
  
  public boolean addOrMoveActivityAt(Activity aActivity, int index)
- minimumNumberOfActions
  
  public static int minimumNumberOfActions()
- addAction
  
  public boolean addAction(Action aAction)
- removeAction
  
  public boolean removeAction(Action aAction)
- addActionAt
  
  public boolean addActionAt(Action aAction, int index)
- addOrMoveActionAt
  
  public boolean addOrMoveActionAt(Action aAction, int index)
- setStateMachine
  
  public boolean setStateMachine(StateMachine aStateMachine)
- minimumNumberOfNestedStateMachines
  
  public static int minimumNumberOfNestedStateMachines()
- addNestedStateMachine
  
  public boolean addNestedStateMachine(StateMachine aNestedStateMachine)
- removeNestedStateMachine
  
  public boolean removeNestedStateMachine(StateMachine aNestedStateMachine)
- addNestedStateMachineAt
  
  public boolean addNestedStateMachineAt(StateMachine aNestedStateMachine, int index)
- addOrMoveNestedStateMachineAt
  
  public boolean addOrMoveNestedStateMachineAt(StateMachine aNestedStateMachine, int index)
- minimumNumberOfTransitions
  
  public static int minimumNumberOfTransitions()
- addTransition
  
  public Transition addTransition(State aNextState)
- addTransition
  
  public boolean addTransition(Transition aTransition)
- removeTransition
  
  public boolean removeTransition(Transition aTransition)
- addTransitionAt
  
  public boolean addTransitionAt(Transition aTransition, int index)
- addOrMoveTransitionAt
  
  public boolean addOrMoveTransitionAt(Transition aTransition, int index)
- minimumNumberOfNextTransition
  
  public static int minimumNumberOfNextTransition()
- addNextTransition
  
  public Transition addNextTransition(State aFromState)
- addNextTransition
  
  public boolean addNextTransition(Transition aNextTransition)
- removeNextTransition
  
  public boolean removeNextTransition(Transition aNextTransition)
- addNextTransitionAt
  
  public boolean addNextTransitionAt(Transition aNextTransition, int index)
- addOrMoveNextTransitionAt
  
  public boolean addOrMoveNextTransitionAt(Transition aNextTransition, int index)
- minimumNumberOfStateMachineTraceItems
  
  public static int minimumNumberOfStateMachineTraceItems()
- addStateMachineTraceItem
  
  public boolean addStateMachineTraceItem(StateMachineTraceItem aStateMachineTraceItem)
- removeStateMachineTraceItem
  
  public boolean removeStateMachineTraceItem(StateMachineTraceItem aStateMachineTraceItem)
- addStateMachineTraceItemAt
  
  public boolean addStateMachineTraceItemAt(StateMachineTraceItem aStateMachineTraceItem, int index)
- addOrMoveStateMachineTraceItemAt
  
  public boolean addOrMoveStateMachineTraceItemAt(StateMachineTraceItem aStateMachineTraceItem, int index)
- delete
  
  public void delete()
- isSameState
  
  public boolean isSameState(State state, StateMachine relativeTo)
- isSubstateOf
  
  public boolean isSubstateOf(State possibleSuperState)
  
  return true of this is a substate of or same as possibleSuperState
- deleteTransition
  
  public boolean deleteTransition(Transition aTransition)
  
  Issue 519
- addTransition
  
  public Transition addTransition(State nextState, int index)
- addAction
  
  public void addAction(Action newAction, int index)
- getType
  
  public java.lang.String getType()
- newTimedEventName
  
  public java.lang.String newTimedEventName(State toState)
- getTransitionsFor
  
  public java.util.List<Transition> getTransitionsFor(Event e)
- getHasExitAction
  
  public boolean getHasExitAction()
- getHasEntryAction
  
  public boolean getHasEntryAction()
- getActionsByType
  
  public java.util.List<Action> getActionsByType(java.lang.String actionType)
- exitableStateMachine
  
  public StateMachine exitableStateMachine(State nextState)
- exitableSelfTransition
  
  public StateMachine exitableSelfTransition(State nextState)
- visit
  
  public void visit()
  
  Specified by:
  
  visit in interface Node
- clear
  
  public void clear()
  
  Specified by:
  
  clear in interface Node
- isVisited
  
  public boolean isVisited()
- getConcurrentParentState
  
  public State getConcurrentParentState()
  
  Issue 935 A helper function to obtain the concurrent parent state
- getConcurrentRegion
  
  public State getConcurrentRegion()
  
  Issue 140 A helper function to obtain the concurrent region
- getRootStateMachine
  
  public StateMachine getRootStateMachine()
  
  Issue 1351 A helper function to obtain the root state machine
- getTraced
  
  public TraceItem getTraced(java.lang.String method, UmpleClass uClass)
  
  Retrieve the StateMachineTraceItem associated with this State
  
  Returns:
  
  StateMachine_Traceitem for this UmpleVariable(either association or attribute);
- getTrace
  
  public StateMachineTraceItem getTrace(java.lang.String method, UmpleClass uClass, Transition t)
- clone
  
  public State clone(java.util.List<Transition> inTransitions, StateMachine inStateMachine)
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object

Class State

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Method Details