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.mq
Class SpyMapMessage

java.lang.Object
  extended byorg.jboss.mq.SpyMessage (src) 
      extended byorg.jboss.mq.SpyMapMessage
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable, java.io.Externalizable, MapMessage (src) , Message (src) , java.io.Serializable
public class SpyMapMessage
extends SpyMessage (src)
implements MapMessage (src) , java.io.Externalizable

This class implements javax.jms.MapMessage

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class org.jboss.mq.SpyMessage (src)
SpyMessage.Header (src)
 
Field Summary
 
Fields inherited from class org.jboss.mq.SpyMessage (src)
ack, BOOLEAN, BYTE, BYTES_MESS, DOUBLE, ENCAP_MESS, FLOAT, header, INT, LONG, MAP_MESS, NULL, OBJECT, OBJECT_MESS, PROPERTY_REDELIVERY_COUNT, PROPERTY_REDELIVERY_DELAY, PROPERTY_REDELIVERY_LIMIT, PROPERTY_SCHEDULED_DELIVERY, session, SHORT, SPY_MESS, STREAM_MESS, STRING, TEXT_MESS
 
Fields inherited from interface javax.jms.Message (src)
DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE
 
Constructor Summary
SpyMapMessage()
          Create a new SpyMapMessage
 
Method Summary
 void clearBody()
          Clears out the message body.
 boolean getBoolean(java.lang.String name)
          Returns the boolean value with the specified name.
 byte getByte(java.lang.String name)
          Returns the byte value with the specified name.
 byte[] getBytes(java.lang.String name)
          Returns the byte array value with the specified name.
 char getChar(java.lang.String name)
          Returns the Unicode character value with the specified name.
 double getDouble(java.lang.String name)
          Returns the double value with the specified name.
 float getFloat(java.lang.String name)
          Returns the float value with the specified name.
 int getInt(java.lang.String name)
          Returns the int value with the specified name.
 long getLong(java.lang.String name)
          Returns the long value with the specified name.
 java.util.Enumeration getMapNames()
          Returns an Enumeration of all the names in the MapMessage object.
 java.lang.Object getObject(java.lang.String name)
          Returns the value of the object with the specified name.
 short getShort(java.lang.String name)
          Returns the short value with the specified name.
 java.lang.String getString(java.lang.String name)
          Returns the String value with the specified name.
 boolean itemExists(java.lang.String name)
          Indicates whether an item exists in this MapMessage object.
 SpyMessage (src) myClone()
          Clone the message
 void readExternal(java.io.ObjectInput in)
           
 void setBoolean(java.lang.String name, boolean value)
          Sets a boolean value with the specified name into the Map.
 void setByte(java.lang.String name, byte value)
          Sets a byte value with the specified name into the Map.
 void setBytes(java.lang.String name, byte[] value)
          Sets a byte array value with the specified name into the Map.
 void setBytes(java.lang.String name, byte[] value, int offset, int length)
          Sets a portion of the byte array value with the specified name into the Map.
 void setChar(java.lang.String name, char value)
          Sets a Unicode character value with the specified name into the Map.
 void setDouble(java.lang.String name, double value)
          Sets a double value with the specified name into the Map.
 void setFloat(java.lang.String name, float value)
          Sets a float value with the specified name into the Map.
 void setInt(java.lang.String name, int value)
          Sets an int value with the specified name into the Map.
 void setLong(java.lang.String name, long value)
          Sets a long value with the specified name into the Map.
 void setObject(java.lang.String name, java.lang.Object value)
          Sets an object value with the specified name into the Map.
 void setShort(java.lang.String name, short value)
          Sets a short value with the specified name into the Map.
 void setString(java.lang.String name, java.lang.String value)
          Sets a String value with the specified name into the Map.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class org.jboss.mq.SpyMessage (src)
acknowledge, clearProperties, compareTo, copyProps, createAcknowledgementRequest, doAcknowledge, doNegAcknowledge, getAcknowledgementRequest, getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getObjectProperty, getPropertyNames, getShortProperty, getStringProperty, isOutdated, propertyExists, readMessage, setBooleanProperty, setByteProperty, setDoubleProperty, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setObjectProperty, setReadOnlyMode, setShortProperty, setStringProperty, toString, writeMessage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.jms.Message (src)
acknowledge, 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

SpyMapMessage

public SpyMapMessage()
Create a new SpyMapMessage

Method Detail

setBoolean

public void setBoolean(java.lang.String name,
                       boolean value)
                throws JMSException (src)
Description copied from interface: MapMessage (src)
Sets a boolean value with the specified name into the Map.

Specified by:
setBoolean in interface MapMessage (src)
Parameters:
name - the name of the boolean
value - the boolean value to set in the Map
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

setByte

public void setByte(java.lang.String name,
                    byte value)
             throws JMSException (src)
Description copied from interface: MapMessage (src)
Sets a byte value with the specified name into the Map.

Specified by:
setByte in interface MapMessage (src)
Parameters:
name - the name of the byte
value - the byte value to set in the Map
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

setShort

public void setShort(java.lang.String name,
                     short value)
              throws JMSException (src)
Description copied from interface: MapMessage (src)
Sets a short value with the specified name into the Map.

Specified by:
setShort in interface MapMessage (src)
Parameters:
name - the name of the short
value - the short value to set in the Map
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

setChar

public void setChar(java.lang.String name,
                    char value)
             throws JMSException (src)
Description copied from interface: MapMessage (src)
Sets a Unicode character value with the specified name into the Map.

Specified by:
setChar in interface MapMessage (src)
Parameters:
name - the name of the Unicode character
value - the Unicode character value to set in the Map
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

setInt

public void setInt(java.lang.String name,
                   int value)
            throws JMSException (src)
Description copied from interface: MapMessage (src)
Sets an int value with the specified name into the Map.

Specified by:
setInt in interface MapMessage (src)
Parameters:
name - the name of the int
value - the int value to set in the Map
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

setLong

public void setLong(java.lang.String name,
                    long value)
             throws JMSException (src)
Description copied from interface: MapMessage (src)
Sets a long value with the specified name into the Map.

Specified by:
setLong in interface MapMessage (src)
Parameters:
name - the name of the long
value - the long value to set in the Map
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

setFloat

public void setFloat(java.lang.String name,
                     float value)
              throws JMSException (src)
Description copied from interface: MapMessage (src)
Sets a float value with the specified name into the Map.

Specified by:
setFloat in interface MapMessage (src)
Parameters:
name - the name of the float
value - the float value to set in the Map
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

setDouble

public void setDouble(java.lang.String name,
                      double value)
               throws JMSException (src)
Description copied from interface: MapMessage (src)
Sets a double value with the specified name into the Map.

Specified by:
setDouble in interface MapMessage (src)
Parameters:
name - the name of the double
value - the double value to set in the Map
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

setString

public void setString(java.lang.String name,
                      java.lang.String value)
               throws JMSException (src)
Description copied from interface: MapMessage (src)
Sets a String value with the specified name into the Map.

Specified by:
setString in interface MapMessage (src)
Parameters:
name - the name of the String
value - the String value to set in the Map
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

setBytes

public void setBytes(java.lang.String name,
                     byte[] value)
              throws JMSException (src)
Description copied from interface: MapMessage (src)
Sets a byte array value with the specified name into the Map.

Specified by:
setBytes in interface MapMessage (src)
Parameters:
name - the name of the byte array
value - the byte array value to set in the Map; the array is copied so that the value for name will not be altered by future modifications
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

setBytes

public void setBytes(java.lang.String name,
                     byte[] value,
                     int offset,
                     int length)
              throws JMSException (src)
Description copied from interface: MapMessage (src)
Sets a portion of the byte array value with the specified name into the Map.

Specified by:
setBytes in interface MapMessage (src)
Parameters:
name - the name of the byte array
value - the byte array value to set in the Map
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.

setObject

public void setObject(java.lang.String name,
                      java.lang.Object value)
               throws JMSException (src)
Description copied from interface: MapMessage (src)
Sets an object value with the specified name into the Map.

This method works only for the objectified primitive object types (Integer, Double, Long ...), String objects, and byte arrays.

Specified by:
setObject in interface MapMessage (src)
Parameters:
name - the name of the Java object
value - the Java object value to set in the Map
Throws:
JMSException (src) - if the JMS provider fails to write the message due to some internal error.

getBoolean

public boolean getBoolean(java.lang.String name)
                   throws JMSException (src)
Description copied from interface: MapMessage (src)
Returns the boolean value with the specified name.

Specified by:
getBoolean in interface MapMessage (src)
Parameters:
name - the name of the boolean
Returns:
the boolean value with the specified name
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

getByte

public byte getByte(java.lang.String name)
             throws JMSException (src)
Description copied from interface: MapMessage (src)
Returns the byte value with the specified name.

Specified by:
getByte in interface MapMessage (src)
Parameters:
name - the name of the byte
Returns:
the byte value with the specified name
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

getShort

public short getShort(java.lang.String name)
               throws JMSException (src)
Description copied from interface: MapMessage (src)
Returns the short value with the specified name.

Specified by:
getShort in interface MapMessage (src)
Parameters:
name - the name of the short
Returns:
the short value with the specified name
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

getChar

public char getChar(java.lang.String name)
             throws JMSException (src)
Description copied from interface: MapMessage (src)
Returns the Unicode character value with the specified name.

Specified by:
getChar in interface MapMessage (src)
Parameters:
name - the name of the Unicode character
Returns:
the Unicode character value with the specified name
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

getInt

public int getInt(java.lang.String name)
           throws JMSException (src)
Description copied from interface: MapMessage (src)
Returns the int value with the specified name.

Specified by:
getInt in interface MapMessage (src)
Parameters:
name - the name of the int
Returns:
the int value with the specified name
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

getLong

public long getLong(java.lang.String name)
             throws JMSException (src)
Description copied from interface: MapMessage (src)
Returns the long value with the specified name.

Specified by:
getLong in interface MapMessage (src)
Parameters:
name - the name of the long
Returns:
the long value with the specified name
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

getFloat

public float getFloat(java.lang.String name)
               throws JMSException (src)
Description copied from interface: MapMessage (src)
Returns the float value with the specified name.

Specified by:
getFloat in interface MapMessage (src)
Parameters:
name - the name of the float
Returns:
the float value with the specified name
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

getDouble

public double getDouble(java.lang.String name)
                 throws JMSException (src)
Description copied from interface: MapMessage (src)
Returns the double value with the specified name.

Specified by:
getDouble in interface MapMessage (src)
Parameters:
name - the name of the double
Returns:
the double value with the specified name
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

getString

public java.lang.String getString(java.lang.String name)
                           throws JMSException (src)
Description copied from interface: MapMessage (src)
Returns the String value with the specified name.

Specified by:
getString in interface MapMessage (src)
Parameters:
name - the name of the String
Returns:
the String value with the specified name; if there is no item by this name, a null value is returned
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

getBytes

public byte[] getBytes(java.lang.String name)
                throws JMSException (src)
Description copied from interface: MapMessage (src)
Returns the byte array value with the specified name.

Specified by:
getBytes in interface MapMessage (src)
Parameters:
name - the name of the byte array
Returns:
a copy of the byte array value with the specified name; if there is no item by this name, a null value is returned.
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

getObject

public java.lang.Object getObject(java.lang.String name)
                           throws JMSException (src)
Description copied from interface: MapMessage (src)
Returns the value of the object with the specified name.

This method can be used to return, in objectified format, an object in the Java programming language ("Java object") that had been stored in the Map with the equivalent setObject method call, or its equivalent primitive settype method.

Note that byte values are returned as byte[], not Byte[].

Specified by:
getObject in interface MapMessage (src)
Parameters:
name - the name of the Java object
Returns:
a copy of the Java object value with the specified name, in objectified format (for example, if the object was set as an int, an Integer is returned); if there is no item by this name, a null value is returned
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

getMapNames

public java.util.Enumeration getMapNames()
                                  throws JMSException (src)
Description copied from interface: MapMessage (src)
Returns an Enumeration of all the names in the MapMessage object.

Specified by:
getMapNames in interface MapMessage (src)
Returns:
an enumeration of all the names in this MapMessage
Throws:
JMSException (src) - if the JMS provider fails to read the message due to some internal error.

itemExists

public boolean itemExists(java.lang.String name)
                   throws JMSException (src)
Description copied from interface: MapMessage (src)
Indicates whether an item exists in this MapMessage object.

Specified by:
itemExists in interface MapMessage (src)
Parameters:
name - the name of the item to test
Returns:
true if the item exists
Throws:
JMSException (src) - if the JMS provider fails to determine if the item exists due to some internal error.

clearBody

public void clearBody()
               throws JMSException (src)
Description copied from interface: Message (src)
Clears out the message body. Clearing a message's body does not clear its header values or property entries.

If this message body was read-only, calling this method leaves the message body in the same state as an empty body in a newly created message.

Specified by:
clearBody in interface Message (src)
Overrides:
clearBody in class SpyMessage (src)
Throws:
JMSException (src) - for any error

myClone

public SpyMessage (src)  myClone()
                   throws JMSException (src)
Description copied from class: SpyMessage (src)
Clone the message

Overrides:
myClone in class SpyMessage (src)
Returns:
the cloned message
Throws:
JMSException (src) - for any error

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Overrides:
writeExternal in class SpyMessage (src)
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Overrides:
readExternal in class SpyMessage (src)
Throws:
java.io.IOException
java.lang.ClassNotFoundException
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