com.groiss.util

Class ApplicationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.groiss.util.ApplicationException

All Implemented Interfaces:

TopLevelException, java.io.Serializable

public class ApplicationException
extends java.lang.RuntimeException
implements java.io.Serializable, TopLevelException

Class for Exceptions thrown in the application.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	addText
protected boolean	allowHTMLMessage
protected java.lang.Object[]	arguments
protected ErrorFormatter	ef
protected int	exceptionNumber
protected boolean	isWarning

Constructor Summary

Constructors

Constructor and Description
ApplicationException(int errnum) Construct an ApplicationException with an exception number.
ApplicationException(int errnum, java.lang.Object[] args) Construct an ApplicationException with an exception number and args
ApplicationException(int errnum, java.lang.Object[] args, java.lang.Throwable cause) Construct an ApplicationException with an exception number, args and the cause exception.
ApplicationException(int errnum, java.lang.String msg, java.lang.Throwable cause) Construct an ApplicationException with an exception number, an extra message and the cause exception.
ApplicationException(int errnum, java.lang.Throwable cause) Construct an ApplicationException with an exception number and the cause exception.
ApplicationException(Resource resource, int errnum) Construct an ApplicationException with an exception number and a resource.
ApplicationException(Resource resource, int errnum, java.lang.Object[] args) Construct an ApplicationException with a resource, exception number and args.
ApplicationException(Resource resource, int errnum, java.lang.Object[] args, java.lang.Throwable cause) Construct an ApplicationException with a resource, exception number, args and the cause exception.
ApplicationException(Resource resource, int errnum, java.lang.String msg, java.lang.Throwable cause) Construct an ApplicationException with a resource, an exception number, an extra message and the cause exception.
ApplicationException(Resource resource, int errnum, java.lang.Throwable cause) Construct an ApplicationException with a resource, exception number, and the cause exception.
ApplicationException(java.lang.String message) Construct an ApplicationException with a message.
ApplicationException(java.lang.String message, java.lang.Throwable cause) Construct an ApplicationException with a message and the cause exception.
ApplicationException(java.lang.Throwable cause) Construct an ApplicationException with a cause exception.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allowHTMLMessage()
java.lang.Object[]	getArgs()
int	getErrnum()
ErrorFormatter	getErrorFormatter() Returns the error formatter for this exception.
java.lang.Throwable	getException() Returns an inner excpetion, null if there is none.
java.lang.String	getMessage()
java.lang.String	getMessageText() return the plain message text without "Error" prefix and number
boolean	isWarning()
protected void	log() The cause is logged.
void	setAllowHTMLMessage(boolean allowHTMLMessage) set to true to allow html-formatted error-messages, false by default
void	setErrorFormatter(ErrorFormatter ef) Set the formatter for formatting the error page.
void	setWarning(boolean warning) Set the exception type to warning.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Field Detail

ef

protected ErrorFormatter ef

exceptionNumber

protected int exceptionNumber

arguments

protected java.lang.Object[] arguments

isWarning

protected boolean isWarning

allowHTMLMessage

protected boolean allowHTMLMessage

addText

protected java.lang.String addText

Constructor Detail

ApplicationException

public ApplicationException(int errnum)

Construct an ApplicationException with an exception number.

Parameters:

errnum - the key in the enterprise errors resource

ApplicationException

public ApplicationException(Resource resource,
                    int errnum)

Construct an ApplicationException with an exception number and a resource.

Parameters:

resource - a resource containing the error messages.

errnum - the key in the given resource

ApplicationException

public ApplicationException(int errnum,
                    java.lang.Object[] args)

Construct an ApplicationException with an exception number and args

Parameters:

errnum - the key in the given resource

args - message-format arguments

ApplicationException

public ApplicationException(Resource resource,
                    int errnum,
                    java.lang.Object[] args)

Construct an ApplicationException with a resource, exception number and args.

Parameters:

resource - a resource containing the error messages

errnum - the key in the given resource

args - message-format arguments

ApplicationException

public ApplicationException(int errnum,
                    java.lang.Object[] args,
                    java.lang.Throwable cause)

Construct an ApplicationException with an exception number, args and the cause exception.

Parameters:

errnum - the key in the given resource

args - message-format arguments

cause - the causing exception

ApplicationException

public ApplicationException(Resource resource,
                    int errnum,
                    java.lang.Object[] args,
                    java.lang.Throwable cause)

Construct an ApplicationException with a resource, exception number, args and the cause exception.

Parameters:

resource - a resource containing the error messages

errnum - the key in the given resource

args - message-format arguments

cause - the causing exception

ApplicationException

public ApplicationException(int errnum,
                    java.lang.Throwable cause)

Construct an ApplicationException with an exception number and the cause exception.

Parameters:

errnum - the key in the given resource

cause - the causing exception

ApplicationException

public ApplicationException(Resource resource,
                    int errnum,
                    java.lang.Throwable cause)

Construct an ApplicationException with a resource, exception number, and the cause exception.

Parameters:

resource - a resource containing the error messages

errnum - the key in the given resource

cause - the causing exception

ApplicationException

public ApplicationException(java.lang.String message)

Construct an ApplicationException with a message.

Parameters:

message - the error message

ApplicationException

public ApplicationException(java.lang.String message,
                    java.lang.Throwable cause)

Construct an ApplicationException with a message and the cause exception.

Parameters:

message - the error message

cause - the causing exception

ApplicationException

public ApplicationException(java.lang.Throwable cause)

Construct an ApplicationException with a cause exception.

Parameters:

cause - the causing exception

ApplicationException

public ApplicationException(int errnum,
                    java.lang.String msg,
                    java.lang.Throwable cause)

Construct an ApplicationException with an exception number, an extra message and the cause exception. NOTE: Don't use this signature, use placeholders and an argument array.

Parameters:

errnum - the key in the given resource

msg - text that is added to the message from the error resource.

cause - the causing exception

ApplicationException

public ApplicationException(Resource resource,
                    int errnum,
                    java.lang.String msg,
                    java.lang.Throwable cause)

Construct an ApplicationException with a resource, an exception number, an extra message and the cause exception. NOTE: Don't use this signature, use placeholders and an argument array.

Parameters:

resource - a resource containing the error messages

errnum - the key in the given resource

msg - text that is added to the message from the error resource.

cause - the causing exception

Method Detail

getArgs

public java.lang.Object[] getArgs()

getErrnum

public int getErrnum()

Specified by:

getErrnum in interface TopLevelException

getErrorFormatter

public ErrorFormatter getErrorFormatter()

Returns the error formatter for this exception. If none is set, the method return null and the default ErrorFormatter defined in the system configuration will be used. If none is defined, DefaultErrorFormatter is used.

Returns:

the error formatter set for this exception.

getException

public java.lang.Throwable getException()

Description copied from interface: TopLevelException

Returns an inner excpetion, null if there is none.

Specified by:

getException in interface TopLevelException

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

getMessageText

public java.lang.String getMessageText()

return the plain message text without "Error" prefix and number

isWarning

public boolean isWarning()

Specified by:

isWarning in interface TopLevelException

log

protected void log()

The cause is logged. If there is no cause, the exception is written as info

setErrorFormatter

public void setErrorFormatter(ErrorFormatter ef)

Set the formatter for formatting the error page.

Parameters:

ef -

setWarning

public void setWarning(boolean warning)

Set the exception type to warning. This can be interpreted in the GUI to show the error message differently.

Specified by:

setWarning in interface TopLevelException

allowHTMLMessage

public boolean allowHTMLMessage()

setAllowHTMLMessage

public void setAllowHTMLMessage(boolean allowHTMLMessage)

set to true to allow html-formatted error-messages, false by default

Parameters:

allowHTMLMessage -