acknowledge, clearBody, 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,
readBoolean
public boolean readBoolean()
throws JMSException
- Reads a
boolean from the bytes message stream.
- Returns:
- the
boolean value read - Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of bytes stream has
been reached.MessageNotReadableException - if the message is in write-only
mode.
readByte
public byte readByte()
throws JMSException
- Reads a signed 8-bit value from the bytes message stream.
- Returns:
- the next byte from the bytes message stream as a signed 8-bit
byte - Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of bytes stream has
been reached.MessageNotReadableException - if the message is in write-only
mode.
readUnsignedByte
public int readUnsignedByte()
throws JMSException
- Reads an unsigned 8-bit number from the bytes message stream.
- Returns:
- the next byte from the bytes message stream, interpreted as an
unsigned 8-bit number
- Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of bytes stream has
been reached.MessageNotReadableException - if the message is in write-only
mode.
readShort
public short readShort()
throws JMSException
- Reads a signed 16-bit number from the bytes message stream.
- Returns:
- the next two bytes from the bytes message stream, interpreted as
a signed 16-bit number
- Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of bytes stream has
been reached.MessageNotReadableException - if the message is in write-only
mode.
readUnsignedShort
public int readUnsignedShort()
throws JMSException
- Reads an unsigned 16-bit number from the bytes message stream.
- Returns:
- the next two bytes from the bytes message stream, interpreted as
an unsigned 16-bit integer
- Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of bytes stream has
been reached.MessageNotReadableException - if the message is in write-only
mode.
readChar
public char readChar()
throws JMSException
- Reads a Unicode character value from the bytes message stream.
- Returns:
- the next two bytes from the bytes message stream as a Unicode
character
- Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of bytes stream has
been reached.MessageNotReadableException - if the message is in write-only
mode.
readInt
public int readInt()
throws JMSException
- Reads a signed 32-bit integer from the bytes message stream.
- Returns:
- the next four bytes from the bytes message stream, interpreted
as an
int - Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of bytes stream has
been reached.MessageNotReadableException - if the message is in write-only
mode.
readLong
public long readLong()
throws JMSException
- Reads a signed 64-bit integer from the bytes message stream.
- Returns:
- the next eight bytes from the bytes message stream, interpreted
as a
long - Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of bytes stream has
been reached.MessageNotReadableException - if the message is in write-only
mode.
readFloat
public float readFloat()
throws JMSException
- Reads a
float from the bytes message stream.
- Returns:
- the next four bytes from the bytes message stream, interpreted
as a
float - Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of bytes stream has
been reached.MessageNotReadableException - if the message is in write-only
mode.
readDouble
public double readDouble()
throws JMSException
- Reads a
double from the bytes message stream.
- Returns:
- the next eight bytes from the bytes message stream, interpreted
as a
double - Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of bytes stream has
been reached.MessageNotReadableException - if the message is in write-only
mode.
readUTF
public String readUTF()
throws JMSException
- 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.
- Returns:
- a Unicode string from the bytes message stream
- Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of bytes stream has
been reached.MessageNotReadableException - if the message is in write-only
mode.
readBytes
public int readBytes(byte[] value)
throws JMSException
- 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- Returns:
- 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
- Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageNotReadableException - if the message is in write-only
mode.
readBytes
public int readBytes(byte[] value,
int length)
throws JMSException
- 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 readlength - the number of bytes to read; must be less than or equal to
value.length - Returns:
- 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
- Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageNotReadableException - if the message is in write-only
mode.
writeBoolean
public void writeBoolean(boolean value)
throws JMSException
- 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- Throws:
JMSException - if the JMS provider fails to write the message
due to some internal error.MessageNotWriteableException - if the message is in read-only
mode.
writeByte
public void writeByte(byte value)
throws JMSException
- Writes a
byte to the bytes message stream as a 1-byte
value.
- Parameters:
value - the byte value to be written- Throws:
JMSException - if the JMS provider fails to write the message
due to some internal error.MessageNotWriteableException - if the message is in read-only
mode.
writeShort
public void writeShort(short value)
throws JMSException
- Writes a
short to the bytes message stream as two bytes,
high byte first.
- Parameters:
value - the short to be written- Throws:
JMSException - if the JMS provider fails to write the message
due to some internal error.MessageNotWriteableException - if the message is in read-only
mode.
writeChar
public void writeChar(char value)
throws JMSException
- Writes a
char to the bytes message stream as a 2-byte
value, high byte first.
- Parameters:
value - the char value to be written- Throws:
JMSException - if the JMS provider fails to write the message
due to some internal error.MessageNotWriteableException - if the message is in read-only
mode.
writeInt
public void writeInt(int value)
throws JMSException
- Writes an
int to the bytes message stream as four bytes,
high byte first.
- Parameters:
value - the int to be written- Throws:
JMSException - if the JMS provider fails to write the message
due to some internal error.MessageNotWriteableException - if the message is in read-only
mode.
writeLong
public void writeLong(long value)
throws JMSException
- Writes a
long to the bytes message stream as eight bytes,
high byte first.
- Parameters:
value - the long to be written- Throws:
JMSException - if the JMS provider fails to write the message
due to some internal error.MessageNotWriteableException - if the message is in read-only
mode.
writeFloat
public void writeFloat(float value)
throws JMSException
- 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- Throws:
JMSException - if the JMS provider fails to write the message
due to some internal error.MessageNotWriteableException - if the message is in read-only
mode.
writeDouble
public void writeDouble(double value)
throws JMSException
- 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- Throws:
JMSException - if the JMS provider fails to write the message
due to some internal error.MessageNotWriteableException - if the message is in read-only
mode.
writeUTF
public void writeUTF(String value)
throws JMSException
- 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- Throws:
JMSException - if the JMS provider fails to write the message
due to some internal error.MessageNotWriteableException - if the message is in read-only
mode.
writeBytes
public void writeBytes(byte[] value)
throws JMSException
- Writes a byte array to the bytes message stream.
- Parameters:
value - the byte array to be written- Throws:
JMSException - if the JMS provider fails to write the message
due to some internal error.MessageNotWriteableException - if the message is in read-only
mode.
writeBytes
public void writeBytes(byte[] value,
int offset,
int length)
throws JMSException
- Writes a portion of a byte array to the bytes message stream.
- Parameters:
value - the byte array value to be writtenoffset - the initial offset within the byte arraylength - the number of bytes to use- Throws:
JMSException - if the JMS provider fails to write the message
due to some internal error.MessageNotWriteableException - if the message is in read-only
mode.
writeObject
public void writeObject(Object value)
throws JMSException
- 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- Throws:
JMSException - if the JMS provider fails to write the message
due to some internal error.MessageFormatException - if the object is of an invalid type.MessageNotWriteableException - if the message is in read-only
mode.java.lang.NullPointerException - if the parameter
value is null.
reset
public void reset()
throws JMSException
- Puts the message body in read-only mode and repositions the stream of
bytes to the beginning.
- Throws:
JMSException - if the JMS provider fails to reset the message
due to some internal error.MessageFormatException - if the message has an invalid
format.
jBroker is a registered trademark of Novell, Inc. Copyright 1998-2003 Novell, Inc. All Rights Reserved.
|