ptolemy.actor
Class FiringEvent.FiringEventType

java.lang.Object
  ptolemy.actor.FiringEvent.FiringEventType

Enclosing class:

FiringEvent

public static class FiringEvent.FiringEventType
extends java.lang.Object

A type of firing event that can be published. This class implements a type-safe enumeration. The constructor is private so that the only admissible event types are the static members of the FiringEvent class.

Field Summary

private boolean	_isStart
private java.lang.String	_name

Constructor Summary

private

FiringEvent.FiringEventType(java.lang.String name, boolean isStart) Create a new event type with the given name.

Method Summary

java.lang.String	getName() Return the string name of this event type.
java.lang.String	getTypeName() Return the name of this event type.
boolean	isStart() Return true if this event corresponds with a start event.
java.lang.String	toString() Return a string description of this event type.

Methods inherited from class java.lang.Object

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

Field Detail

_name

private java.lang.String _name

_isStart

private boolean _isStart

Constructor Detail

FiringEvent.FiringEventType

private FiringEvent.FiringEventType(java.lang.String name,
                                    boolean isStart)

Create a new event type with the given name.

Parameters:

name - The name of this event type.

isStart - true if this event type is a start event, false if it is an end event.

Method Detail

getName

public java.lang.String getName()

Return the string name of this event type.

Returns:

the string name of this event type.

toString

public java.lang.String toString()

Return a string description of this event type.

Overrides:

toString in class java.lang.Object

Returns:

a string description of this event type.

isStart

public boolean isStart()

Return true if this event corresponds with a start event.

Returns:

true if this event corresponds with a start event.

getTypeName

public java.lang.String getTypeName()

Return the name of this event type.

Returns:

the name of this event type.