Movatterモバイル変換

Interface BytesMessage

All Superinterfaces:: Message

public interfaceBytesMessage
extendsMessage

ABytesMessage object is used to send a message containing a stream of uninterpreted bytes. It inherits from theMessage interface and adds a bytes message body. The receiver of the message supplies the interpretation of the bytes.

TheBytesMessage methods are based largely on those found injava.io.DataInputStream andjava.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 toBytesMessage.writeInt(6) is equivalent toBytesMessage.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 whenclearBody is called, the body of the message is in write-only mode. After the first call toreset 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 calledreset so that the message body is in read-only mode for the client.

IfclearBody 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, aMessageNotReadableException is thrown.

If a client attempts to write a message in read-only mode, aMessageNotWriteableException is thrown.

See Also:: Session.createBytesMessage(),MapMessage,Message,ObjectMessage,StreamMessage,TextMessage

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE,DEFAULT_PRIORITY,DEFAULT_TIME_TO_LIVE


	`readBoolean()` Reads a`boolean` from the bytes message stream.
	`readByte()` Reads a signed 8-bit value from the bytes message stream.
	`readBytes(byte[] value)` Reads a byte array from the bytes message stream.
	`readBytes(byte[] value, int length)` Reads a portion of the bytes message stream.
	`readChar()` Reads a Unicode character value from the bytes message stream.
	`readDouble()` Reads a`double` from the bytes message stream.
	`readFloat()` Reads a`float` from the bytes message stream.
	`readInt()` Reads a signed 32-bit integer from the bytes message stream.
	`readLong()` Reads a signed 64-bit integer from the bytes message stream.
	`readShort()` Reads a signed 16-bit number from the bytes message stream.
	`readUnsignedByte()` Reads an unsigned 8-bit number from the bytes message stream.
	`readUnsignedShort()` Reads an unsigned 16-bit number from the bytes message stream.
	`readUTF()` Reads a string that has been encoded using a modified UTF-8 format from the bytes message stream.
	`reset()` Puts the message body in read-only mode and repositions the stream of bytes to the beginning.
	`writeBoolean(boolean value)` Writes a`boolean` to the bytes message stream as a 1-byte value.
	`writeByte(byte value)` Writes a`byte` to the bytes message stream as a 1-byte value.
	`writeBytes(byte[] value)` Writes a byte array to the bytes message stream.
	`writeBytes(byte[] value, int offset, int length)` Writes a portion of a byte array to the bytes message stream.
	`writeChar(char value)` Writes a`char` to the bytes message stream as a 2-byte value, high byte first.
	`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.
	`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.
	`writeInt(int value)` Writes an`int` to the bytes message stream as four bytes, high byte first.
	`writeLong(long value)` Writes a`long` to the bytes message stream as eight bytes, high byte first.
	`writeObject(java.lang.Object value)` Writes an object to the bytes message stream.
	`writeShort(short value)` Writes a`short` to the bytes message stream as two bytes, high byte first.
	`writeUTF(java.lang.String value)` Writes a string to the bytes message stream using UTF-8 encoding in a machine-independent manner.

Methods inherited from interface javax.jms.Message

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,setStringProperty

readBoolean

public booleanreadBoolean()                    throwsJMSException

Reads aboolean from the bytes message stream.

Returns:: theboolean 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 bytereadByte()              throwsJMSException

Reads a signed 8-bit value from the bytes message stream.

Returns:: the next byte from the bytes message stream as a signed 8-bitbyte
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 intreadUnsignedByte()                     throwsJMSException

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 shortreadShort()                throwsJMSException

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 intreadUnsignedShort()                      throwsJMSException

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 charreadChar()              throwsJMSException

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 intreadInt()            throwsJMSException

Reads a signed 32-bit integer from the bytes message stream.

Returns:: the next four bytes from the bytes message stream, interpreted as anint
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 longreadLong()              throwsJMSException

Reads a signed 64-bit integer from the bytes message stream.

Returns:: the next eight bytes from the bytes message stream, interpreted as along
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 floatreadFloat()                throwsJMSException

Reads afloat from the bytes message stream.

Returns:: the next four bytes from the bytes message stream, interpreted as afloat
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 doublereadDouble()                  throwsJMSException

Reads adouble from the bytes message stream.

Returns:: the next eight bytes from the bytes message stream, interpreted as adouble
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 java.lang.StringreadUTF()                         throwsJMSException

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 intreadBytes(byte[] value)              throwsJMSException

Reads a byte array from the bytes message stream.

If the length of arrayvalue 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 arrayvalue, 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 intreadBytes(byte[] value,                     int length)              throwsJMSException

Reads a portion of the bytes message stream.

If the length of arrayvalue 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.

Iflength is negative, orlength is greater than the length of the arrayvalue, then anIndexOutOfBoundsException is thrown. No bytes will be read from the stream for this exception case.

Parameters:: value - the buffer into which the data is read; length - the number of bytes to read; must be less than or equal tovalue.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 voidwriteBoolean(boolean value)                  throwsJMSException

Writes aboolean to the bytes message stream as a 1-byte value. The valuetrue is written as the value(byte)1; the valuefalse is written as the value(byte)0.

Parameters:: value - theboolean 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 voidwriteByte(byte value)               throwsJMSException

Writes abyte to the bytes message stream as a 1-byte value.

Parameters:: value - thebyte 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 voidwriteShort(short value)                throwsJMSException

Writes ashort to the bytes message stream as two bytes, high byte first.

Parameters:: value - theshort 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 voidwriteChar(char value)               throwsJMSException

Writes achar to the bytes message stream as a 2-byte value, high byte first.

Parameters:: value - thechar 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 voidwriteInt(int value)              throwsJMSException

Writes anint to the bytes message stream as four bytes, high byte first.

Parameters:: value - theint 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 voidwriteLong(long value)               throwsJMSException

Writes along to the bytes message stream as eight bytes, high byte first.

Parameters:: value - thelong 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 voidwriteFloat(float value)                throwsJMSException

Converts thefloat argument to anint using thefloatToIntBits method in classFloat, and then writes thatint value to the bytes message stream as a 4-byte quantity, high byte first.

Parameters:: value - thefloat 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 voidwriteDouble(double value)                 throwsJMSException

Converts thedouble argument to along using thedoubleToLongBits method in classDouble, and then writes thatlong value to the bytes message stream as an 8-byte quantity, high byte first.

Parameters:: value - thedouble 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 voidwriteUTF(java.lang.String value)              throwsJMSException

Writes a string to the bytes message stream using UTF-8 encoding in a machine-independent manner.

Parameters:: value - theString 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 voidwriteBytes(byte[] value)                throwsJMSException

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 voidwriteBytes(byte[] value,                       int offset,                       int length)                throwsJMSException

Writes a portion of a byte array to the bytes message stream.

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:: 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 voidwriteObject(java.lang.Object value)                 throwsJMSException

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 parametervalue is null.

reset

public voidreset()           throwsJMSException

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.

[8]ページ先頭