com.ibm.rational.test.lt.recorder.core.message
Class Message
java.lang.Object
com.ibm.rational.test.lt.recorder.core.message.Message
- All Implemented Interfaces:
- Serializable
- Direct Known Subclasses:
- AnnotationMessage, PreferenceMessage, UserMessage
public abstract class Message
- extends Object
- implements Serializable
A message is a piece of information exchanged by recorder and client delegates,
between themselves, or with external entities of the recording framework. A message
is not interpreted by the recording framework, but is routed by the recording framework
to the appropriate destination(s). This class is meant to be extended, in order to add the
appropriate piece of information transported by the message. Note that all transported
pieces of information must be serializable.
- See Also:
IRecordingSession.sendMessage(Message)
,
IRecordingComponentContext.dispatchMessage(Message)
,
IRecordingSessionListener.messageReceived(Object, Message)
,
IRecorderComponentListener.messageReceived(Object, Message)
,
IRecorderComponentListener.messageReceived(Object, Message)
,
IRecordingComponentDelegate.messageReceived(Message)
,
IRecordingComponentDelegate.messageReceived(Message)
,
Serialized Form
Nested Class Summary |
static class |
Message.Destination
Destination types that can receive messages. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
destination
protected Message.Destination destination
filter
protected List<String> filter
Message
protected Message(Message.Destination destination,
List<String> filter)
- Constructs a new message, to the specified destination.
- Parameters:
destination
- The type of receiver the message should be delivered to.filter
- A list of delegate IDs, or listener class names (depending on the
receiver type) which should receive the message. If null
, no filter
will be applied and the message will be delivered to all receivers of the receiver
type.
Message
protected Message()
getDestination
public final Message.Destination getDestination()
getFilter
public final List<String> getFilter()
getPluginId
public abstract String getPluginId()
- Returns the plugin id (bundle id) that is able to load the implementation class.
This is usually the plugin where the class is defined.
- Returns:
- the plugin id (bundle id) that is able to load the implementation class.
© Copyright IBM Corp. 2012. All rights reserved.