|
Préférences
Moteurs de recherche
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
JavaTM Platform, Enterprise Edition, v 5.0
javax.jms
|
Field Summary |
---|
Fields inherited from interface javax.jms.Message |
---|
DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE |
Method Summary | |
---|---|
boolean |
readBoolean()
Reads a boolean from the stream message. |
byte |
readByte()
Reads a byte value from the stream message. |
int |
readBytes(byte[] value)
Reads a byte array field from the stream message into the specified byte[] object (the read buffer). |
char |
readChar()
Reads a Unicode character value from the stream message. |
double |
readDouble()
Reads a double from the stream message. |
float |
readFloat()
Reads a float from the stream message. |
int |
readInt()
Reads a 32-bit integer from the stream message. |
long |
readLong()
Reads a 64-bit integer from the stream message. |
Object |
readObject()
Reads an object from the stream message. |
short |
readShort()
Reads a 16-bit integer from the stream message. |
String |
readString()
Reads a String from the stream message. |
void |
reset()
Puts the message body in read-only mode and repositions the stream to the beginning. |
void |
writeBoolean(boolean value)
Writes a boolean to the stream message. |
void |
writeByte(byte value)
Writes a byte to the stream message. |
void |
writeBytes(byte[] value)
Writes a byte array field to the stream message. |
void |
writeBytes(byte[] value,
int offset,
int length)
Writes a portion of a byte array as a byte array field to the stream message. |
void |
writeChar(char value)
Writes a char to the stream message. |
void |
writeDouble(double value)
Writes a double to the stream message. |
void |
writeFloat(float value)
Writes a float to the stream message. |
void |
writeInt(int value)
Writes an int to the stream message. |
void |
writeLong(long value)
Writes a long to the stream message. |
void |
writeObject(Object value)
Writes an object to the stream message. |
void |
writeShort(short value)
Writes a short to the stream message. |
void |
writeString(String value)
Writes a String to the stream message. |
Method Detail |
---|
boolean readBoolean() throws JMSException
boolean
from the stream message.
boolean
value read
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.byte readByte() throws JMSException
byte
value from the stream message.
byte
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.short readShort() throws JMSException
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.char readChar() throws JMSException
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.int readInt() throws JMSException
int
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.long readLong() throws JMSException
long
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.float readFloat() throws JMSException
float
from the stream message.
float
value from the stream message
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.double readDouble() throws JMSException
double
from the stream message.
double
value from the stream message
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.String readString() throws JMSException
String
from the stream message.
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.int readBytes(byte[] value) throws JMSException
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.
value
- the buffer into which the data is read
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.readObject()
Object readObject() throws JMSException
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
.
int
,
an Integer
is returned)
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(byte[] value)
void writeBoolean(boolean value) throws JMSException
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
.
value
- the boolean
value to be written
JMSException
- if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException
- if the message is in read-only
mode.void writeByte(byte value) throws JMSException
byte
to the stream message.
value
- the byte
value to be written
JMSException
- if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException
- if the message is in read-only
mode.void writeShort(short value) throws JMSException
short
to the stream message.
value
- the short
value to be written
JMSException
- if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException
- if the message is in read-only
mode.void writeChar(char value) throws JMSException
char
to the stream message.
value
- the char
value to be written
JMSException
- if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException
- if the message is in read-only
mode.void writeInt(int value) throws JMSException
int
to the stream message.
value
- the int
value to be written
JMSException
- if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException
- if the message is in read-only
mode.void writeLong(long value) throws JMSException
long
to the stream message.
value
- the long
value to be written
JMSException
- if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException
- if the message is in read-only
mode.void writeFloat(float value) throws JMSException
float
to the stream message.
value
- the float
value to be written
JMSException
- if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException
- if the message is in read-only
mode.void writeDouble(double value) throws JMSException
double
to the stream message.
value
- the double
value to be written
JMSException
- if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException
- if the message is in read-only
mode.void writeString(String value) throws JMSException
String
to the stream message.
value
- the String
value to be written
JMSException
- if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException
- if the message is in read-only
mode.void writeBytes(byte[] value) throws JMSException
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.
value
- the byte array value to be written
JMSException
- if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException
- if the message is in read-only
mode.void writeBytes(byte[] value, int offset, int length) throws JMSException
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.
value
- the byte array value to be writtenoffset
- the initial offset within the byte arraylength
- the number of bytes to use
JMSException
- if the JMS provider fails to write the message
due to some internal error.
MessageNotWriteableException
- if the message is in read-only
mode.void writeObject(Object value) throws JMSException
This method works only for the objectified primitive
object types (Integer
, Double
,
Long
...), String
objects, and byte
arrays.
value
- the Java object to be written
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.void reset() throws JMSException
JMSException
- if the JMS provider fails to reset the message
due to some internal error.
MessageFormatException
- if the message has an invalid
format.