cms::MessageFormatException Class Reference

This exception must be thrown when a CMS client attempts to use a data type not supported by a message or attempts to read data in a message as the wrong type. More...

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

Inheritance diagram for cms::MessageFormatException:

[legend]

Public Member Functions
	MessageFormatException ()
	MessageFormatException (const MessageFormatException &ex)
	MessageFormatException (const std::string &message)
	MessageFormatException (const std::string &message, const std::exception *cause)
	MessageFormatException (const std::string &message, const std::exception *cause, const std::vector< std::pair< std::string, int > > &stackTrace)
virtual	~MessageFormatException () throw ()
virtual MessageFormatException *	clone ()
	Creates a cloned version of this CMSException instance.

---

Detailed Description

This exception must be thrown when a CMS client attempts to use a data type not supported by a message or attempts to read data in a message as the wrong type.

It must also be thrown when equivalent type errors are made with message property values. For example, this exception must be thrown if StreamMessage.readShort is used to read a boolean value.

Since:

1.3

---

Constructor & Destructor Documentation

cms::MessageFormatException::MessageFormatException

(

)

cms::MessageFormatException::MessageFormatException

(

const MessageFormatException &

ex

)

cms::MessageFormatException::MessageFormatException

(

const std::string &

message

)

cms::MessageFormatException::MessageFormatException	(	const std::string &	message,
		const std::exception *	cause
	)

cms::MessageFormatException::MessageFormatException	(	const std::string &	message,
		const std::exception *	cause,
		const std::vector< std::pair< std::string, int > > &	stackTrace
	)

virtual cms::MessageFormatException::~MessageFormatException

(

)

throw () [virtual]

---

Member Function Documentation

virtual MessageFormatException* cms::MessageFormatException::clone

(

)

[virtual]

Creates a cloned version of this CMSException instance.

This method passes on ownership of the contained cause exception pointer to the clone. This method is mainly useful to the CMS provider.

Returns:

new pointer that is a clone of this Exception, caller owns.

Reimplemented from cms::CMSException.

---

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

• src/main/cms/MessageFormatException.h