| javax.jms.BytesMessage
| BytesMessage | | public interface BytesMessage extends Message(Code) | | 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.
The BytesMessage methods are based largely on those found in
java.io.DataInputStream and
java.io.DataOutputStream.
This message type is for client encoding of existing message formats.
If possible, one of the other self-defining message types should be used
instead.
Although the JMS API allows the use of message properties with byte
messages, they are typically not used, since the inclusion of properties
may affect the format.
The primitive types can be written explicitly using methods
for each type. They may also be written generically as objects.
For instance, a call to BytesMessage.writeInt(6) is
equivalent to BytesMessage.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 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.
See Also: javax.jms.Session.createBytesMessage
See Also: javax.jms.MapMessage
See Also: javax.jms.Message
See Also: javax.jms.ObjectMessage
See Also: javax.jms.StreamMessage
See Also: javax.jms.TextMessage |
| Method Summary | |
| public long | getBodyLength()
Gets the number of bytes of the message body when the message
is in read-only mode. | | public boolean | readBoolean()
Reads a boolean from the bytes message stream. | | public byte | readByte()
Reads a signed 8-bit value from the bytes message stream. | | public int | readBytes(byte[] value)
Reads a byte array from the bytes message stream.
If the length of array value is less than the number of
bytes remaining to be read from the stream, the array should
be filled. | | public int | readBytes(byte[] value, int length)
Reads a portion of the bytes message stream.
If the length of array value is less than the number of
bytes remaining to be read from the stream, the array should
be filled. | | public char | readChar()
Reads a Unicode character value from the bytes message stream. | | public double | readDouble()
Reads a double from the bytes message stream. | | public float | readFloat()
Reads a float from the bytes message stream. | | public int | readInt()
Reads a signed 32-bit integer from the bytes message stream. | | public long | readLong()
Reads a signed 64-bit integer from the bytes message stream. | | public short | readShort()
Reads a signed 16-bit number from the bytes message stream. | | public String | readUTF()
Reads a string that has been encoded using a modified UTF-8
format from the bytes message stream.
For more information on the UTF-8 format, see "File System Safe
UCS Transformation Format (FSS_UTF)", X/Open Preliminary Specification,
X/Open Company Ltd., Document Number: P316. | | public int | readUnsignedByte()
Reads an unsigned 8-bit number from the bytes message stream. | | public int | readUnsignedShort()
Reads an unsigned 16-bit number from the bytes message stream. | | public void | reset()
Puts the message body in read-only mode and repositions the stream of
bytes to the beginning. | | public void | writeBoolean(boolean value)
Writes a boolean to the bytes message stream as a 1-byte
value. | | public void | writeByte(byte value)
Writes a byte to the bytes message stream as a 1-byte
value. | | public void | writeBytes(byte[] value)
Writes a byte array to the bytes message stream. | | public void | writeBytes(byte[] value, int offset, int length)
Writes a portion of a byte array to the bytes message stream. | | public void | writeChar(char value)
Writes a char to the bytes message stream as a 2-byte
value, high byte first. | | public void | writeDouble(double value)
Converts the double argument to a long using
the
doubleToLongBits method in class Double,
and then writes that long value to the bytes message
stream as an 8-byte quantity, high byte first. | | public void | writeFloat(float value)
Converts the float argument to an int using
the
floatToIntBits method in class Float,
and then writes that int value to the bytes message
stream as a 4-byte quantity, high byte first. | | public void | writeInt(int value)
Writes an int to the bytes message stream as four bytes,
high byte first. | | public void | writeLong(long value)
Writes a long to the bytes message stream as eight bytes,
high byte first. | | public void | writeObject(Object value)
Writes an object to the bytes message stream. | | public void | writeShort(short value)
Writes a short to the bytes message stream as two bytes,
high byte first. | | public void | writeUTF(String value)
Writes a string to the bytes message stream using UTF-8 encoding in a
machine-independent manner.
For more information on the UTF-8 format, see "File System Safe
UCS Transformation Format (FSS_UTF)", X/Open Preliminary Specification,
X/Open Company Ltd., Document Number: P316. |
| getBodyLength | | public long getBodyLength() throws JMSException(Code) | | Gets the number of bytes of the message body when the message
is in read-only mode. The value returned can be used to allocate
a byte array. The value returned is the entire length of the message
body, regardless of where the pointer for reading the message
is currently located.
number of bytes in the message
exception:
JMSException - if the JMS provider fails to read the message due to some internal error.
exception:
MessageNotReadableException - if the message is in write-onlymode.
since:
1.1 |
| readBoolean | | public boolean readBoolean() throws JMSException(Code) | | Reads a boolean from the bytes message stream.
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 bytes stream has been reached.
exception:
MessageNotReadableException - if the message is in write-only mode. |
| readByte | | public byte readByte() throws JMSException(Code) | | Reads a signed 8-bit value from the bytes message stream.
the next byte from the bytes message stream as a signed 8-bitbyte
exception:
JMSException - if the JMS provider fails to read the message due to some internal error.
exception:
MessageEOFException - if unexpected end of bytes stream has been reached.
exception:
MessageNotReadableException - if the message is in write-only mode. |
| readBytes | | public int readBytes(byte[] value) throws JMSException(Code) | | Reads a byte array from the bytes message stream.
If the length of array value is less than the number of
bytes remaining to be read from the stream, the array should
be filled. A subsequent call reads the next increment, and so on.
If the number of bytes remaining in the stream is less than the
length of
array value, the bytes should be read into the array.
The return value of the total number of bytes read will be less than
the length of the array, indicating that there are no more bytes left
to be read from the stream. The next read of the stream returns -1.
Parameters:
value - the buffer into which the data is read the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached
exception:
JMSException - if the JMS provider fails to read the message due to some internal error.
exception:
MessageNotReadableException - if the message is in write-only mode. |
| readBytes | | public int readBytes(byte[] value, int length) throws JMSException(Code) | | Reads a portion of the bytes message stream.
If the length of array value is less than the number of
bytes remaining to be read from the stream, the array should
be filled. A subsequent call reads the next increment, and so on.
If the number of bytes remaining in the stream is less than the
length of
array value, the bytes should be read into the array.
The return value of the total number of bytes read will be less than
the length of the array, indicating that there are no more bytes left
to be read from the stream. The next read of the stream returns -1.
If length is negative, or
length is greater than the length of the array
value, then an IndexOutOfBoundsException is
thrown. No bytes will be read from the stream for this exception case.
Parameters:
value - the buffer into which the data is read
Parameters:
length - the number of bytes to read; must be less than or equal tovalue.length the total number of bytes read into the buffer, or -1 ifthere is no more data because the end of the stream has been reached
exception:
JMSException - if the JMS provider fails to read the message due to some internal error.
exception:
MessageNotReadableException - if the message is in write-only mode. |
| readChar | | public char readChar() throws JMSException(Code) | | Reads a Unicode character value from the bytes message stream.
the next two bytes from the bytes message stream as a Unicodecharacter
exception:
JMSException - if the JMS provider fails to read the message due to some internal error.
exception:
MessageEOFException - if unexpected end of bytes stream has been reached.
exception:
MessageNotReadableException - if the message is in write-only mode. |
| readDouble | | public double readDouble() throws JMSException(Code) | | Reads a double from the bytes message stream.
the next eight bytes from the bytes message stream, interpretedas a double
exception:
JMSException - if the JMS provider fails to read the message due to some internal error.
exception:
MessageEOFException - if unexpected end of bytes stream has been reached.
exception:
MessageNotReadableException - if the message is in write-only mode. |
| readFloat | | public float readFloat() throws JMSException(Code) | | Reads a float from the bytes message stream.
the next four bytes from the bytes message stream, interpretedas a float
exception:
JMSException - if the JMS provider fails to read the message due to some internal error.
exception:
MessageEOFException - if unexpected end of bytes stream has been reached.
exception:
MessageNotReadableException - if the message is in write-only mode. |
| readInt | | public int readInt() throws JMSException(Code) | | Reads a signed 32-bit integer from the bytes message stream.
the next four bytes from the bytes message stream, interpretedas an int
exception:
JMSException - if the JMS provider fails to read the message due to some internal error.
exception:
MessageEOFException - if unexpected end of bytes stream has been reached.
exception:
MessageNotReadableException - if the message is in write-only mode. |
| readLong | | public long readLong() throws JMSException(Code) | | Reads a signed 64-bit integer from the bytes message stream.
the next eight bytes from the bytes message stream, interpretedas a long
exception:
JMSException - if the JMS provider fails to read the message due to some internal error.
exception:
MessageEOFException - if unexpected end of bytes stream has been reached.
exception:
MessageNotReadableException - if the message is in write-only mode. |
| readShort | | public short readShort() throws JMSException(Code) | | Reads a signed 16-bit number from the bytes message stream.
the next two bytes from the bytes message stream, interpreted asa signed 16-bit number
exception:
JMSException - if the JMS provider fails to read the message due to some internal error.
exception:
MessageEOFException - if unexpected end of bytes stream has been reached.
exception:
MessageNotReadableException - if the message is in write-only mode. |
| readUTF | | public String readUTF() throws JMSException(Code) | | Reads a string that has been encoded using a modified UTF-8
format from the bytes message stream.
For more information on the UTF-8 format, see "File System Safe
UCS Transformation Format (FSS_UTF)", X/Open Preliminary Specification,
X/Open Company Ltd., Document Number: P316. This information also
appears in ISO/IEC 10646, Annex P.
a Unicode string from the bytes message stream
exception:
JMSException - if the JMS provider fails to read the message due to some internal error.
exception:
MessageEOFException - if unexpected end of bytes stream has been reached.
exception:
MessageNotReadableException - if the message is in write-only mode. |
| readUnsignedByte | | public int readUnsignedByte() throws JMSException(Code) | | Reads an unsigned 8-bit number from the bytes message stream.
the next byte from the bytes message stream, interpreted as anunsigned 8-bit number
exception:
JMSException - if the JMS provider fails to read the message due to some internal error.
exception:
MessageEOFException - if unexpected end of bytes stream has been reached.
exception:
MessageNotReadableException - if the message is in write-only mode. |
| readUnsignedShort | | public int readUnsignedShort() throws JMSException(Code) | | Reads an unsigned 16-bit number from the bytes message stream.
the next two bytes from the bytes message stream, interpreted asan unsigned 16-bit integer
exception:
JMSException - if the JMS provider fails to read the message due to some internal error.
exception:
MessageEOFException - if unexpected end of bytes stream has been reached.
exception:
MessageNotReadableException - if the message is in write-only mode. |
| reset | | public void reset() throws JMSException(Code) | | Puts the message body in read-only mode and repositions the stream of
bytes to the beginning.
exception:
JMSException - if the JMS provider fails to reset the messagedue to some internal error.
exception:
MessageFormatException - if the message has an invalidformat. |
| writeBoolean | | public void writeBoolean(boolean value) throws JMSException(Code) | | Writes a boolean to the bytes message stream as a 1-byte
value.
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
exception:
JMSException - if the JMS provider fails to write the messagedue to some internal error.
exception:
MessageNotWriteableException - if the message is in read-only mode. |
| writeByte | | public void writeByte(byte value) throws JMSException(Code) | | Writes a byte to the bytes message stream as a 1-byte
value.
Parameters:
value - the byte value to be written
exception:
JMSException - if the JMS provider fails to write the messagedue to some internal error.
exception:
MessageNotWriteableException - if the message is in read-only mode. |
| writeBytes | | public void writeBytes(byte[] value) throws JMSException(Code) | | Writes a byte array to the bytes message stream.
Parameters:
value - the byte array to be written
exception:
JMSException - if the JMS provider fails to write the messagedue to some internal error.
exception:
MessageNotWriteableException - if the message is in read-only mode. |
| writeBytes | | public void writeBytes(byte[] value, int offset, int length) throws JMSException(Code) | | Writes a portion of a byte array to the bytes message stream.
Parameters:
value - the byte array value to be written
Parameters:
offset - the initial offset within the byte array
Parameters:
length - the number of bytes to use
exception:
JMSException - if the JMS provider fails to write the messagedue to some internal error.
exception:
MessageNotWriteableException - if the message is in read-only mode. |
| writeChar | | public void writeChar(char value) throws JMSException(Code) | | Writes a char to the bytes message stream as a 2-byte
value, high byte first.
Parameters:
value - the char value to be written
exception:
JMSException - if the JMS provider fails to write the messagedue to some internal error.
exception:
MessageNotWriteableException - if the message is in read-only mode. |
| writeDouble | | public void writeDouble(double value) throws JMSException(Code) | | Converts the double argument to a long using
the
doubleToLongBits method in class Double,
and then writes that long value to the bytes message
stream as an 8-byte quantity, high byte first.
Parameters:
value - the double value to be written
exception:
JMSException - if the JMS provider fails to write the messagedue to some internal error.
exception:
MessageNotWriteableException - if the message is in read-only mode. |
| writeFloat | | public void writeFloat(float value) throws JMSException(Code) | | Converts the float argument to an int using
the
floatToIntBits method in class Float,
and then writes that int value to the bytes message
stream as a 4-byte quantity, high byte first.
Parameters:
value - the float value to be written
exception:
JMSException - if the JMS provider fails to write the messagedue to some internal error.
exception:
MessageNotWriteableException - if the message is in read-only mode. |
| writeInt | | public void writeInt(int value) throws JMSException(Code) | | Writes an int to the bytes message stream as four bytes,
high byte first.
Parameters:
value - the int to be written
exception:
JMSException - if the JMS provider fails to write the messagedue to some internal error.
exception:
MessageNotWriteableException - if the message is in read-only mode. |
| writeLong | | public void writeLong(long value) throws JMSException(Code) | | Writes a long to the bytes message stream as eight bytes,
high byte first.
Parameters:
value - the long to be written
exception:
JMSException - if the JMS provider fails to write the messagedue to some internal error.
exception:
MessageNotWriteableException - if the message is in read-only mode. |
| writeObject | | public void writeObject(Object value) throws JMSException(Code) | | Writes an object to the bytes message stream.
This method works only for the objectified primitive
object types (Integer, Double,
Long ...), String objects, and byte
arrays.
Parameters:
value - the object in the Java programming language ("Java object") to be written; it must not be null
exception:
JMSException - if the JMS provider fails to write the messagedue to some internal error.
exception:
MessageFormatException - if the object is of an invalid type.
exception:
MessageNotWriteableException - if the message is in read-only mode.
exception:
java.lang.NullPointerException - if the parameter value is null. |
| writeShort | | public void writeShort(short value) throws JMSException(Code) | | Writes a short to the bytes message stream as two bytes,
high byte first.
Parameters:
value - the short to be written
exception:
JMSException - if the JMS provider fails to write the messagedue to some internal error.
exception:
MessageNotWriteableException - if the message is in read-only mode. |
| writeUTF | | public void writeUTF(String value) throws JMSException(Code) | | Writes a string to the bytes message stream using UTF-8 encoding in a
machine-independent manner.
For more information on the UTF-8 format, see "File System Safe
UCS Transformation Format (FSS_UTF)", X/Open Preliminary Specification,
X/Open Company Ltd., Document Number: P316. This information also
appears in ISO/IEC 10646, Annex P.
Parameters:
value - the String value to be written
exception:
JMSException - if the JMS provider fails to write the messagedue to some internal error.
exception:
MessageNotWriteableException - if the message is in read-only mode. |
|
|