cms::MapMessage Class Reference

#include <src/main/cms/MapMessage.h>

Inheritance diagram for cms::MapMessage:

[legend]

Collaboration diagram for cms::MapMessage:

[legend]

---

Detailed Description

A MapMessage object is used to send a set of name-value pairs.

The names are String objects, and the values are primitive data types in the Java programming language. The names must have a value that is not null, and not an empty string. The entries can be accessed sequentially or randomly by name. The order of the entries is undefined. MapMessage inherits from the Message interface and adds a message body that contains a Map.

When a client receives a MapMessage, it is in read-only mode. If a client attempts to write to the message at this point, a CMSException is thrown.

Public Member Functions
virtual	~MapMessage ()
virtual std::vector < std::string >	getMapNames () const =0
	Returns an Enumeration of all the names in the MapMessage object.
virtual bool	itemExists (const std::string &name) const =0
	Indicates whether an item exists in this MapMessage object.
virtual bool	getBoolean (const std::string &name) const =0 throw ( CMSException )
	Returns the Boolean value of the Specified name.
virtual void	setBoolean (const std::string &name, bool value)=0 throw ( CMSException )
	Sets a boolean value with the specified name into the Map.
virtual unsigned char	getByte (const std::string &name) const =0 throw ( CMSException )
	Returns the Byte value of the Specified name.
virtual void	setByte (const std::string &name, unsigned char value)=0 throw ( CMSException )
	Sets a Byte value with the specified name into the Map.
virtual std::vector < unsigned char >	getBytes (const std::string &name) const =0 throw ( CMSException )
	Returns the Bytes value of the Specified name.
virtual void	setBytes (const std::string &name, const std::vector< unsigned char > &value)=0 throw ( CMSException )
	Sets a Bytes value with the specified name into the Map.
virtual char	getChar (const std::string &name) const =0 throw ( CMSException )
	Returns the Char value of the Specified name.
virtual void	setChar (const std::string &name, char value)=0 throw ( CMSException )
	Sets a Char value with the specified name into the Map.
virtual double	getDouble (const std::string &name) const =0 throw ( CMSException )
	Returns the Double value of the Specified name.
virtual void	setDouble (const std::string &name, double value)=0 throw ( CMSException )
	Sets a Double value with the specified name into the Map.
virtual float	getFloat (const std::string &name) const =0 throw ( CMSException )
	Returns the Float value of the Specified name.
virtual void	setFloat (const std::string &name, float value)=0 throw ( CMSException )
	Sets a Float value with the specified name into the Map.
virtual int	getInt (const std::string &name) const =0 throw ( CMSException )
	Returns the Int value of the Specified name.
virtual void	setInt (const std::string &name, int value)=0 throw ( CMSException )
	Sets a Int value with the specified name into the Map.
virtual long long	getLong (const std::string &name) const =0 throw ( CMSException )
	Returns the Long value of the Specified name.
virtual void	setLong (const std::string &name, long long value)=0 throw ( CMSException )
	Sets a Long value with the specified name into the Map.
virtual short	getShort (const std::string &name) const =0 throw ( CMSException )
	Returns the Short value of the Specified name.
virtual void	setShort (const std::string &name, short value)=0 throw ( CMSException )
	Sets a Short value with the specified name into the Map.
virtual std::string	getString (const std::string &name) const =0 throw ( CMSException )
	Returns the String value of the Specified name.
virtual void	setString (const std::string &name, const std::string &value)=0 throw ( CMSException )
	Sets a String value with the specified name into the Map.

---

Constructor & Destructor Documentation

virtual cms::MapMessage::~MapMessage

(

)

[inline, virtual]

---

Member Function Documentation

virtual std::vector< std::string > cms::MapMessage::getMapNames

(

)

const [pure virtual]

Returns an Enumeration of all the names in the MapMessage object.

Returns:

STL Vector of String values, each of which is the name of an item in the MapMessage

Exceptions:

CMSException

virtual bool cms::MapMessage::itemExists

(

const std::string &

name

)

const [pure virtual]

Indicates whether an item exists in this MapMessage object.

Parameters:

name

String name of the Object in question

Returns:

boolean value indicating if the name is in the map

virtual bool cms::MapMessage::getBoolean

(

const std::string &

name

)

const throw ( CMSException ) [pure virtual]

Returns the Boolean value of the Specified name.

Parameters:

name

Name of the value to fetch from the map

Exceptions:

CMSException

virtual void cms::MapMessage::setBoolean	(	const std::string &	name,
		bool	value
	)			throw ( CMSException ) [pure virtual]

Sets a boolean value with the specified name into the Map.

Parameters:

	name	the name of the boolean
	value	the boolean value to set in the Map

Exceptions:

CMSException

virtual unsigned char cms::MapMessage::getByte

(

const std::string &

name

)

const throw ( CMSException ) [pure virtual]

Returns the Byte value of the Specified name.

Parameters:

name

Name of the value to fetch from the map

Exceptions:

CMSException

virtual void cms::MapMessage::setByte	(	const std::string &	name,
		unsigned char	value
	)			throw ( CMSException ) [pure virtual]

Sets a Byte value with the specified name into the Map.

Parameters:

	name	the name of the Byte
	value	the Byte value to set in the Map

Exceptions:

CMSException

virtual std::vector<unsigned char> cms::MapMessage::getBytes

(

const std::string &

name

)

const throw ( CMSException ) [pure virtual]

Returns the Bytes value of the Specified name.

Parameters:

name

Name of the value to fetch from the map

Exceptions:

CMSException

virtual void cms::MapMessage::setBytes	(	const std::string &	name,
		const std::vector< unsigned char > &	value
	)			throw ( CMSException ) [pure virtual]

Sets a Bytes value with the specified name into the Map.

Parameters:

	name	The name of the Bytes
	value	The Bytes value to set in the Map

Exceptions:

CMSException

virtual char cms::MapMessage::getChar

(

const std::string &

name

)

const throw ( CMSException ) [pure virtual]

Returns the Char value of the Specified name.

Parameters:

name

name of the value to fetch from the map

Exceptions:

CMSException

virtual void cms::MapMessage::setChar	(	const std::string &	name,
		char	value
	)			throw ( CMSException ) [pure virtual]

Sets a Char value with the specified name into the Map.

Parameters:

	name	the name of the Char
	value	the Char value to set in the Map

Exceptions:

CMSException

virtual double cms::MapMessage::getDouble

(

const std::string &

name

)

const throw ( CMSException ) [pure virtual]

Returns the Double value of the Specified name.

Parameters:

name

Name of the value to fetch from the map

Exceptions:

CMSException

virtual void cms::MapMessage::setDouble	(	const std::string &	name,
		double	value
	)			throw ( CMSException ) [pure virtual]

Sets a Double value with the specified name into the Map.

Parameters:

	name	The name of the Double
	value	The Double value to set in the Map

Exceptions:

CMSException

virtual float cms::MapMessage::getFloat

(

const std::string &

name

)

const throw ( CMSException ) [pure virtual]

Returns the Float value of the Specified name.

Parameters:

name

Name of the value to fetch from the map

Exceptions:

CMSException

virtual void cms::MapMessage::setFloat	(	const std::string &	name,
		float	value
	)			throw ( CMSException ) [pure virtual]

Sets a Float value with the specified name into the Map.

Parameters:

	name	The name of the Float
	value	The Float value to set in the Map

Exceptions:

CMSException

virtual int cms::MapMessage::getInt

(

const std::string &

name

)

const throw ( CMSException ) [pure virtual]

Returns the Int value of the Specified name.

Parameters:

name

Name of the value to fetch from the map

Exceptions:

CMSException

virtual void cms::MapMessage::setInt	(	const std::string &	name,
		int	value
	)			throw ( CMSException ) [pure virtual]

Sets a Int value with the specified name into the Map.

Parameters:

	name	The name of the Int
	value	The Int value to set in the Map

Exceptions:

CMSException

virtual long long cms::MapMessage::getLong

(

const std::string &

name

)

const throw ( CMSException ) [pure virtual]

Returns the Long value of the Specified name.

Parameters:

name

Name of the value to fetch from the map

Exceptions:

CMSException

virtual void cms::MapMessage::setLong	(	const std::string &	name,
		long long	value
	)			throw ( CMSException ) [pure virtual]

Sets a Long value with the specified name into the Map.

Parameters:

	name	The name of the Long
	value	The Long value to set in the Map

Exceptions:

CMSException

virtual short cms::MapMessage::getShort

(

const std::string &

name

)

const throw ( CMSException ) [pure virtual]

Returns the Short value of the Specified name.

Parameters:

name

Name of the value to fetch from the map

Exceptions:

CMSException

virtual void cms::MapMessage::setShort	(	const std::string &	name,
		short	value
	)			throw ( CMSException ) [pure virtual]

Sets a Short value with the specified name into the Map.

Parameters:

	name	The name of the Short
	value	The Short value to set in the Map

Exceptions:

CMSException

virtual std::string cms::MapMessage::getString

(

const std::string &

name

)

const throw ( CMSException ) [pure virtual]

Returns the String value of the Specified name.

Parameters:

name

Name of the value to fetch from the map

Exceptions:

CMSException

virtual void cms::MapMessage::setString	(	const std::string &	name,
		const std::string &	value
	)			throw ( CMSException ) [pure virtual]

Sets a String value with the specified name into the Map.

Parameters:

	name	The name of the String
	value	The String value to set in the Map

Exceptions:

CMSException

---

The documentation for this class was generated from the following file:

• src/main/cms/MapMessage.h

---