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

java.lang.Object
  com.ptc.windchill.upgrade.util.fsm.Event

public class Event

extends Object

A StateMachine event which bears an EventType and optionally an event object. Clients do not directly instantiate Events. This is done via StateMachine.dispatchEvent methods.

See Also:

StateMachine.dispatchEvent(EventType), StateMachine.dispatchEvent(EventType,java.lang.Object)

Field Summary

private Object	eventObject_
private EventType	eventType_
private State	sourceState_

Constructor Summary

(package private)

Event(EventType event_type, State source_state, Object event_object)

Method Summary

Object	getEventObject() The object that may have been provided when the event was dispatched on the StateMachine.
EventType	getEventType() The Event's type
State	getSourceState() The StateMachine State from in which the event was dispatched.
String	toString() A simple description of the event.

Methods inherited from class java.lang.Object

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

Field Detail

eventType_

private final EventType eventType_

sourceState_

private final State sourceState_

eventObject_

private final Object eventObject_

Constructor Detail

Event

Event(EventType event_type,
      State source_state,
      Object event_object)

Method Detail

getEventType

public final EventType getEventType()

The Event's type

getSourceState

public final State getSourceState()

The StateMachine State from in which the event was dispatched.

getEventObject

public final Object getEventObject()

The object that may have been provided when the event was dispatched on the StateMachine.

Returns:

possibly null reference value

toString

public String toString()

A simple description of the event.