javax::jms::ObjectMessage Class Reference

An ObjectMessage object is used to send a message that contains a serializable object in the Java programming language ("Java object"). More...

#include <javax_jms_ObjectMessage.h>

Inheritance diagram for javax::jms::ObjectMessage:

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

[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::ObjectMessage >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::javax::jms::ObjectMessage > >	array2D
Public Member Functions
virtual ::java::io::Serializable	getObject (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the serializable object containing this message's data.
virtual void	setObject (const ::java::io::Serializable &object,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Sets the serializable object containing this message's data.

---

Detailed Description

An ObjectMessage object is used to send a message that contains a serializable object in the Java programming language ("Java object").

It inherits from the Message interface and adds a body containing a single reference to an object. Only Serializable Java objects can be used.

If a collection of Java objects must be sent, one of the Collection classes provided since JDK 1.2 can be used.

When a client receives an ObjectMessage, 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

---

Member Function Documentation

virtual ::java::io::Serializable javax::jms::ObjectMessage::getObject (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets the serializable object 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 serializable object containing this message's data

virtual void javax::jms::ObjectMessage::setObject (  const ::java::io::Serializable &  object, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Sets the serializable object containing this message's data. It is important to note that an ObjectMessage contains a snapshot of the object at the time setObject() is called; subsequent modifications of the object will have no effect on the ObjectMessage body. Parameters: object  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_ObjectMessage.h

---