Package com.nfbsoftware.xml.exception

Class XmlDocumentRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.nfbsoftware.exception.NfbRuntimeException

com.nfbsoftware.xml.exception.XmlDocumentRuntimeException

All Implemented Interfaces:

Serializable

public class XmlDocumentRuntimeException
extends NfbRuntimeException

The top level NFB Software runtime exception class for the XmlDocument project. All runtime exceptions encountered within the XmlDocument project must be propagated as a XmlDocumentRuntimeException, using one of the codes defined in this class's Codes interface.

Author:

Brendan Clemenzi

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XmlDocumentRuntimeException.Code	Represents a XmlDocumentRuntimeException code.
static interface	XmlDocumentRuntimeException.Codes	Contains all ofthe message codes defined for this exception type as well as any subclasses.

Field Summary

Fields inherited from class com.nfbsoftware.exception.NfbRuntimeException

mArgs, mCode, mDebugInformation, mRootCause, mSeverity, mStackTraceString, TO_STRING_MESSAGE_FORMAT

Constructor Summary

Constructors

Constructor	Description
XmlDocumentRuntimeException(XmlDocumentRuntimeException.Code code, Object[] args, String debugInformation)	Constructs a XmlDocumentRuntimeException instance with the specified code, message arguments, amd debug information.
XmlDocumentRuntimeException(XmlDocumentRuntimeException.Code code, Object[] args, String debugInformation, Throwable rootCause)	Constructs a XmlDocumentRuntimeException instance with the specified code, message arguments, debug information, and root cause.
XmlDocumentRuntimeException(XmlDocumentRuntimeException.Code code, Object arg, String debugInformation)	Constructs a XmlDocumentRuntimeException instance with the specified code, message argument, and debug information.
XmlDocumentRuntimeException(XmlDocumentRuntimeException.Code code, Object arg, String debugInformation, Throwable rootCause)	Constructs a XmlDocumentRuntimeException instance with the specified code, message argument, debug information, and root cause.
XmlDocumentRuntimeException(XmlDocumentRuntimeException.Code code, String debugInformation)	Constructs a XmlDocumentRuntimeException instance with the specified code, message argument, and debug information.
XmlDocumentRuntimeException(Object arg, String debugInformation, Throwable rootCause)	Constructs a XmlDocumentRuntimeException instance.
XmlDocumentRuntimeException(String debugInformation, Throwable rootCause)	Constructs a XmlDocumentRuntimeException instance.

Method Summary

Modifier and Type	Method	Description
protected NfbRuntimeException.Code	getDefaultCode()	Gets the default Code.

Methods inherited from class com.nfbsoftware.exception.NfbRuntimeException

getArgs, getCode, getCode, getCodeName, getDebugInformation, getMessage, getRootCause, getSeverity, getSeverityAsString, getStackTraceString, registerCode, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Details

XmlDocumentRuntimeException

public XmlDocumentRuntimeException(XmlDocumentRuntimeException.Code code,
 String debugInformation)

Constructs a XmlDocumentRuntimeException instance with the specified code, message argument, and debug information. If a log has been configured for this exception type, the constructor logs the exception.

This is a convenience method that internally invokes XmlDocumentRuntimeException(String, Object[], String).

Parameters:

code - the exception code

debugInformation - debug information

XmlDocumentRuntimeException

public XmlDocumentRuntimeException(XmlDocumentRuntimeException.Code code,
 Object arg,
 String debugInformation)

Constructs a XmlDocumentRuntimeException instance with the specified code, message argument, and debug information. If a log has been configured for this exception type, the constructor logs the exception.

This is a convenience method that is a convenience method that internally invokes XmlDocumentRuntimeException(String, Object[], String).

Parameters:

code - the exception code

arg - an argument

debugInformation - debug information

XmlDocumentRuntimeException

public XmlDocumentRuntimeException(XmlDocumentRuntimeException.Code code,
 Object[] args,
 String debugInformation)

Constructs a XmlDocumentRuntimeException instance with the specified code, message arguments, amd debug information. If a log has been configured for this exception type, the constructor logs the exception.

Parameters:

code - the exception code

args - an argument array

debugInformation - debug information

XmlDocumentRuntimeException

public XmlDocumentRuntimeException(XmlDocumentRuntimeException.Code code,
 Object arg,
 String debugInformation,
 Throwable rootCause)

Constructs a XmlDocumentRuntimeException instance with the specified code, message argument, debug information, and root cause. If a log has been configured for this exception type, the constructor logs the exception.

This is a convenience method that is a convenience method that internally invokes XmlDocumentRuntimeException(String, Object[], String, Throwable).

Parameters:

code - the exception code

arg - an argument

debugInformation - debug information

rootCause - the root cause

XmlDocumentRuntimeException

public XmlDocumentRuntimeException(XmlDocumentRuntimeException.Code code,
 Object[] args,
 String debugInformation,
 Throwable rootCause)

Constructs a XmlDocumentRuntimeException instance with the specified code, message arguments, debug information, and root cause. If a log has been configured for this exception type, the constructor logs the exception.

Parameters:

code - the exception code

args - an argument array

debugInformation - debug information

rootCause - the root cause

XmlDocumentRuntimeException

public XmlDocumentRuntimeException(String debugInformation,
 Throwable rootCause)

Constructs a XmlDocumentRuntimeException instance. If a log has been configured for this exception type, the constructor logs the exception.

Parameters:

debugInformation - debug information

rootCause - ex the exception to wrap

XmlDocumentRuntimeException

public XmlDocumentRuntimeException(Object arg,
 String debugInformation,
 Throwable rootCause)

Constructs a XmlDocumentRuntimeException instance. If a log has been configured for this exception type, the constructor logs the exception.

Parameters:

arg - An argument

debugInformation - debug information

rootCause - ex the exception to wrap

Method Details

getDefaultCode

protected NfbRuntimeException.Code getDefaultCode()

Gets the default Code.

Specified by:

getDefaultCode in class NfbRuntimeException

Returns:

Codes.GENERAL_FATAL_ERROR