Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.resource.adapter.jms
Class JmsStreamMessage

java.lang.Object
  extended byorg.jboss.resource.adapter.jms.JmsMessage (src) 
      extended byorg.jboss.resource.adapter.jms.JmsStreamMessage
All Implemented Interfaces:
Message (src) , StreamMessage (src)
public class JmsStreamMessage
extends JmsMessage (src)
implements StreamMessage (src)

A wrapper for a message

Field Summary
 
Fields inherited from interface javax.jms.Message (src)
DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE
 
Constructor Summary
JmsStreamMessage(StreamMessage (src)  message, JmsSession (src)  session)
          Create a new wrapper
 
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.
 java.lang.Object readObject()
          Reads an object from the stream message.
 short readShort()
          Reads a 16-bit integer from the stream message.
 java.lang.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(java.lang.Object value)
          Writes an object to the stream message.
 void writeShort(short value)
          Writes a short to the stream message.
 void writeString(java.lang.String value)
          Writes a String to the stream message.
 
Methods inherited from class org.jboss.resource.adapter.jms.JmsMessage (src)
acknowledge, clearBody, clearProperties, equals, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, hashCode, propertyExists, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setShortProperty, setStringProperty, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.jms.Message (src)
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
 

Constructor Detail

JmsStreamMessage

public JmsStreamMessage(StreamMessage (src)  message,
                        JmsSession (src)  session)
Create a new wrapper

Parameters:
message - the message
session - the session
Method Detail

readBoolean

public boolean readBoolean()
                    throws JMSException (src)
Description copied from interface: StreamMessage (src)
Reads a boolean from the stream message.

Specified by:
readBoolean in interface StreamMessage (src)
Returns:
the boolean value read
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

readByte

public byte readByte()
              throws JMSException (src)
Description copied from interface: StreamMessage (src)
Reads a byte value from the stream message.

Specified by:
readByte in interface StreamMessage (src)
Returns:
the next byte from the stream message as a 8-bit byte
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

readBytes

public int readBytes(byte[] value)
              throws JMSException (src)
Description copied from interface: StreamMessage (src)
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.

Specified by:
readBytes in interface StreamMessage (src)
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 (src) - if the JMS provider fails to read the message due to some internal error.
See Also:
StreamMessage.readObject()

readChar

public char readChar()
              throws JMSException (src)
Description copied from interface: StreamMessage (src)
Reads a Unicode character value from the stream message.

Specified by:
readChar in interface StreamMessage (src)
Returns:
a Unicode character from the stream message
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

readDouble

public double readDouble()
                  throws JMSException (src)
Description copied from interface: StreamMessage (src)
Reads a double from the stream message.

Specified by:
readDouble in interface StreamMessage (src)
Returns:
a double value from the stream message
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

readFloat

public float readFloat()
                throws JMSException (src)
Description copied from interface: StreamMessage (src)
Reads a float from the stream message.

Specified by:
readFloat in interface StreamMessage (src)
Returns:
a float value from the stream message
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

readInt

public int readInt()
            throws JMSException (src)
Description copied from interface: StreamMessage (src)
Reads a 32-bit integer from the stream message.

Specified by:
readInt in interface StreamMessage (src)
Returns:
a 32-bit integer value from the stream message, interpreted as an int
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

readLong

public long readLong()
              throws JMSException (src)
Description copied from interface: StreamMessage (src)
Reads a 64-bit integer from the stream message.

Specified by:
readLong in interface StreamMessage (src)
Returns:
a 64-bit integer value from the stream message, interpreted as a long
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

readObject

public java.lang.Object readObject()
                            throws JMSException (src)
Description copied from interface: StreamMessage (src)
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.

Specified by:
readObject in interface StreamMessage (src)
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 (src) - if the JMS provider fails to read the message due to some internal error.
See Also:
StreamMessage.readBytes(byte[] value)

readShort

public short readShort()
                throws JMSException (src)
Description copied from interface: StreamMessage (src)
Reads a 16-bit integer from the stream message.

Specified by:
readShort in interface StreamMessage (src)
Returns:
a 16-bit integer from the stream message
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

readString

public java.lang.String readString()
                            throws JMSException (src)
Description copied from interface: StreamMessage (src)
Reads a String from the stream message.

Specified by:
readString in interface StreamMessage (src)
Returns:
a Unicode string from the stream message
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

reset

public void reset()
           throws JMSException (src)
Description copied from interface: StreamMessage (src)
Puts the message body in read-only mode and repositions the stream to the beginning.

Specified by:
reset in interface StreamMessage (src)
Throws:
JMSException (src) - if the JMS provider fails to reset the message due to some internal error.

writeBoolean

public void writeBoolean(boolean value)
                  throws JMSException (src)
Description copied from interface: StreamMessage (src)
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.

Specified by:
writeBoolean in interface StreamMessage (src)
Parameters:
value - the boolean value to be written
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

writeByte

public void writeByte(byte value)
               throws JMSException (src)
Description copied from interface: StreamMessage (src)
Writes a byte to the stream message.

Specified by:
writeByte in interface StreamMessage (src)
Parameters:
value - the byte value to be written
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

writeBytes

public void writeBytes(byte[] value,
                       int offset,
                       int length)
                throws JMSException (src)
Description copied from interface: StreamMessage (src)
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.

Specified by:
writeBytes in interface StreamMessage (src)
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 (src) - if the JMS provider fails to write the message due to some internal error.

writeBytes

public void writeBytes(byte[] value)
                throws JMSException (src)
Description copied from interface: StreamMessage (src)
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.

Specified by:
writeBytes in interface StreamMessage (src)
Parameters:
value - the byte array value to be written
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

writeChar

public void writeChar(char value)
               throws JMSException (src)
Description copied from interface: StreamMessage (src)
Writes a char to the stream message.

Specified by:
writeChar in interface StreamMessage (src)
Parameters:
value - the char value to be written
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

writeDouble

public void writeDouble(double value)
                 throws JMSException (src)
Description copied from interface: StreamMessage (src)
Writes a double to the stream message.

Specified by:
writeDouble in interface StreamMessage (src)
Parameters:
value - the double value to be written
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

writeFloat

public void writeFloat(float value)
                throws JMSException (src)
Description copied from interface: StreamMessage (src)
Writes a float to the stream message.

Specified by:
writeFloat in interface StreamMessage (src)
Parameters:
value - the float value to be written
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

writeInt

public void writeInt(int value)
              throws JMSException (src)
Description copied from interface: StreamMessage (src)
Writes an int to the stream message.

Specified by:
writeInt in interface StreamMessage (src)
Parameters:
value - the int value to be written
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

writeLong

public void writeLong(long value)
               throws JMSException (src)
Description copied from interface: StreamMessage (src)
Writes a long to the stream message.

Specified by:
writeLong in interface StreamMessage (src)
Parameters:
value - the long value to be written
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

writeObject

public void writeObject(java.lang.Object value)
                 throws JMSException (src)
Description copied from interface: StreamMessage (src)
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.

Specified by:
writeObject in interface StreamMessage (src)
Parameters:
value - the Java object to be written
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

writeShort

public void writeShort(short value)
                throws JMSException (src)
Description copied from interface: StreamMessage (src)
Writes a short to the stream message.

Specified by:
writeShort in interface StreamMessage (src)
Parameters:
value - the short value to be written
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

writeString

public void writeString(java.lang.String value)
                 throws JMSException (src)
Description copied from interface: StreamMessage (src)
Writes a String to the stream message.

Specified by:
writeString in interface StreamMessage (src)
Parameters:
value - the String value to be written
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD