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:

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.
Public Member Functions inherited from cms::CMSException
	CMSException ()
	CMSException (const CMSException &ex)
	CMSException (const std::string &message)
	CMSException (const std::string &message, const std::exception *cause)
	CMSException (const std::string &message, const std::exception *cause, const std::vector< std::pair< std::string, int > > &stackTrace)
virtual	~CMSException () throw ()
virtual std::string	getMessage () const
	Gets the cause of the error.
virtual const std::exception *	getCause () const
	Gets the exception that caused this one to be thrown, this allows for chaining of exceptions in the case of a method that throws only a particular exception but wishes to allow for the real causal exception to be passed only in case the caller knows about that type of exception and wishes to respond to it.
virtual std::vector< std::pair < std::string, int > >	getStackTrace () const
	Provides the stack trace for every point where this exception was caught, marked, and rethrown.
virtual void	setMark (const char *file, const int lineNumber)
	Adds a file/line number to the stack trace.
virtual void	printStackTrace () const
	Prints the stack trace to std::err.
virtual void	printStackTrace (std::ostream &stream) const
	Prints the stack trace to the given output stream.
virtual std::string	getStackTraceString () const
	Gets the stack trace as one contiguous string.
virtual const char *	what () const throw ()
	Overloads the std::exception what() function to return the cause of the exception.

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