Visit Platform at http://www.platform.com

Platform Symphony 4.1 Java API Reference

com.platform.symphony.soam
Class DefaultTextMessage

java.lang.Object
  extended by com.platform.symphony.soam.Message
      extended by com.platform.symphony.soam.DefaultTextMessage

public class DefaultTextMessage
extends Message

This represents a default implementation for developers requiring a convenient way to submit text messages without creating their own implementation. This object is not thread safe, therefore the developer is responsible for any synchronization required. This message can be used in applications that have a "cross-platform" implementation. (i.e. client and service may be implemented in different supported languages)

See Also:
Message

Constructor Summary
DefaultTextMessage()
          Default constructor for the default text message.
DefaultTextMessage(java.lang.String text)
          Additional constructor for the default text message.
 
Method Summary
 java.lang.String getText()
          This method allows the developer to retrieve the text from the message.
 void onDeserialize(InputStream stream)
          \brief This method will be called during de-serialization of the message.
 void onSerialize(OutputStream stream)
          \brief This method will be called during serialization of the message.
 void setText(java.lang.String text)
          This method allows the developer to set the text within the message.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultTextMessage

public DefaultTextMessage()
Default constructor for the default text message.


DefaultTextMessage

public DefaultTextMessage(java.lang.String text)
Additional constructor for the default text message. the parameters exposed are exactly the same exposed by setText().

See Also:
setText(String)
Method Detail

onSerialize

public void onSerialize(OutputStream stream)
                 throws SoamException
\brief This method will be called during serialization of the message.

Specified by:
onSerialize in class Message
Parameters:
stream - The stream to which the object is being serialized.
Throws:
SoamException

onDeserialize

public void onDeserialize(InputStream stream)
                   throws SoamException
\brief This method will be called during de-serialization of the message.

Specified by:
onDeserialize in class Message
Parameters:
stream - The stream from which the object is being de-serialized.
Throws:
SoamException

setText

public void setText(java.lang.String text)
This method allows the developer to set the text within the message.

Parameters:
text - The text message to be associated with the DefaultTextMessage.

getText

public java.lang.String getText()
This method allows the developer to retrieve the text from the message.

Returns:
The text.

Version 4.1
Date Modified: -DREL_DATE=Nov 03 2008
Platform Computing. Accelerating Intelligence(TM).
Copyright (C) 2001-2008 Platform Computing Corporation. All rights reserved.