javax::jms::JMSException Class Reference

This is the root class of all JMS API exceptions. More...

#include <javax_jms_JMSException.h>

Inheritance diagram for javax::jms::JMSException:

[legend]Collaboration diagram for javax::jms::JMSException:

[legend]List of all members.

Public Types
enum	{   xmogDefaultFlags = xmog_base::GLOBAL, xmogMajorVersion = 3, xmogMinorVersion = 2, xmogPatchVersion = 9,   xmogBuildNumber = 2047 }
typedef ::xmog_java_array_template< ::javax::jms::JMSException >	array1D
typedef ::xmog_java_array_template< ::xmog_java_array_template< ::javax::jms::JMSException > >	array2D
Public Member Functions
virtual ::java::lang::String	getErrorCode (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the vendor-specific error code.
virtual ::java::lang::Exception	getLinkedException (::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Gets the exception linked to this one.
	JMSException (const ::java::lang::String &reason, const ::java::lang::String &errorCode,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Constructs a JMSException with the specified reason and error code.
	JMSException (const ::java::lang::String &reason,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Constructs a JMSException with the specified reason and with the error code defaulting to null.
virtual void	setLinkedException (const ::java::lang::Exception &ex,::xmog_localenv *p_xenv=NULL, xmog_flags f_xflags=xmogDefaultFlags)
	Adds a linked Exception.

---

Detailed Description

This is the root class of all JMS API exceptions.

It provides the following information:

• A provider-specific string describing the error. This string is the standard exception message and is available via the getMessage method.
• A provider-specific string error code
• A reference to another exception. Often a JMS API exception will be the result of a lower-level problem. If appropriate, this lower-level exception can be linked to the JMS API exception.

Author:

Mark Hapner

Rich Burridge

---

Constructor & Destructor Documentation

javax::jms::JMSException::JMSException (  const ::java::lang::String &  reason, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Constructs a JMSException with the specified reason and with the error code defaulting to null. Parameters: reason  a description of the exception p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

javax::jms::JMSException::JMSException (  const ::java::lang::String &  reason, const ::java::lang::String &  errorCode, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Constructs a JMSException with the specified reason and error code. Parameters: reason  a description of the exception errorCode  a string specifying the vendor-specific error code p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL.

---

Member Function Documentation

virtual ::java::lang::String javax::jms::JMSException::getErrorCode (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets the vendor-specific error code. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: a string specifying the vendor-specific error code

virtual ::java::lang::Exception javax::jms::JMSException::getLinkedException (  ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )

Gets the exception linked to this one. Parameters: p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns: the linked Exception, null if none

virtual void javax::jms::JMSException::setLinkedException (  const ::java::lang::Exception &  ex, ::xmog_localenv *  p_xenv = NULL, xmog_flags  f_xflags = xmogDefaultFlags )  [virtual]

Adds a linked Exception. Parameters: ex  the linked Exception p_xenv  the local call environment. The default value is NULL. f_xflags  the flags that allow control over the reference type and other internal matters. The default value is xmog_base::GLOBAL. Returns:

---

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

• javax_jms_JMSException.h

---