Package com.nfbsoftware.xml.exception

Class XmlDocumentCheckedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.nfbsoftware.exception.NfbCheckedException

com.nfbsoftware.xml.exception.XmlDocumentCheckedException

All Implemented Interfaces:

Serializable

public class XmlDocumentCheckedException
extends NfbCheckedException

The top level checked exception class for the XmlDocument project. All checked exceptions encountered within the XmlDocument project must be propagated as a XmlDocumentCheckedException, 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	XmlDocumentCheckedException.Code	Represents a XmlDocumentCheckedException code.
static interface	XmlDocumentCheckedException.Codes	Contains all of the message codes defined for this exception type as well as any subclasses.

Field Summary

Fields inherited from class com.nfbsoftware.exception.NfbCheckedException

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

Constructor Summary

Constructors

Constructor	Description
XmlDocumentCheckedException(XmlDocumentCheckedException.Code code, Object[] args, String debugInformation)	Constructs a XmlDocumentCheckedException instance with the specified code, message arguments, debug information, and a severity equal to the severity of the code.
XmlDocumentCheckedException(XmlDocumentCheckedException.Code code, Object[] args, String debugInformation, int severity)	Constructs a XmlDocumentCheckedException instance with the specified code, message arguments, debug information and severity.
XmlDocumentCheckedException(XmlDocumentCheckedException.Code code, Object[] args, String debugInformation, Throwable rootCause)	Constructs a XmlDocumentCheckedException instance with the specified code, message arguments, debug information, root cause, and a severity equal to the severity of the code.
XmlDocumentCheckedException(XmlDocumentCheckedException.Code code, Object[] args, String debugInformation, Throwable rootCause, int severity)	Constructs a XmlDocumentCheckedException instance with the specified code, message arguments, debug information, root cause, and severity.
XmlDocumentCheckedException(XmlDocumentCheckedException.Code code, Object arg, String debugInformation)	Constructs a XmlDocumentCheckedException instance with the specified code, message argument, debug information and a severity equal to the severity of the code.
XmlDocumentCheckedException(XmlDocumentCheckedException.Code code, Object arg, String debugInformation, int severity)	Constructs a XmlDocumentCheckedException instance with the specified code, message argument, debug information, and severity.
XmlDocumentCheckedException(XmlDocumentCheckedException.Code code, Object arg, String debugInformation, Throwable rootCause)	Constructs a XmlDocumentCheckedException instance with the specified code, message argument, debug information, root cause, and a severity equal to the severity of the code.
XmlDocumentCheckedException(XmlDocumentCheckedException.Code code, Object arg, String debugInformation, Throwable rootCause, int severity)	Constructs a XmlDocumentCheckedException instance with the specified code, message argument, debug information, root cause, and severity.
XmlDocumentCheckedException(XmlDocumentCheckedException.Code code, String debugInformation)	Constructs a XmlDocumentCheckedException instance with the specified code, message argument, debug information and a severity equal to the severity of the code.
XmlDocumentCheckedException(XmlDocumentCheckedException.Code code, String debugInformation, int severity)	Constructs a XmlDocumentCheckedException instance with the specified code, message arguments, debug information and severity.
XmlDocumentCheckedException(Object[] args, String debugInformation, Throwable rootCause, int severity)	Constructs a XmlDocumentCheckedException instance.
XmlDocumentCheckedException(Object arg, String debugInformation, Throwable rootCause)	Constructs a XmlDocumentCheckedException instance.
XmlDocumentCheckedException(String debugInformation, Throwable rootCause)	Constructs a XmlDocumentCheckedException instance.
XmlDocumentCheckedException(String debugInformation, Throwable rootCause, int severity)	Constructs a XmlDocumentCheckedException instance.

Method Summary

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

Methods inherited from class com.nfbsoftware.exception.NfbCheckedException

getArgs, getCode, getCode, getCodeName, getDebugInformation, getMessage, getRootCause, getSeverity, getSeverityAsString, getStackTraceString, isSevere, 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

XmlDocumentCheckedException

public XmlDocumentCheckedException(XmlDocumentCheckedException.Code code,
 String debugInformation)

Constructs a XmlDocumentCheckedException instance with the specified code, message argument, debug information and a severity equal to the severity of the code.

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

Parameters:

code - the exception code

debugInformation - debug information

XmlDocumentCheckedException

public XmlDocumentCheckedException(XmlDocumentCheckedException.Code code,
 String debugInformation,
 int severity)

Constructs a XmlDocumentCheckedException instance with the specified code, message arguments, debug information and severity.

Parameters:

code - the exception code

debugInformation - debug information

severity - the severity (based upon the constants defined in the SeveritySeverity class)

XmlDocumentCheckedException

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

Constructs a XmlDocumentCheckedException instance with the specified code, message argument, debug information and a severity equal to the severity of the code.

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

Parameters:

code - the exception code

arg - an argument

debugInformation - debug information

XmlDocumentCheckedException

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

Constructs a XmlDocumentCheckedException instance with the specified code, message arguments, debug information, and a severity equal to the severity of the code.

Parameters:

code - the exception code

args - an argument array

debugInformation - debug information

XmlDocumentCheckedException

public XmlDocumentCheckedException(XmlDocumentCheckedException.Code code,
 Object arg,
 String debugInformation,
 int severity)

Constructs a XmlDocumentCheckedException instance with the specified code, message argument, debug information, and severity.

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

Parameters:

code - the exception code

arg - an argument

debugInformation - debug information

severity - the severity (based upon the constants defined in the Severity class)

XmlDocumentCheckedException

public XmlDocumentCheckedException(XmlDocumentCheckedException.Code code,
 Object[] args,
 String debugInformation,
 int severity)

Constructs a XmlDocumentCheckedException instance with the specified code, message arguments, debug information and severity.

Parameters:

code - the exception code

args - an argument array

debugInformation - debug information

severity - the severity (based upon the constants defined in the Severity class)

XmlDocumentCheckedException

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

Constructs a XmlDocumentCheckedException instance with the specified code, message argument, debug information, root cause, and a severity equal to the severity of the code.

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

Parameters:

code - the exception code

arg - an argument

debugInformation - debug information

rootCause - the root cause

XmlDocumentCheckedException

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

Constructs a XmlDocumentCheckedException instance with the specified code, message arguments, debug information, root cause, and a severity equal to the severity of the code.

Parameters:

code - the exception code

args - an argument array

debugInformation - debug information

rootCause - the root cause

XmlDocumentCheckedException

public XmlDocumentCheckedException(XmlDocumentCheckedException.Code code,
 Object arg,
 String debugInformation,
 Throwable rootCause,
 int severity)

Constructs a XmlDocumentCheckedException instance with the specified code, message argument, debug information, root cause, and severity.

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

Parameters:

code - the exception code

arg - an argument

debugInformation - debug information

rootCause - the root cause

severity - the severity (based upon the constants defined in the Severity class)

XmlDocumentCheckedException

public XmlDocumentCheckedException(XmlDocumentCheckedException.Code code,
 Object[] args,
 String debugInformation,
 Throwable rootCause,
 int severity)

Constructs a XmlDocumentCheckedException instance with the specified code, message arguments, debug information, root cause, and severity.

Parameters:

code - the exception code

args - an argument array

debugInformation - debug information

rootCause - the root cause

severity - the severity (based upon the constants defined in the Severity class)

XmlDocumentCheckedException

public XmlDocumentCheckedException(String debugInformation,
 Throwable rootCause)

Constructs a XmlDocumentCheckedException instance.

Parameters:

debugInformation - The text for debugging issues.

rootCause - ex the exception to wrap

XmlDocumentCheckedException

public XmlDocumentCheckedException(String debugInformation,
 Throwable rootCause,
 int severity)

Constructs a XmlDocumentCheckedException instance.

Parameters:

debugInformation - debug information

rootCause - ex the exception to wrap

severity - The severity of the exception.

XmlDocumentCheckedException

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

Constructs a XmlDocumentCheckedException instance.

Parameters:

arg - The object that was exceptional

debugInformation - debug information

rootCause - ex the exception to wrap

XmlDocumentCheckedException

public XmlDocumentCheckedException(Object[] args,
 String debugInformation,
 Throwable rootCause,
 int severity)

Constructs a XmlDocumentCheckedException instance.

Parameters:

args - The args.

debugInformation - debug information

rootCause - ex the exception to wrap

severity - the level of the error.

Method Details

getDefaultCode

protected NfbCheckedException.Code getDefaultCode()

Gets the default Code.

Specified by:

getDefaultCode in class NfbCheckedException

Returns:

Codes.GENERAL_ERROR