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 stream message.
- 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 message stream has
been reached.MessageFormatException - if this type conversion is invalid.MessageNotReadableException - if the message is in write-only
mode.
readByte
public byte readByte()
throws JMSException
- Reads a
byte value from the stream message.
- Returns:
- the next byte from the stream message as a 8-bit
byte - Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of message stream has
been reached.MessageFormatException - if this type conversion is invalid.MessageNotReadableException - if the message is in write-only
mode.
readShort
public short readShort()
throws JMSException
- Reads a 16-bit integer from the stream message.
- Returns:
- a 16-bit integer from the stream message
- Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of message stream has
been reached.MessageFormatException - if this type conversion is invalid.MessageNotReadableException - if the message is in write-only
mode.
readChar
public char readChar()
throws JMSException
- Reads a Unicode character value from the stream message.
- Returns:
- a Unicode character from the stream message
- Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of message stream has
been reached.MessageFormatException - if this type conversion is invalidMessageNotReadableException - if the message is in write-only
mode.
readInt
public int readInt()
throws JMSException
- Reads a 32-bit integer from the stream message.
- Returns:
- a 32-bit integer value from the stream message, 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 message stream has
been reached.MessageFormatException - if this type conversion is invalid.MessageNotReadableException - if the message is in write-only
mode.
readLong
public long readLong()
throws JMSException
- Reads a 64-bit integer from the stream message.
- Returns:
- a 64-bit integer value from the stream message, 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 message stream has
been reached.MessageFormatException - if this type conversion is invalid.MessageNotReadableException - if the message is in write-only
mode.
readFloat
public float readFloat()
throws JMSException
- Reads a
float from the stream message.
- Returns:
- a
float value from the stream message - Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of message stream has
been reached.MessageFormatException - if this type conversion is invalid.MessageNotReadableException - if the message is in write-only
mode.
readDouble
public double readDouble()
throws JMSException
- Reads a
double from the stream message.
- Returns:
- a
double value from the stream message - Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of message stream has
been reached.MessageFormatException - if this type conversion is invalid.MessageNotReadableException - if the message is in write-only
mode.
readString
public String readString()
throws JMSException
- Reads a
String from the stream message.
- Returns:
- a Unicode string from the stream message
- Throws:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of message stream has
been reached.MessageFormatException - if this type conversion is invalid.MessageNotReadableException - if the message is in write-only
mode.
readBytes
public int readBytes(byte[] value)
throws 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.
- 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:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of message stream has
been reached.MessageFormatException - if this type conversion is invalid.MessageNotReadableException - if the message is in write-only
mode.- See Also:
readObject()
readObject
public Object readObject()
throws 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
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 .
- 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:
JMSException - if the JMS provider fails to read the message
due to some internal error.MessageEOFException - if unexpected end of message stream has
been reached.MessageFormatException - if this type conversion is invalid.MessageNotReadableException - if the message is in write-only
mode.- See Also:
readBytes(byte[] value)
writeBoolean
public void writeBoolean(boolean value)
throws 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 .
- 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 stream message.
- 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 stream message.
- Parameters:
value - the short 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.
writeChar
public void writeChar(char value)
throws JMSException
- Writes a
char to the stream message.
- 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 stream message.
- Parameters:
value - the int 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.
writeLong
public void writeLong(long value)
throws JMSException
- Writes a
long to the stream message.
- Parameters:
value - the long 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.
writeFloat
public void writeFloat(float value)
throws JMSException
- Writes a
float to the stream message.
- 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
- Writes a
double to the stream message.
- 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.
writeString
public void writeString(String value)
throws JMSException
- Writes a
String to the stream message.
- 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 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.
- Parameters:
value - the byte array 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,
int offset,
int length)
throws 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.
- 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 stream message.
This method works only for the objectified primitive
object types (Integer , Double ,
Long ...), String objects, and byte
arrays.
- Parameters:
value - the Java object to be written- Throws:
JMSException - if the JMS provider fails to write the message
due to some internal error.MessageFormatException - if the object is invalid.MessageNotWriteableException - if the message is in read-only
mode.
reset
public void reset()
throws JMSException
- Puts the message body in read-only mode and repositions the stream
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.
|