BytesMessage


public interface BytesMessage
extends Message

WebSphere MQ class: JMSBytesMessage 



java.lang.Object
   |
   +----com.ibm.jms.JMSMessage
           |
           +----com.ibm.jms.JMSBytesMessage

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

Note:
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.

See also: MapMessage, Message, ObjectMessage, StreamMessage, and TextMessage.

Methods

readBoolean 
public boolean readBoolean() throws JMSException

Read a boolean from the bytes message.

Returns:
the boolean value read.

Throws:
  • MessageNotReadableException - if the message is in write-only mode.
  • JMSException - if JMS fails to read the message because of an internal JMS error.
  • MessageEOFException - if it is the end of the message bytes.

readByte 
public byte readByte() throws JMSException

Read a signed 8-bit value from the bytes message.

Returns:
the next byte from the bytes message as a signed 8-bit byte.

Throws:
  • MessageNotReadableException - if the message is in write-only mode.
  • MessageEOFException - if it is the end of the message bytes.
  • JMSException - if JMS fails to read the message because of an internal JMS error.

readBytes 
public int readBytes(byte[] value) throws JMSException

Read a byte array from the bytes message. If there are sufficient bytes remaining in the stream the entire buffer is filled, if not, the buffer is partially filled.

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 bytes has been reached.

Throws:
  • MessageNotReadableException - if the message is in write-only mode.
  • JMSException - if JMS fails to read the message because of an internal JMS error.

readBytes 
public int readBytes(byte[] value, int length)
                                      throws JMSException

Read a portion of the bytes message.

Parameters:
  • value - the buffer into which the data is read.
  • length - the number of bytes to read.

Returns:
the total number of bytes read into the buffer, or -1 if there is no more data because the end of the bytes has been reached.

Throws:
  • MessageNotReadableException - if the message is in write-only mode.
  • IndexOutOfBoundsException - if length is negative, or is less than the length of the array value
  • JMSException - if JMS fails to read the message because of an internal JMS error.

readChar 
public char readChar() throws JMSException

Read a Unicode character value from the bytes message.

Returns:
the next two bytes from the bytes message as a Unicode character.

Throws:
  • MessageNotReadableException - if the message is in write-only mode.
  • MessageEOFException - if it is the end of the message bytes.
  • JMSException - if JMS fails to read the message because of an internal JMS error.

readDouble 
public double readDouble() throws JMSException

Read a double from the bytes message.

Returns:
the next eight bytes from the bytes message, interpreted as a double.

Throws:
  • MessageNotReadableException - if the message is in write-only mode.
  • MessageEOFException - if it is the end of the message bytes.
  • JMSException - if JMS fails to read the message because of an internal JMS error.

readFloat 
public float readFloat() throws JMSException

Read a float from the bytes message.

Returns:
the next four bytes from the bytes message, interpreted as a float.

Throws:
  • MessageNotReadableException - if the message is in write-only mode.
  • MessageEOFException - if it is the end of the message bytes.
  • JMSException - if JMS fails to read the message because of an internal JMS error.

readInt 
public int readInt() throws JMSException

Read a signed 32-bit integer from the bytes message.

Returns:
the next four bytes from the bytes message, interpreted as an int.

Throws:
  • MessageNotReadableException - if the message is in write-only mode.
  • MessageEOFException - if it is the end of the message bytes.
  • JMSException - if JMS fails to read the message because of an internal JMS error.

readLong 
public long readLong() throws JMSException

Read a signed 64-bit integer from the bytes message.

Returns:
the next eight bytes from the bytes message, interpreted as a long.

Throws:
  • MessageNotReadableException - if the message is in write-only mode.
  • MessageEOFException - if it is the end of the message bytes.
  • JMSException - if JMS fails to read the message because of an internal JMS error.

readShort 
public short readShort() throws JMSException

Read a signed 16-bit number from the bytes message.

Returns:
the next two bytes from the bytes message, interpreted as a signed 16-bit number.

Throws:
  • MessageNotReadableException - if the message is in write-only mode.
  • MessageEOFException - if it is the end of the message bytes.
  • JMSException - if JMS fails to read the message because of an internal JMS error.

readUnsignedByte 
public int readUnsignedByte() throws JMSException

Read an unsigned 8-bit number from the bytes message.

Returns:
the next byte from the bytes message, interpreted as an unsigned 8-bit number.

Throws:
  • MessageNotReadableException - if the message is in write-only mode.
  • MessageEOFException - if it is the end of the message bytes.
  • JMSException - if JMS fails to read the message because of an internal JMS error.

readUnsignedShort 
public int readUnsignedShort() throws JMSException

Read an unsigned 16-bit number from the bytes message.

Returns:
the next two bytes from the bytes message, interpreted as an unsigned 16-bit integer.

Throws:
  • MessageNotReadableException - if the message is in write-only mode.
  • MessageEOFException - if it is the end of the message bytes.
  • JMSException - if JMS fails to read the message because of an internal JMS error.

readUTF 
public java.lang.String readUTF() throws JMSException

Read in a string that has been encoded using a modified UTF-8 format from the bytes message. The first two bytes are interpreted as a 2-byte length field.

Returns:
a Unicode string from the bytes message.

Throws:
  • MessageNotReadableException - if the message is in write-only mode.
  • MessageEOFException - if it is the end of the message bytes.
  • JMSException - if JMS fails to read the message because of an internal JMS error.

reset 
public void reset() throws JMSException

Put the message body in read-only mode, and reposition the bytes of bytes to the beginning.

Throws:
  • JMSException - if JMS fails to reset the message because of an internal JMS error.
  • MessageFormatException - if message has an incorrect format

writeBoolean 
public void writeBoolean(boolean value) throws JMSException

Write a boolean to the bytes message as a 1-byte value. The value true is written out as the value (byte)1; the value false is written out as the value (byte)0.

Parameters:
value - the boolean value to be written.

Throws:
  • MessageNotWriteableException - if message in read-only mode.
  • JMSException - if JMS fails to write the message because of an internal JMS error.

writeByte 
public void writeByte(byte value) throws JMSException

Write out a byte to the bytes message as a 1-byte value.

Parameters:
value - the byte value to be written.

Throws:
  • MessageNotWriteableException - if message in read-only mode.
  • JMSException - if JMS fails to write the message because of an internal JMS error.

writeBytes 
public void writeBytes(byte[] value) throws JMSException

Write a byte array to the bytes message.

Parameters:
value - the byte array to be written.

Throws:
  • MessageNotWriteableException - if message in read-only mode.
  • JMSException - if JMS fails to write the message because of an internal JMS error.

writeBytes 
public void writeBytes(byte[] value,
                    int length) throws JMSException

Write a portion of a byte array to the bytes message.

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:
  • MessageNotWriteableException - if message in read-only mode.
  • JMSException - if JMS fails to write the message because of an internal JMS error.

writeChar 
public void writeChar(char value) throws JMSException

Write a char to the bytes message as a 2-byte value, high byte first.

Parameters:
value - the char value to be written.

Throws:
  • MessageNotWriteableException - if message in read-only mode.
  • JMSException - if JMS fails to write the message because of an internal JMS error.

writeDouble 
public void writeDouble(double value) throws JMSException

Convert the double argument to a long using doubleToLongBits method in class Double, and then write that long value to the bytes message as an 8-byte quantity.

Parameters:
value - the double value to be written.

Throws:
  • MessageNotWriteableException - if message in read-only mode.
  • JMSException - if JMS fails to write the message because of an internal JMS error.

writeFloat 
public void writeFloat(float value) throws JMSException

Convert the float argument to an int using floatToIntBits method in class Float, and then write that int value to the bytes message as a 4-byte quantity.

Parameters:
value - the float value to be written.

Throws:
  • MessageNotWriteableException - if message in read-only mode.
  • JMSException - if JMS fails to write the message because of an internal JMS error.

writeInt 
public void writeInt(int value) throws JMSException

Write an int to the bytes message as four bytes.

Parameters:
value - the int to be written.

Throws:
  • MessageNotWriteableException - if message in read-only mode.
  • JMSException - if JMS fails to write the message because of an internal JMS error.

writeLong 
public void writeLong(long value) throws JMSException

Write a long to the bytes message as eight bytes,

Parameters:
value - the long to be written.

Throws:
  • MessageNotWriteableException - if message in read-only mode.
  • JMSException - if JMS fails to write the message because of an internal JMS error.

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

Write a Java object to the bytes message.

Note:
This method only works for the primitive object types (such as Integer, Double, and Long), Strings, and byte arrays.

Parameters:
value - the Java object to be written.

Throws:
  • MessageNotWriteableException - if message in read-only mode.
  • MessageFormatException - if object is not a valid type.
  • JMSException - if JMS fails to write the message because of an internal JMS error.

writeShort 
public void writeShort(short value) throws JMSException

Write a short to the bytes message as two bytes.

Parameters:
value - the short to be written.

Throws:
  • MessageNotWriteableException - if message in read-only mode.
  • JMSException - if JMS fails to write the message because of an internal JMS error.

writeUTF 
public void writeUTF(java.lang.String value)
                             throws JMSException

Write a string to the bytes message using UTF-8 encoding in a machine-independent manner. The UTF-8 string written to the buffer starts with a 2-byte length field.

Parameters:
value - the String value to be written.

Throws:
  • MessageNotWriteableException - if message in read-only mode.
  • JMSException - if JMS fails to write the message because of an internal JMS error.


© IBM Corporation 1997, 2002. All Rights Reserved