Main Page | Modules | Class Hierarchy | Class List | Directories | File List | Class Members | Related Pages
javax::jms::StreamMessage

javax::jms::StreamMessage Class Reference

A StreamMessage object is used to send a stream of primitive types in the Java programming language. More...

#include <javax_jms_StreamMessage.h>

Inheritance diagram for javax::jms::StreamMessage:

Inheritance graph
[legend]
Collaboration diagram for javax::jms::StreamMessage:

Collaboration graph
[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::StreamMessage > 		array1D
typedef ::xmog_java_array_template<
::xmog_java_array_template<
::javax::jms::StreamMessage > > 		array2D

Public Member Functions

virtual bool readBoolean (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Reads a boolean from the stream message.
virtual jbyte readByte (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Reads a byte value from the stream message.
virtual jint readBytes (const ::xmog_java_byte_array &value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Reads a byte array field from the stream message into the specified byte[] object (the read buffer).
virtual jchar readChar (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Reads a Unicode character value from the stream message.
virtual jdouble readDouble (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Reads a double from the stream message.
virtual jfloat readFloat (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Reads a float from the stream message.
virtual jint readInt (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Reads a 32-bit integer from the stream message.
virtual jlong readLong (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Reads a 64-bit integer from the stream message.
virtual ::java::lang::Object readObject (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Reads an object from the stream message.
virtual jshort readShort (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Reads a 16-bit integer from the stream message.
virtual ::java::lang::String readString (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Reads a String from the stream message.
virtual void reset (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Puts the message body in read-only mode and repositions the stream to the beginning.
virtual void writeBoolean (bool value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Writes a boolean to the stream message.
virtual void writeByte (jbyte value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Writes a byte to the stream message.
virtual void writeBytes (const ::xmog_java_byte_array &value, jint offset, jint length,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Writes a portion of a byte array as a byte array field to the stream message.
virtual void writeBytes (const ::xmog_java_byte_array &value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Writes a byte array field to the stream message.
virtual void writeChar (jchar value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Writes a char to the stream message.
virtual void writeDouble (jdouble value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Writes a double to the stream message.
virtual void writeFloat (jfloat value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Writes a float to the stream message.
virtual void writeInt (jint value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Writes an int to the stream message.
virtual void writeLong (jlong value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Writes a long to the stream message.
virtual void writeObject (const ::java::lang::Object &value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Writes an object to the stream message.
virtual void writeShort (jshort value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Writes a short to the stream message.
virtual void writeString (const ::java::lang::String &value,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
 Writes a String to the stream message.

Detailed Description

A StreamMessage object is used to send a stream of primitive types in the Java programming language.

It is filled and read sequentially. It inherits from the Message interface and adds a stream message body. Its methods are based largely on those found in java.io.DataInputStream and java.io.DataOutputStream.

The primitive types can be read or written explicitly using methods for each type. They may also be read or written generically as objects. For instance, a call to StreamMessage.writeInt(6) is equivalent to StreamMessage.writeObject(new Integer(6)). Both forms are provided, because the explicit form is convenient for static programming, and the object form is needed when types are not known at compile time.

When the message is first created, and when clearBody is called, the body of the message is in write-only mode. After the first call to reset has been made, the message body is in read-only mode. After a message has been sent, the client that sent it can retain and modify it without affecting the message that has been sent. The same message object can be sent multiple times. When a message has been received, the provider has called reset so that the message body is in read-only mode for the client.

If clearBody is called on a message in read-only mode, the message body is cleared and the message body is in write-only mode.

If a client attempts to read a message in write-only mode, a MessageNotReadableException is thrown.

If a client attempts to write a message in read-only mode, a MessageNotWriteableException is thrown.

StreamMessage objects support the following conversion table. The marked cases must be supported. The unmarked cases must throw a JMSException. The String-to-primitive conversions may throw a runtime exception if the primitive's valueOf() method does not accept it as a valid String representation of the primitive.

A value written as the row type can be read as the column type.

             |        | boolean byte short char int long float double String byte[]
             |----------------------------------------------------------------------
             |boolean |    X                                            X
             |byte    |          X     X         X   X                  X   
             |short   |                X         X   X                  X   
             |char    |                     X                           X
             |int     |                          X   X                  X   
             |long    |                              X                  X   
             |float   |                                    X     X      X   
             |double  |                                          X      X   
             |String  |    X     X     X         X   X     X     X      X   
             |byte[]  |                                                        X
             |----------------------------------------------------------------------

Attempting to read a null value as a primitive type must be treated as calling the primitive's corresponding valueOf(String) conversion method with a null value. Since char does not support a String conversion, attempting to read a null value as a char must throw a NullPointerException.

Author:
Mark Hapner

Rich Burridge

Member Function Documentation

virtual bool javax::jms::StreamMessage::readBoolean (  ::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Reads a boolean from the stream message.

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 boolean value read

virtual jbyte javax::jms::StreamMessage::readByte (  ::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Reads a byte value from the stream message.

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 next byte from the stream message as a 8-bit byte

virtual jint javax::jms::StreamMessage::readBytes (  const ::xmog_java_byte_array &  value,
::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Reads a byte array field from the stream message into the specified byte[] object (the read buffer).

To read the field value, readBytes should be successively called until it returns a value less than the length of the read buffer. The value of the bytes in the buffer following the last byte read is undefined.

If readBytes returns a value equal to the length of the buffer, a subsequent readBytes call must be made. If there are no more bytes to be read, this call returns -1.

If the byte array field value is null, readBytes returns -1.

If the byte array field value is empty, readBytes returns 0.

Once the first readBytes call on a byte[] field value has been made, the full value of the field must be read before it is valid to read the next field. An attempt to read the next field before that has been done will throw a MessageFormatException.

To read the byte field value into a new byte[] object, use the readObject method.

Parameters:
value the buffer into which the data is read
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 total number of bytes read into the buffer, or -1 if there is no more data because the end of the byte field has been reached

virtual jchar javax::jms::StreamMessage::readChar (  ::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Reads a Unicode character value from the stream message.

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:
a Unicode character from the stream message

virtual jdouble javax::jms::StreamMessage::readDouble (  ::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Reads a double from the stream message.

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:
a double value from the stream message

virtual jfloat javax::jms::StreamMessage::readFloat (  ::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Reads a float from the stream message.

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:
a float value from the stream message

virtual jint javax::jms::StreamMessage::readInt (  ::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Reads a 32-bit integer from the stream message.

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:
a 32-bit integer value from the stream message, interpreted as an int

virtual jlong javax::jms::StreamMessage::readLong (  ::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Reads a 64-bit integer from the stream message.

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:
a 64-bit integer value from the stream message, interpreted as a long

virtual ::java::lang::Object javax::jms::StreamMessage::readObject (  ::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
) 
 

Reads an object from the stream message.

This method can be used to return, in objectified format, an object in the Java programming language ("Java object") that has been written to the stream with the equivalent writeObject method call, or its equivalent primitive writetype method.

Note that byte values are returned as byte[], not Byte[].

An attempt to call readObject to read a byte field value into a new byte[] object before the full value of the byte field has been read will throw a MessageFormatException.

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:
a Java object from the stream message, in objectified format (for example, if the object was written as an int, an Integer is returned)

virtual jshort javax::jms::StreamMessage::readShort (  ::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Reads a 16-bit integer from the stream message.

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:
a 16-bit integer from the stream message

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

Reads a String from the stream message.

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:
a Unicode string from the stream message

virtual void javax::jms::StreamMessage::reset (  ::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Puts the message body in read-only mode and repositions the stream to the beginning.

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:

virtual void javax::jms::StreamMessage::writeBoolean (  bool  value,
::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Writes a boolean to the stream message.

The value true is written as the value (byte)1; the value false is written as the value (byte)0.

Parameters:
value the boolean value to be written
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:

virtual void javax::jms::StreamMessage::writeByte (  jbyte  value,
::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Writes a byte to the stream message.

Parameters:
value the byte value to be written
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:

virtual void javax::jms::StreamMessage::writeBytes (  const ::xmog_java_byte_array &  value,
jint  offset,
jint  length,
::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Writes a portion of a byte array as a byte array field to the stream message.

The a portion of the byte array value is written to the message as a byte array field. Consecutively written byte array fields are treated as two distinct fields when the fields are read.

Parameters:
value the byte array value to be written
offset the initial offset within the byte array
length the number of bytes to use
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:

virtual void javax::jms::StreamMessage::writeBytes (  const ::xmog_java_byte_array &  value,
::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Writes a byte array field to the stream message.

The byte array value is written to the message as a byte array field. Consecutively written byte array fields are treated as two distinct fields when the fields are read.

Parameters:
value the byte array value to be written
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:

virtual void javax::jms::StreamMessage::writeChar (  jchar  value,
::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Writes a char to the stream message.

Parameters:
value the char value to be written
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:

virtual void javax::jms::StreamMessage::writeDouble (  jdouble  value,
::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Writes a double to the stream message.

Parameters:
value the double value to be written
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:

virtual void javax::jms::StreamMessage::writeFloat (  jfloat  value,
::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Writes a float to the stream message.

Parameters:
value the float value to be written
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:

virtual void javax::jms::StreamMessage::writeInt (  jint  value,
::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Writes an int to the stream message.

Parameters:
value the int value to be written
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:

virtual void javax::jms::StreamMessage::writeLong (  jlong  value,
::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Writes a long to the stream message.

Parameters:
value the long value to be written
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:

virtual void javax::jms::StreamMessage::writeObject (  const ::java::lang::Object &  value,
::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Writes an object to the stream message.

This method works only for the objectified primitive object types (Integer, Double, Long ...), String objects, and byte arrays.

Parameters:
value the Java object to be written
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:

virtual void javax::jms::StreamMessage::writeShort (  jshort  value,
::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Writes a short to the stream message.

Parameters:
value the short value to be written
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:

virtual void javax::jms::StreamMessage::writeString (  const ::java::lang::String &  value,
::xmog_localenv *  p_xenv = NULL,
xmog_flags  f_xflags = xmogDefaultFlags
)  [virtual]
 

Writes a String to the stream message.

Parameters:
value the String value to be written
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:
Generated on Fri Jun 16 10:20:00 2006 for JMS Courier for C++ by  doxygen 1.4.1