Movatterモバイル変換

Interface StreamMessage

All Superinterfaces:: Message

public interfaceStreamMessage
extendsMessage

AStreamMessage object is used to send a stream of primitive types in the Java programming language. It is filled and read sequentially. It inherits from theMessage interface and adds a stream message body. Its methods are based largely on those found injava.io.DataInputStream andjava.io.DataOutputStream.

The primitive types can be read or written explicitly using methods for each type. They may also be read or written generically as objects. For instance, a call toStreamMessage.writeInt(6) is equivalent toStreamMessage.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 body 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.

StreamMessage objects support the following conversion table. The marked cases must be supported. The unmarked cases must throw aJMSException. TheString-to-primitive conversions may throw a runtime exception if the primitive'svalueOf() method does not accept it as a validString representation of the primitive.

A value written as the row type can be read as the column type.

 |        | boolean byte short char int long float double String byte[] |---------------------------------------------------------------------- |boolean |    X                                            X |byte    |          X     X         X   X                  X    |short   |                X         X   X                  X    |char    |                     X                           X |int     |                          X   X                  X    |long    |                              X                  X    |float   |                                    X     X      X    |double  |                                          X      X    |String  |    X     X     X         X   X     X     X      X    |byte[]  |                                                        X |----------------------------------------------------------------------

Attempting to read a null value as a primitive type must be treated as calling the primitive's correspondingvalueOf(String) conversion method with a null value. Sincechar does not support aString conversion, attempting to read a null value as achar must throw aNullPointerException.

See Also:: Session.createStreamMessage(),BytesMessage,MapMessage,Message,ObjectMessage,TextMessage

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE,DEFAULT_PRIORITY,DEFAULT_TIME_TO_LIVE


	`readBoolean()` Reads a`boolean` from the stream message.
	`readByte()` Reads a`byte` value from the stream message.
	`readBytes(byte[] value)` Reads a byte array field from the stream message into the specified`byte[]` object (the read buffer).
	`readChar()` Reads a Unicode character value from the stream message.
	`readDouble()` Reads a`double` from the stream message.
	`readFloat()` Reads a`float` from the stream message.
	`readInt()` Reads a 32-bit integer from the stream message.
	`readLong()` Reads a 64-bit integer from the stream message.
	`readObject()` Reads an object from the stream message.
	`readShort()` Reads a 16-bit integer from the stream message.
	`readString()` Reads a`String` from the stream message.
	`reset()` Puts the message body in read-only mode and repositions the stream to the beginning.
	`writeBoolean(boolean value)` Writes a`boolean` to the stream message.
	`writeByte(byte value)` Writes a`byte` to the stream message.
	`writeBytes(byte[] value)` Writes a byte array field to the stream message.
	`writeBytes(byte[] value, int offset, int length)` Writes a portion of a byte array as a byte array field to the stream message.
	`writeChar(char value)` Writes a`char` to the stream message.
	`writeDouble(double value)` Writes a`double` to the stream message.
	`writeFloat(float value)` Writes a`float` to the stream message.
	`writeInt(int value)` Writes an`int` to the stream message.
	`writeLong(long value)` Writes a`long` to the stream message.
	`writeObject(java.lang.Object value)` Writes an object to the stream message.
	`writeShort(short value)` Writes a`short` to the stream message.
	`writeString(java.lang.String value)` Writes a`String` to the stream message.

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 stream message.

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 message stream has been reached.; MessageFormatException - if this type conversion is invalid.; MessageNotReadableException - if the message is in write-only mode.

readByte

public bytereadByte()              throwsJMSException

Reads abyte value from the stream message.

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

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

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 invalid; MessageNotReadableException - if the message is in write-only mode.

readInt

public intreadInt()            throwsJMSException

Reads a 32-bit integer from the stream message.

Returns:: a 32-bit integer value from the stream message, interpreted as anint
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 longreadLong()              throwsJMSException

Reads a 64-bit integer from the stream message.

Returns:: a 64-bit integer value from the stream message, interpreted as along
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 floatreadFloat()                throwsJMSException

Reads afloat from the stream message.

Returns:: afloat 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 doublereadDouble()                  throwsJMSException

Reads adouble from the stream message.

Returns:: adouble 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 java.lang.StringreadString()                            throwsJMSException

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

Reads a byte array field from the stream message into the specifiedbyte[] 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.

IfreadBytes returns a value equal to the length of the buffer, a subsequentreadBytes 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 firstreadBytes call on abyte[] 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 aMessageFormatException.

To read the byte field value into a newbyte[] object, use thereadObject 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 java.lang.ObjectreadObject()                            throwsJMSException

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 equivalentwriteObject method call, or its equivalent primitivewritetype method.

Note that byte values are returned asbyte[], notByte[].

An attempt to callreadObject to read a byte field value into a newbyte[] object before the full value of the byte field has been read will throw aMessageFormatException.

Returns:: a Java object from the stream message, in objectified format (for example, if the object was written as anint, anInteger 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 voidwriteBoolean(boolean value)                  throwsJMSException

Writes aboolean to the stream message. 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 stream message.

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 stream message.

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

Writes achar to the stream message.

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 stream message.

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

Writes along to the stream message.

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

Writes afloat to the stream message.

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

Writes adouble to the stream message.

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.

writeString

public voidwriteString(java.lang.String value)                 throwsJMSException

Writes aString to the stream message.

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 field to the stream message.

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

Writes a portion of a byte array as a byte array field to the stream message.

The a portion of the byte arrayvalue 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; 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 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 voidreset()           throwsJMSException

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.

[8]ページ先頭