atg.droplet

Class DropletException

java.lang.Object

java.lang.Throwable

java.lang.Exception

javax.servlet.ServletException

atg.droplet.DropletException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DropletFormException

public class DropletException
extends javax.servlet.ServletException

Represents an exception within Droplet

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
DropletException(java.lang.String pStr) Constructs a new DropletException with the given explanation
DropletException(java.lang.String pMessage, java.lang.String pErrorCode) Constructs a new DropletException with the given message and detailed message.
DropletException(java.lang.String pMessage, java.lang.String pErrorCode, java.lang.String pInputErrorCode) Constructs a new DropletException with the given message and detailed message.
DropletException(java.lang.String pStr, java.lang.Throwable pRootCause) Constructs a new DropletException with the given explanation and root exception.
DropletException(java.lang.String pStr, java.lang.Throwable pRootCause, java.lang.String pErrorCode) Constructs a new DropletException with the given explanation, root exception, and the message code.
DropletException(java.lang.String pStr, java.lang.Throwable pRootCause, java.lang.String pErrorCode, java.lang.String pInputErrorCode) Constructs a new DropletException with the given explanation, root exception, the message code, and input error code.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getErrorCode() Returns a the coded message for this error.
java.lang.String	getInputErrorCode() Returns the input error code.
java.lang.String	toString() Returns a description of this DropletException object.

Methods inherited from class javax.servlet.ServletException

getRootCause

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

DropletException

public DropletException(java.lang.String pStr)

Constructs a new DropletException with the given explanation

DropletException

public DropletException(java.lang.String pStr,
                        java.lang.Throwable pRootCause)

Constructs a new DropletException with the given explanation and root exception.

DropletException

public DropletException(java.lang.String pMessage,
                        java.lang.String pErrorCode)

Constructs a new DropletException with the given message and detailed message. For exceptions that can be caused by "user error" you can include a ErrorCode in addition to the text message for the exception. This allows the jhtml pages to switch off of this code to customize the output.

DropletException

public DropletException(java.lang.String pStr,
                        java.lang.Throwable pRootCause,
                        java.lang.String pErrorCode)

Constructs a new DropletException with the given explanation, root exception, and the message code.

DropletException

public DropletException(java.lang.String pMessage,
                        java.lang.String pErrorCode,
                        java.lang.String pInputErrorCode)

Constructs a new DropletException with the given message and detailed message. For exceptions that can be caused by "user error" you can include a ErrorCode in addition to the text message for the exception. This allows the jhtml pages to switch off of this code to customize the output. The InputErrorCode should be specified if the error was as a result of bad input.

DropletException

public DropletException(java.lang.String pStr,
                        java.lang.Throwable pRootCause,
                        java.lang.String pErrorCode,
                        java.lang.String pInputErrorCode)

Constructs a new DropletException with the given explanation, root exception, the message code, and input error code.

Method Detail

getErrorCode

public java.lang.String getErrorCode()

Returns a the coded message for this error.

getInputErrorCode

public java.lang.String getInputErrorCode()

Returns the input error code. The input error code is used to distinguish between exceptions caused by bad input rather than general exceptions.

toString

public java.lang.String toString()

Returns a description of this DropletException object.

Overrides:

toString in class java.lang.Throwable