org.huihoo.jfox.ms.jms.message
Class StreamMessageImpl

java.lang.Object
  org.huihoo.jfox.ms.jms.message.MessageImpl
      org.huihoo.jfox.ms.jms.message.StreamMessageImpl

All Implemented Interfaces:

javax.jms.Message, java.io.Serializable, javax.jms.StreamMessage

public class StreamMessageImpl

extends MessageImpl

implements javax.jms.StreamMessage, java.io.Serializable

A BytesMessage object is used to send a message containing a stream of uninterpreted bytes. It inherits from the Message interface and adds a bytes message body. The receiver of the message supplies the interpretation of the bytes.

Version:

Revision: 1.1 Date: 2002-12-08 22:46:11

Author:

Peter.Cheng

See Also:

Serialized Form

Field Summary

static byte	TYPE_BOOLEAN
static byte	TYPE_BYTE
static byte	TYPE_BYTE_ARRAY
static byte	TYPE_CHAR
static byte	TYPE_DOUBLE
static byte	TYPE_FLOAT
static byte	TYPE_INT
static byte	TYPE_LONG
static byte	TYPE_NULL
static byte	TYPE_SHORT
static byte	TYPE_STRING

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

StreamMessageImpl()
Default constructor.

Method Summary

void	clearBody() Sets the object reference in the message to null and sets the message to modifiable.
boolean	readBoolean() Reads a boolean from the stream message.
byte	readByte() Reads a byte value from the stream message.
int	readBytes(byte[] value) Reads a byte array field from the stream message into the specified byte[] object (the read buffer).
char	readChar() Reads a Unicode character value from the stream message.
double	readDouble() Reads a double from the stream message.
float	readFloat() Reads a float from the stream message.
int	readInt() Reads a 32-bit integer from the stream message.
long	readLong() Reads a 64-bit integer from the stream message.
java.lang.Object	readObject() Reads an object from the stream message.
short	readShort() Reads a 16-bit integer from the stream message.
java.lang.String	readString() Reads a String from the stream message.
void	reset()
void	writeBoolean(boolean value) Writes a boolean to the stream message.
void	writeByte(byte value) Writes a byte to the stream message.
void	writeBytes(byte[] value) Writes a byte array field to the stream message.
void	writeBytes(byte[] value, int offset, int length) Writes a portion of a byte array as a byte array field to the stream message.
void	writeChar(char value) Writes a char to the stream message.
void	writeDouble(double value) Writes a double to the stream message.
void	writeFloat(float value) Writes a float to the stream message.
void	writeInt(int value) Writes an int to the stream message.
void	writeLong(long value) Writes a long to the stream message.
void	writeObject(java.lang.Object value) Writes an object to the stream message.
void	writeShort(short value) Writes a short to the stream message.
void	writeString(java.lang.String value) Writes a String to the stream message.

Methods inherited from class org.huihoo.jfox.ms.jms.message.MessageImpl

acknowledge, clearProperties, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, isBodyModifiable, isPropertiesModifiable, propertyExists, setBodyModifiable, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setPropertiesModifiable, setShortProperty, setStringProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.jms.Message

acknowledge, clearProperties, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty

Field Detail

TYPE_NULL

public static final byte TYPE_NULL

See Also:

Constant Field Values

TYPE_BOOLEAN

public static final byte TYPE_BOOLEAN

See Also:

Constant Field Values

TYPE_BYTE

public static final byte TYPE_BYTE

See Also:

Constant Field Values

TYPE_BYTE_ARRAY

public static final byte TYPE_BYTE_ARRAY

See Also:

Constant Field Values

TYPE_SHORT

public static final byte TYPE_SHORT

See Also:

Constant Field Values

TYPE_CHAR

public static final byte TYPE_CHAR

See Also:

Constant Field Values

TYPE_INT

public static final byte TYPE_INT

See Also:

Constant Field Values

TYPE_LONG

public static final byte TYPE_LONG

See Also:

Constant Field Values

TYPE_FLOAT

public static final byte TYPE_FLOAT

See Also:

Constant Field Values

TYPE_DOUBLE

public static final byte TYPE_DOUBLE

See Also:

Constant Field Values

TYPE_STRING

public static final byte TYPE_STRING

See Also:

Constant Field Values

Constructor Detail

StreamMessageImpl

public StreamMessageImpl()

Default constructor.

Method Detail

readBoolean

public boolean readBoolean()
                    throws javax.jms.JMSException

Reads a boolean from the stream message.

Specified by:

readBoolean in interface javax.jms.StreamMessage

Returns:

the boolean value read

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

See Also:

StreamMessage.readBoolean()

readByte

public byte readByte()
              throws javax.jms.JMSException

Reads a byte value from the stream message.

Specified by:

readByte in interface javax.jms.StreamMessage

Returns:

the next byte from the stream message as a 8-bit byte

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

See Also:

StreamMessage.readByte()

readShort

public short readShort()
                throws javax.jms.JMSException

Reads a 16-bit integer from the stream message.

Specified by:

readShort in interface javax.jms.StreamMessage

Returns:

a 16-bit integer from the stream message

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

See Also:

StreamMessage.readShort()

readChar

public char readChar()
              throws javax.jms.JMSException

Reads a Unicode character value from the stream message.

Specified by:

readChar in interface javax.jms.StreamMessage

Returns:

a Unicode character from the stream message

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid

javax.jms.MessageNotReadableException - if the message is in write-only mode.

See Also:

StreamMessage.readChar()

readInt

public int readInt()
            throws javax.jms.JMSException

Reads a 32-bit integer from the stream message.

Specified by:

readInt in interface javax.jms.StreamMessage

Returns:

a 32-bit integer value from the stream message, interpreted as an int

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

See Also:

StreamMessage.readInt()

readLong

public long readLong()
              throws javax.jms.JMSException

Reads a 64-bit integer from the stream message.

Specified by:

readLong in interface javax.jms.StreamMessage

Returns:

a 64-bit integer value from the stream message, interpreted as a long

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

See Also:

StreamMessage.readLong()

readFloat

public float readFloat()
                throws javax.jms.JMSException

Reads a float from the stream message.

Specified by:

readFloat in interface javax.jms.StreamMessage

Returns:

a float value from the stream message

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

See Also:

StreamMessage.readFloat()

readDouble

public double readDouble()
                  throws javax.jms.JMSException

Reads a double from the stream message.

Specified by:

readDouble in interface javax.jms.StreamMessage

Returns:

a double value from the stream message

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

See Also:

StreamMessage.readDouble()

readString

public java.lang.String readString()
                            throws javax.jms.JMSException

Reads a String from the stream message.

Specified by:

readString in interface javax.jms.StreamMessage

Returns:

a Unicode string from the stream message

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

See Also:

StreamMessage.readString()

readBytes

public int readBytes(byte[] value)
              throws javax.jms.JMSException

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.

Specified by:

readBytes in interface javax.jms.StreamMessage

Parameters:

value - the buffer into which the data is read

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

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

See Also:

readObject(), StreamMessage.readBytes(byte[])

readObject

public java.lang.Object readObject()
                            throws javax.jms.JMSException

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 write type 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 .

Specified by:

readObject in interface javax.jms.StreamMessage

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)

Throws:

javax.jms.JMSException - if the JMS provider fails to read the message due to some internal error.

javax.jms.MessageEOFException - if unexpected end of message stream has been reached.

javax.jms.MessageFormatException - if this type conversion is invalid.

javax.jms.MessageNotReadableException - if the message is in write-only mode.

See Also:

readBytes(byte[] value), StreamMessage.readObject()

writeBoolean

public void writeBoolean(boolean value)
                  throws javax.jms.JMSException

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.

Specified by:

writeBoolean in interface javax.jms.StreamMessage

Parameters:

value - the boolean value to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

See Also:

StreamMessage.writeBoolean(boolean)

writeByte

public void writeByte(byte value)
               throws javax.jms.JMSException

Writes a byte to the stream message.

Specified by:

writeByte in interface javax.jms.StreamMessage

Parameters:

value - the byte value to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

See Also:

StreamMessage.writeByte(byte)

writeShort

public void writeShort(short value)
                throws javax.jms.JMSException

Writes a short to the stream message.

Specified by:

writeShort in interface javax.jms.StreamMessage

Parameters:

value - the short value to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

See Also:

StreamMessage.writeShort(short)

writeChar

public void writeChar(char value)
               throws javax.jms.JMSException

Writes a char to the stream message.

Specified by:

writeChar in interface javax.jms.StreamMessage

Parameters:

value - the char value to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

See Also:

StreamMessage.writeChar(char)

writeInt

public void writeInt(int value)
              throws javax.jms.JMSException

Writes an int to the stream message.

Specified by:

writeInt in interface javax.jms.StreamMessage

Parameters:

value - the int value to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

See Also:

StreamMessage.writeInt(int)

writeLong

public void writeLong(long value)
               throws javax.jms.JMSException

Writes a long to the stream message.

Specified by:

writeLong in interface javax.jms.StreamMessage

Parameters:

value - the long value to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

See Also:

StreamMessage.writeLong(long)

writeFloat

public void writeFloat(float value)
                throws javax.jms.JMSException

Writes a float to the stream message.

Specified by:

writeFloat in interface javax.jms.StreamMessage

Parameters:

value - the float value to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

See Also:

StreamMessage.writeFloat(float)

writeDouble

public void writeDouble(double value)
                 throws javax.jms.JMSException

Writes a double to the stream message.

Specified by:

writeDouble in interface javax.jms.StreamMessage

Parameters:

value - the double value to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

See Also:

StreamMessage.writeDouble(double)

writeString

public void writeString(java.lang.String value)
                 throws javax.jms.JMSException

Writes a String to the stream message.

Specified by:

writeString in interface javax.jms.StreamMessage

Parameters:

value - the String value to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

See Also:

StreamMessage.writeString(String)

writeBytes

public void writeBytes(byte[] value)
                throws javax.jms.JMSException

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.

Specified by:

writeBytes in interface javax.jms.StreamMessage

Parameters:

value - the byte array value to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

See Also:

StreamMessage.writeBytes(byte[])

writeBytes

public void writeBytes(byte[] value,
                       int offset,
                       int length)
                throws javax.jms.JMSException

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.

Specified by:

writeBytes in interface javax.jms.StreamMessage

Parameters:

value - the byte array value to be written

offset - the initial offset within the byte array

length - the number of bytes to use

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

See Also:

StreamMessage.writeBytes(byte[], int, int)

writeObject

public void writeObject(java.lang.Object value)
                 throws javax.jms.JMSException

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.

Specified by:

writeObject in interface javax.jms.StreamMessage

Parameters:

value - the Java object to be written

Throws:

javax.jms.JMSException - if the JMS provider fails to write the message due to some internal error.

javax.jms.MessageFormatException - if the object is invalid.

javax.jms.MessageNotWriteableException - if the message is in read-only mode.

See Also:

StreamMessage.writeObject(Object)

reset

public void reset()
           throws javax.jms.JMSException

Specified by:

reset in interface javax.jms.StreamMessage

Throws:

javax.jms.JMSException

See Also:

StreamMessage.reset()

clearBody

public void clearBody()
               throws javax.jms.JMSException

Sets the object reference in the message to null and sets the message to modifiable.

Specified by:

clearBody in interface javax.jms.Message

Overrides:

clearBody in class MessageImpl

Throws:

javax.jms.JMSException