com.ibm.able.conversation
Class JasMessageTransform
java.lang.Object
|
+--com.ibm.able.conversation.JasMessageTransform
- All Implemented Interfaces:
- MessageTransform
- Direct Known Subclasses:
- JasConversationSetupTransform, JasStringLiteralTransform
- public abstract class JasMessageTransform
- extends java.lang.Object
- implements MessageTransform
The JasMessageTransform class is the common base class for MessageTransforms that form & parse
Java Agent Services (JAS) messages.
Method Summary |
java.lang.Object |
getMessage()
Returns the instance of the message object stored in this transform. |
javax.agent.Payload |
getMessagePayload()
|
java.lang.Class |
getMessageType()
Returns the class type of messages this MessageTransform is able to transform. |
void |
setMessage(java.lang.Object msg)
Sets the message object stored in this transform. |
void |
setMessagePayload(javax.agent.Payload newPayload)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
messagePayload
protected javax.agent.Payload messagePayload
JasMessageTransform
protected JasMessageTransform()
getMessagePayload
public javax.agent.Payload getMessagePayload()
setMessagePayload
public void setMessagePayload(javax.agent.Payload newPayload)
getMessageType
public java.lang.Class getMessageType()
- Description copied from interface:
MessageTransform
- Returns the class type of messages this MessageTransform is able to transform.
Note: this implies that, for any particular MessageTransform instance
at any particular time, there is only one such class type. However, it is
still possible that the class type may depend on the MessageDescription for
which this MessageTransform is configured. I.e., in the following fragment, c1
is not necessarily equal to c2
:
Class c1 = someTransform.getMessageClassType();
someTransform.configureFor(someDescription);
Class c2 = someTransform.getMessageClassType();
- Specified by:
getMessageType
in interface MessageTransform
- Following copied from interface:
com.ibm.conversation.MessageTransform
- Returns:
- The Class type of the messages that can be transformed.
getMessage
public final java.lang.Object getMessage()
- Description copied from interface:
MessageTransform
- Returns the instance of the message object stored in this transform.
The message object was either set directly--in anticipation of being
parsed--via setMessage()
, or else was generated from
the stored decision-data via formAndValidate()
.
- Specified by:
getMessage
in interface MessageTransform
setMessage
public final void setMessage(java.lang.Object msg)
- Description copied from interface:
MessageTransform
- Sets the message object stored in this transform.
This prepares this MessageTransform for a call to parseAndValidate()
.
- Specified by:
setMessage
in interface MessageTransform
- Following copied from interface:
com.ibm.conversation.MessageTransform
- Parameters:
msg
- The message object to store.
(C) Copyright IBM Corporation 1999, 2003