org.eclipse.actf.model.event
Class ModelEventType

java.lang.Object
  extended by org.eclipse.actf.model.event.ModelEventType

public class ModelEventType
extends Object

represents an event type that can be fired within a model

Author:
Constructor Summary
ModelEventType(String eventName, Object eventId, Class sourceType)
          create a model event type to represent an event type for a given model.
ModelEventType(String eventName, Object eventId, Class sourceType, Class eventType)
          create a model event type to represent an event type for a given model.
 
Method Summary
 Object getEventId()
          return unique event id or type within model framework.
 String getEventName()
          return the printable or symbolic name of the event
 Class getEventType()
          return the type of the event
 Class getSourceType()
          return the type of objects that can fire this event
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ModelEventType

public ModelEventType(String eventName,
                      Object eventId,
                      Class sourceType)
create a model event type to represent an event type for a given model. Event types represent events that can be fired within a model and are typically identified by unique ids within the model's API.

Parameters:
eventName - symbolic or printable name of event
eventId - unique event id or type within the model public ModelEventType (String eventName, Object eventId) { this(eventName, eventId, null, null); } /** create a model event type to represent an event type for a given model. Event types represent events that can be fired within a model and are typically identified by unique ids within the model's API.
eventName - symbolic or printable name of event
eventId - unique event id or type within the model
sourceType - type of object that can fire this event

ModelEventType

public ModelEventType(String eventName,
                      Object eventId,
                      Class sourceType,
                      Class eventType)
create a model event type to represent an event type for a given model. Event types represent events that can be fired within a model and are typically identified by unique ids within the model's API.

Parameters:
eventName - symbolic or printable name of event
eventId - unique event id or type within the model
sourceType - type of object that can fire this event
eventType - type of event fired by the object, which must inherit from java.util.EventObject
Method Detail

getEventName

public String getEventName()
return the printable or symbolic name of the event

Returns:
symbolic or printable name of event

getEventId

public Object getEventId()
return unique event id or type within model framework. This is uaually part of the published API for the model.

Returns:
unique id of event within the model framework

getSourceType

public Class getSourceType()
return the type of objects that can fire this event

Returns:
type of object that fires this event in the model

getEventType

public Class getEventType()
return the type of the event

Returns:
type of the event