javax::jms::TextMessage Class Reference

A TextMessage object is used to send a message containing a java.lang.String. More...

#include <javax_jms_TextMessage.h>

Inheritance diagram for javax::jms::TextMessage:

[legend]Collaboration diagram for javax::jms::TextMessage:

[legend]List of all members.

Public Types
enum	{   xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9,   xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::javax::jms::TextMessage >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::javax::jms::TextMessage > >	array2D
Public Member Functions
virtual ::java::lang::String	getText (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the string containing this message's data.
virtual void	setText (const ::java::lang::String &string,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Sets the string containing this message's data.

---

Detailed Description

A TextMessage object is used to send a message containing a java.lang.String.

It inherits from the Message interface and adds a text message body.

This message type can be used to transport text-based messages, including those with XML content.

When a client receives a TextMessage, it is in read-only mode. If a client attempts to write to the message at this point, a MessageNotWriteableException is thrown. If clearBody is called, the message can now be both read from and written to.

Author:

Mark Hapner

Rich Burridge

Kate Stout

---

Member Function Documentation

virtual ::java::lang::String javax::jms::TextMessage::getText (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets the string containing this message's data. The default value is null. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the String containing the message's data

virtual void javax::jms::TextMessage::setText (  const ::java::lang::String &  string, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Sets the string containing this message's data. Parameters: string  the String containing the message's data p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

---

The documentation for this class was generated from the following file:

• javax_jms_TextMessage.h

---