File	Doc	Category	Size	Date	Package
StreamMessage.java	API Doc	Glassfish v2 API	23363	Fri May 04 22:36:16 BST 2007	javax.jms

StreamMessage

| | 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
|----------------------------------------------------------------------

Fields Summary

Constructors Summary

Methods Summary
public boolean	readBoolean() Reads a boolean from the stream message. return the boolean value read exception JMSException if the JMS provider fails to read the message due to some internal error. exception MessageEOFException if unexpected end of message stream has been reached. exception MessageFormatException if this type conversion is invalid. exception MessageNotReadableException if the message is in write-only mode.
public byte	readByte() Reads a byte value from the stream message. return the next byte from the stream message as a 8-bit byte exception JMSException if the JMS provider fails to read the message due to some internal error. exception MessageEOFException if unexpected end of message stream has been reached. exception MessageFormatException if this type conversion is invalid. exception MessageNotReadableException if the message is in write-only mode.
public int	readBytes(byte[] value) 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. param value the buffer into which the data is read return 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 exception JMSException if the JMS provider fails to read the message due to some internal error. exception MessageEOFException if unexpected end of message stream has been reached. exception MessageFormatException if this type conversion is invalid. exception MessageNotReadableException if the message is in write-only mode. see #readObject()
public char	readChar() Reads a Unicode character value from the stream message. return a Unicode character from the stream message exception JMSException if the JMS provider fails to read the message due to some internal error. exception MessageEOFException if unexpected end of message stream has been reached. exception MessageFormatException if this type conversion is invalid exception MessageNotReadableException if the message is in write-only mode.
public double	readDouble() Reads a double from the stream message. return a double value from the stream message exception JMSException if the JMS provider fails to read the message due to some internal error. exception MessageEOFException if unexpected end of message stream has been reached. exception MessageFormatException if this type conversion is invalid. exception MessageNotReadableException if the message is in write-only mode.
public float	readFloat() Reads a float from the stream message. return a float value from the stream message exception JMSException if the JMS provider fails to read the message due to some internal error. exception MessageEOFException if unexpected end of message stream has been reached. exception MessageFormatException if this type conversion is invalid. exception MessageNotReadableException if the message is in write-only mode.
public int	readInt() Reads a 32-bit integer from the stream message. return a 32-bit integer value from the stream message, interpreted as an int exception JMSException if the JMS provider fails to read the message due to some internal error. exception MessageEOFException if unexpected end of message stream has been reached. exception MessageFormatException if this type conversion is invalid. exception MessageNotReadableException if the message is in write-only mode.
public long	readLong() Reads a 64-bit integer from the stream message. return a 64-bit integer value from the stream message, interpreted as a long exception JMSException if the JMS provider fails to read the message due to some internal error. exception MessageEOFException if unexpected end of message stream has been reached. exception MessageFormatException if this type conversion is invalid. exception MessageNotReadableException if the message is in write-only mode.
public java.lang.Object	readObject() 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. return a Java object from the stream message, in objectified format (for example, if the object was written as an int, an Integer is returned) exception JMSException if the JMS provider fails to read the message due to some internal error. exception MessageEOFException if unexpected end of message stream has been reached. exception MessageFormatException if this type conversion is invalid. exception MessageNotReadableException if the message is in write-only mode. see #readBytes(byte[] value)
public short	readShort() Reads a 16-bit integer from the stream message. return a 16-bit integer from the stream message exception JMSException if the JMS provider fails to read the message due to some internal error. exception MessageEOFException if unexpected end of message stream has been reached. exception MessageFormatException if this type conversion is invalid. exception MessageNotReadableException if the message is in write-only mode.
public java.lang.String	readString() Reads a String from the stream message. return a Unicode string from the stream message exception JMSException if the JMS provider fails to read the message due to some internal error. exception MessageEOFException if unexpected end of message stream has been reached. exception MessageFormatException if this type conversion is invalid. exception MessageNotReadableException if the message is in write-only mode.
public void	reset() Puts the message body in read-only mode and repositions the stream to the beginning. exception JMSException if the JMS provider fails to reset the message due to some internal error. exception MessageFormatException if the message has an invalid format.
public void	writeBoolean(boolean value) 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. param value the boolean value to be written exception JMSException if the JMS provider fails to write the message due to some internal error. exception MessageNotWriteableException if the message is in read-only mode.
public void	writeByte(byte value) Writes a byte to the stream message. param value the byte value to be written exception JMSException if the JMS provider fails to write the message due to some internal error. exception MessageNotWriteableException if the message is in read-only mode.
public void	writeBytes(byte[] value) 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. param value the byte array value to be written exception JMSException if the JMS provider fails to write the message due to some internal error. exception MessageNotWriteableException if the message is in read-only mode.
public void	writeBytes(byte[] value, int offset, int length) 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. param value the byte array value to be written param offset the initial offset within the byte array param length the number of bytes to use exception JMSException if the JMS provider fails to write the message due to some internal error. exception MessageNotWriteableException if the message is in read-only mode.
public void	writeChar(char value) Writes a char to the stream message. param value the char value to be written exception JMSException if the JMS provider fails to write the message due to some internal error. exception MessageNotWriteableException if the message is in read-only mode.
public void	writeDouble(double value) Writes a double to the stream message. param value the double value to be written exception JMSException if the JMS provider fails to write the message due to some internal error. exception MessageNotWriteableException if the message is in read-only mode.
public void	writeFloat(float value) Writes a float to the stream message. param value the float value to be written exception JMSException if the JMS provider fails to write the message due to some internal error. exception MessageNotWriteableException if the message is in read-only mode.
public void	writeInt(int value) Writes an int to the stream message. param value the int value to be written exception JMSException if the JMS provider fails to write the message due to some internal error. exception MessageNotWriteableException if the message is in read-only mode.
public void	writeLong(long value) Writes a long to the stream message. param value the long value to be written exception JMSException if the JMS provider fails to write the message due to some internal error. exception MessageNotWriteableException if the message is in read-only mode.
public void	writeObject(java.lang.Object value) 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. param value the Java object to be written exception JMSException if the JMS provider fails to write the message due to some internal error. exception MessageFormatException if the object is invalid. exception MessageNotWriteableException if the message is in read-only mode.
public void	writeShort(short value) Writes a short to the stream message. param value the short value to be written exception JMSException if the JMS provider fails to write the message due to some internal error. exception MessageNotWriteableException if the message is in read-only mode.
public void	writeString(java.lang.String value) Writes a String to the stream message. param value the String value to be written exception JMSException if the JMS provider fails to write the message due to some internal error. exception MessageNotWriteableException if the message is in read-only mode.