com.ptc.windchill.upgrade.util.fsm
Class StopStateDefinition

java.lang.Object
  com.ptc.windchill.upgrade.util.fsm.StateDefinition
      com.ptc.windchill.upgrade.util.fsm.StopStateDefinition

public final class StopStateDefinition

extends StateDefinition

A StateDefinition for stop states. Note that stop states are only used as termination points for state machines. No events handlers may be registered on stop states.

A StateMachineDefinition may have several StopStates. However, instantiation is done by telling the StateMachineDefinition constructor how many stop states are needed. The StopStateDefinitions will be numbered within the StateMachineDefinition to distinguish them from eachother.

See Also:

StateMachineDefinition, StateMachineDefinition.getStopStateDefinitions()

Nested Class Summary

static class

StopStateDefinition.StopState An out-of-the-box state class used for all state machine stop states.

Field Summary

private int

index_

Fields inherited from class com.ptc.windchill.upgrade.util.fsm.StateDefinition

stateInstantiator_

Constructor Summary

(package private)

StopStateDefinition(int index)

Method Summary

int	getIndex() The StopStateDefinition's number within the containing StateMachineDefinition.
String	toString() Provides a simple description including the stop state definition's index within the StateMachineDefinition.

Methods inherited from class com.ptc.windchill.upgrade.util.fsm.StateDefinition

createStateInstance, describe, getEventTypes, handleEvent, isEventTypeEnabled, registerHandler

Methods inherited from class java.lang.Object

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

Field Detail

index_

private int index_

Constructor Detail

StopStateDefinition

StopStateDefinition(int index)

Method Detail

getIndex

public int getIndex()

The StopStateDefinition's number within the containing StateMachineDefinition.

Returns:

a integer >= 0

toString

public String toString()

Provides a simple description including the stop state definition's index within the StateMachineDefinition.

See Also:

StateMachineDefinition