Package com.swiftmq.jms

Class MapMessageImpl

java.lang.Object

com.swiftmq.jms.MessageImpl

com.swiftmq.jms.MapMessageImpl

All Implemented Interfaces:

Serializable, javax.jms.MapMessage, javax.jms.Message

public class MapMessageImpl
extends MessageImpl
implements javax.jms.MapMessage

Implementation of a MapMessage.

Author:

IIT GmbH, Bremen/Germany, Copyright (c) 2000-2002, All Rights Reserved

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.swiftmq.jms.MessageImpl

DEFAULT_PRIORITY, MAX_PRIORITY, MIN_PRIORITY, PROP_CLIENT_ID, PROP_DELIVERY_COUNT, PROP_DOUBT_DUPLICATE, PROP_UNROUTABLE_REASON, PROP_USER_ID

Fields inherited from interface javax.jms.Message

DEFAULT_DELIVERY_MODE, DEFAULT_PRIORITY, DEFAULT_TIME_TO_LIVE

Constructor Summary

Constructors

Constructor	Description
MapMessageImpl()

Method Summary

Modifier and Type	Method	Description
void	clearBody()	Clear out the message body.
boolean	getBoolean(String name)
byte	getByte(String name)	Return the byte value with the given name.
byte[]	getBytes(String name)	Return the byte array value with the given name.
char	getChar(String name)	Return the Unicode character value with the given name.
double	getDouble(String name)	Return the double value with the given name.
float	getFloat(String name)	Return the float value with the given name.
int	getInt(String name)	Return the integer value with the given name.
long	getLong(String name)	Return the long value with the given name.
Enumeration	getMapNames()	Return an Enumeration of all the Map message's names.
Object	getObject(String name)	Return the Java object value with the given name.
short	getShort(String name)	Return the short value with the given name.
String	getString(String name)	Return the String value with the given name.
protected int	getType()
boolean	itemExists(String name)	Check if an item exists in this MapMessage.
protected void	readBody(DataInput in)
void	setBoolean(String name, boolean value)	Set a boolean value with the given name, into the Map.
void	setByte(String name, byte value)	Set a byte value with the given name, into the Map.
void	setBytes(String name, byte[] value)	Set a byte array value with the given name, into the Map.
void	setBytes(String name, byte[] value, int offset, int length)	Set a portion of the byte array value with the given name, into the Map.
void	setChar(String name, char value)	Set a Unicode character value with the given name, into the Map.
void	setDouble(String name, double value)	Set a double value with the given name, into the Map.
void	setFloat(String name, float value)	Set a float value with the given name, into the Map.
void	setInt(String name, int value)	Set an integer value with the given name, into the Map.
void	setLong(String name, long value)	Set a long value with the given name, into the Map.
void	setObject(String name, Object value)	Set a Java object value with the given name, into the Map.
void	setReadOnly(boolean b)
void	setShort(String name, short value)	Set a short value with the given name, into the Map.
void	setString(String name, String value)	Set a String value with the given name, into the Map.
String	toString()
protected void	unfoldBody()
protected void	writeBody(DataOutput out)

Methods inherited from class com.swiftmq.jms.MessageImpl

acknowledge, clearProperties, clearSwiftMQAllProps, clearSwiftMQProps, createInstance, getBooleanProperty, getByteProperty, getDestQueue, getDestRouter, getDoubleProperty, getDuplicateId, getField, getFloatProperty, getIntProperty, getJMSCorrelationID, getJMSCorrelationIDAsBytes, getJMSDeliveryMode, getJMSDestination, getJMSExpiration, getJMSMessageID, getJMSPriority, getJMSRedelivered, getJMSReplyTo, getJMSTimestamp, getJMSType, getLongProperty, getMessageIndex, getMessageLength, getObjectProperty, getPersistentKey, getPropertyNames, getShortProperty, getSourceRouter, getStreamPKey, getStringProperty, isCancelled, propertyExists, readContent, readContent, removeProperty, reset, setBooleanProperty, setByteProperty, setDestQueue, setDestRouter, setDoubleProperty, setDuplicateId, setFloatProperty, setIntProperty, setJMSCorrelationID, setJMSCorrelationIDAsBytes, setJMSDeliveryMode, setJMSDestination, setJMSExpiration, setJMSMessageID, setJMSPriority, setJMSRedelivered, setJMSReplyTo, setJMSTimestamp, setJMSType, setLongProperty, setMessageConsumerImpl, setMessageIndex, setObjectProperty, setPersistentKey, setSessionImpl, setShortProperty, setSourceRouter, setStreamPKey, setStringProperty, setUseThreadContextCL, unfoldBuffers, writeContent, writeContent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.jms.Message

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 Details

MapMessageImpl

public MapMessageImpl()

Method Details

getType

protected int getType()

Overrides:

getType in class MessageImpl

setReadOnly

public void setReadOnly(boolean b)

Overrides:

setReadOnly in class MessageImpl

writeBody

protected void writeBody(DataOutput out)
                  throws IOException

Overrides:

writeBody in class MessageImpl

Throws:

IOException

readBody

protected void readBody(DataInput in)
                 throws IOException

Overrides:

readBody in class MessageImpl

Throws:

IOException

unfoldBody

protected void unfoldBody()

Overrides:

unfoldBody in class MessageImpl

getBoolean

public boolean getBoolean(String name)
                   throws javax.jms.JMSException

Specified by:

getBoolean in interface javax.jms.MapMessage

Throws:

javax.jms.JMSException

getByte

public byte getByte(String name)
             throws javax.jms.JMSException

Return the byte value with the given name.

Specified by:

getByte in interface javax.jms.MapMessage

Parameters:

name - the name of the byte

Returns:

the byte value with the given name.

Throws:

javax.jms.JMSException - if JMS fails to read message due to some internal JMS error.

javax.jms.MessageFormatException - if this type conversion is invalid.

getShort

public short getShort(String name)
               throws javax.jms.JMSException

Return the short value with the given name.

Specified by:

getShort in interface javax.jms.MapMessage

Parameters:

name - the name of the short

Returns:

the short value with the given name.

Throws:

javax.jms.JMSException - if JMS fails to read message due to some internal JMS error.

javax.jms.MessageFormatException - if this type conversion is invalid.

getChar

public char getChar(String name)
             throws javax.jms.JMSException

Return the Unicode character value with the given name.

Specified by:

getChar in interface javax.jms.MapMessage

Parameters:

name - the name of the Unicode character

Returns:

the Unicode character value with the given name.

Throws:

javax.jms.JMSException - if JMS fails to read message due to some internal JMS error.

javax.jms.MessageFormatException - if this type conversion is invalid.

getInt

public int getInt(String name)
           throws javax.jms.JMSException

Return the integer value with the given name.

Specified by:

getInt in interface javax.jms.MapMessage

Parameters:

name - the name of the integer

Returns:

the integer value with the given name.

Throws:

javax.jms.JMSException - if JMS fails to read message due to some internal JMS error.

javax.jms.MessageFormatException - if this type conversion is invalid.

getLong

public long getLong(String name)
             throws javax.jms.JMSException

Return the long value with the given name.

Specified by:

getLong in interface javax.jms.MapMessage

Parameters:

name - the name of the long

Returns:

the long value with the given name.

Throws:

javax.jms.JMSException - if JMS fails to read message due to some internal JMS error.

javax.jms.MessageFormatException - if this type conversion is invalid.

getFloat

public float getFloat(String name)
               throws javax.jms.JMSException

Return the float value with the given name.

Specified by:

getFloat in interface javax.jms.MapMessage

Parameters:

name - the name of the float

Returns:

the float value with the given name.

Throws:

javax.jms.JMSException - if JMS fails to read message due to some internal JMS error.

javax.jms.MessageFormatException - if this type conversion is invalid.

getDouble

public double getDouble(String name)
                 throws javax.jms.JMSException

Return the double value with the given name.

Specified by:

getDouble in interface javax.jms.MapMessage

Parameters:

name - the name of the double

Returns:

the double value with the given name.

Throws:

javax.jms.JMSException - if JMS fails to read message due to some internal JMS error.

javax.jms.MessageFormatException - if this type conversion is invalid.

getString

public String getString(String name)
                 throws javax.jms.JMSException

Return the String value with the given name.

Specified by:

getString in interface javax.jms.MapMessage

Parameters:

name - the name of the String

Returns:

the String value with the given name. If there is no item by this name, a null value is returned.

Throws:

javax.jms.JMSException - if JMS fails to read message due to some internal JMS error.

javax.jms.MessageFormatException - if this type conversion is invalid.

getBytes

public byte[] getBytes(String name)
                throws javax.jms.JMSException

Return the byte array value with the given name.

Specified by:

getBytes in interface javax.jms.MapMessage

Parameters:

name - the name of the byte array

Returns:

the byte array value with the given name. If there is no item by this name, a null value is returned.

Throws:

javax.jms.JMSException - if JMS fails to read message due to some internal JMS error.

javax.jms.MessageFormatException - if this type conversion is invalid.

getObject

public Object getObject(String name)
                 throws javax.jms.JMSException

Return the Java object value with the given name.

Note that this method can be used to return in objectified format, an object that had been stored in the Map with the equivalent setObject method call, or it's equivalent primitive set method.

Specified by:

getObject in interface javax.jms.MapMessage

Parameters:

name - the name of the Java object

Returns:

the Java object value with the given name, in objectified format (ie. if it set as an int, then a Integer is returned). If there is no item by this name, a null value is returned.

Throws:

javax.jms.JMSException - if JMS fails to read message due to some internal JMS error.

getMapNames

public Enumeration getMapNames()
                        throws javax.jms.JMSException

Return an Enumeration of all the Map message's names.

Specified by:

getMapNames in interface javax.jms.MapMessage

Returns:

an enumeration of all the names in this Map message.

Throws:

javax.jms.JMSException - if JMS fails to read message due to some internal JMS error.

setBoolean

public void setBoolean(String name,
 boolean value)
                throws javax.jms.JMSException

Set a boolean value with the given name, into the Map.

Specified by:

setBoolean in interface javax.jms.MapMessage

Parameters:

name - the name of the boolean

value - the boolean value to set in the Map.

Throws:

javax.jms.JMSException - if JMS fails to write message due to some internal JMS error.

javax.jms.MessageNotWriteableException - if message in read-only mode.

setByte

public void setByte(String name,
 byte value)
             throws javax.jms.JMSException

Set a byte value with the given name, into the Map.

Specified by:

setByte in interface javax.jms.MapMessage

Parameters:

name - the name of the byte

value - the byte value to set in the Map.

Throws:

javax.jms.JMSException - if JMS fails to write message due to some internal JMS error.

javax.jms.MessageNotWriteableException - if message in read-only mode.

setShort

public void setShort(String name,
 short value)
              throws javax.jms.JMSException

Set a short value with the given name, into the Map.

Specified by:

setShort in interface javax.jms.MapMessage

Parameters:

name - the name of the short

value - the short value to set in the Map.

Throws:

javax.jms.JMSException - if JMS fails to write message due to some internal JMS error.

javax.jms.MessageNotWriteableException - if message in read-only mode.

setChar

public void setChar(String name,
 char value)
             throws javax.jms.JMSException

Set a Unicode character value with the given name, into the Map.

Specified by:

setChar in interface javax.jms.MapMessage

Parameters:

name - the name of the Unicode character

value - the Unicode character value to set in the Map.

Throws:

javax.jms.JMSException - if JMS fails to write message due to some internal JMS error.

javax.jms.MessageNotWriteableException - if message in read-only mode.

setInt

public void setInt(String name,
 int value)
            throws javax.jms.JMSException

Set an integer value with the given name, into the Map.

Specified by:

setInt in interface javax.jms.MapMessage

Parameters:

name - the name of the integer

value - the integer value to set in the Map.

Throws:

javax.jms.JMSException - if JMS fails to write message due to some internal JMS error.

javax.jms.MessageNotWriteableException - if message in read-only mode.

setLong

public void setLong(String name,
 long value)
             throws javax.jms.JMSException

Set a long value with the given name, into the Map.

Specified by:

setLong in interface javax.jms.MapMessage

Parameters:

name - the name of the long

value - the long value to set in the Map.

Throws:

javax.jms.JMSException - if JMS fails to write message due to some internal JMS error.

javax.jms.MessageNotWriteableException - if message in read-only mode.

setFloat

public void setFloat(String name,
 float value)
              throws javax.jms.JMSException

Set a float value with the given name, into the Map.

Specified by:

setFloat in interface javax.jms.MapMessage

Parameters:

name - the name of the float

value - the float value to set in the Map.

Throws:

javax.jms.JMSException - if JMS fails to write message due to some internal JMS error.

javax.jms.MessageNotWriteableException - if message in read-only mode.

setDouble

public void setDouble(String name,
 double value)
               throws javax.jms.JMSException

Set a double value with the given name, into the Map.

Specified by:

setDouble in interface javax.jms.MapMessage

Parameters:

name - the name of the double

value - the double value to set in the Map.

Throws:

javax.jms.JMSException - if JMS fails to write message due to some internal JMS error.

javax.jms.MessageNotWriteableException - if message in read-only mode.

setString

public void setString(String name,
 String value)
               throws javax.jms.JMSException

Set a String value with the given name, into the Map.

Specified by:

setString in interface javax.jms.MapMessage

Parameters:

name - the name of the String

value - the String value to set in the Map.

Throws:

javax.jms.JMSException - if JMS fails to write message due to some internal JMS error.

javax.jms.MessageNotWriteableException - if message in read-only mode.

setBytes

public void setBytes(String name,
 byte[] value)
              throws javax.jms.JMSException

Set a byte array value with the given name, into the Map.

Specified by:

setBytes in interface javax.jms.MapMessage

Parameters:

name - the name of the byte array

value - the byte array value to set in the Map.

Throws:

javax.jms.JMSException - if JMS fails to write message due to some internal JMS error.

javax.jms.MessageNotWriteableException - if message in read-only mode.

setBytes

public void setBytes(String name,
 byte[] value,
 int offset,
 int length)
              throws javax.jms.JMSException

Set a portion of the byte array value with the given name, into the Map.

Specified by:

setBytes in interface javax.jms.MapMessage

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:

javax.jms.JMSException - if JMS fails to write message due to some internal JMS error.

javax.jms.MessageNotWriteableException - if message in read-only mode.

setObject

public void setObject(String name,
 Object value)
               throws javax.jms.JMSException

Set a Java object value with the given name, into the Map.

Note that this method only works for the objectified primitive object types (Integer, Double, Long ...), String's and byte arrays.

Specified by:

setObject in interface javax.jms.MapMessage

Parameters:

name - the name of the Java object

value - the Java object value to set in the Map.

Throws:

javax.jms.JMSException - if JMS fails to write message due to some internal JMS error.

javax.jms.MessageFormatException - if object is invalid

javax.jms.MessageNotWriteableException - if message in read-only mode.

itemExists

public boolean itemExists(String name)
                   throws javax.jms.JMSException

Check if an item exists in this MapMessage.

Specified by:

itemExists in interface javax.jms.MapMessage

Parameters:

name - the name of the item to test

Returns:

true if the item does exist.

Throws:

javax.jms.JMSException - if a JMS error occurs.

clearBody

public void clearBody()
               throws javax.jms.JMSException

Clear out the message body. All other parts of the message are left untouched.

Specified by:

clearBody in interface javax.jms.Message

Overrides:

clearBody in class MessageImpl

Throws:

javax.jms.JMSException - if JMS fails to due to some internal JMS error.

toString

public String toString()

Overrides:

toString in class MessageImpl