no.g9.exception

Class GeneralException

java.lang.Object

java.lang.Throwable

java.lang.Exception

no.g9.exception.GeneralException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DBException

public class GeneralException
extends Exception

A general exception, suitable for extending your own. This exception is understood by the generated code from g9.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	ERROR Constant denoting an error
protected int	errorCode The error code
protected String	errorMessage The error message
protected boolean	exceptionIsLogged logged exception flag
protected int	exceptionSeriousCode the serious exception code
static int	FATAL_ERROR Constant denoting a fatal error
protected boolean	logException log exception flag
protected Throwable	originalException the original exception
protected int	subSystem The sub system
static int	WARNING Constant denoting a warning

Constructor Summary

Constructors

Constructor and Description
GeneralException() Default empty constructor
GeneralException(int errorCode, String errorMessage, int subsystem, boolean shouldBeLogged, int seriousness, Throwable originalException) Construcuts a new GeneralException.

Method Summary

Modifier and Type	Method and Description
boolean	exceptionLogged() Returns true if the exception has been logged
int	exceptionSeriousness() Returns the seriousnes of exception.
String	exceptionSeriousnessToString() Returns the seriousnes of exception as a string
int	getErrorCode() Returns error code.
String	getErrorMessage() Returns error message.
String	getMessage()
Throwable	getOriginalException() Returns the original error which triggered this exception, if it exist
int	getSubSystem() Returns subsystem where this error occured.
protected void	log() Override this to make your own logging mechanism
boolean	shouldExceptionBeLogged() Returns true if the exception should be logged
String	toString()
String	toStringSuper() Invokes toString method of the Exception class.

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

Field Detail

errorCode

protected int errorCode

The error code

errorMessage

protected String errorMessage

The error message

subSystem

protected int subSystem

The sub system

logException

protected boolean logException

log exception flag

exceptionIsLogged

protected boolean exceptionIsLogged

logged exception flag

exceptionSeriousCode

protected int exceptionSeriousCode

the serious exception code

originalException

protected Throwable originalException

the original exception

WARNING

public static final int WARNING

Constant denoting a warning

See Also:

Constant Field Values

ERROR

public static final int ERROR

Constant denoting an error

See Also:

Constant Field Values

FATAL_ERROR

public static final int FATAL_ERROR

Constant denoting a fatal error

See Also:

Constant Field Values

Constructor Detail

GeneralException

public GeneralException()

Default empty constructor

GeneralException

public GeneralException(int errorCode,
                        String errorMessage,
                        int subsystem,
                        boolean shouldBeLogged,
                        int seriousness,
                        Throwable originalException)

Construcuts a new GeneralException. When the constructor is run, the method log() is called.

Parameters:

errorCode - The error code for the exception.

errorMessage - The error message for the exception. This message is to be displayed to the user, so it should be user-friendly.

subsystem - The subsystem of where the exception originated.

shouldBeLogged - Flags if the exception should be logged.

seriousness - The seriousness of the exception. Should be one of WARNING, ERROR or FATAL_ERROR.

originalException - The exception leading to this exception, if any.

Method Detail

getErrorCode

public int getErrorCode()

Returns error code.

Returns:

the error code

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getErrorMessage

public String getErrorMessage()

Returns error message.

Returns:

the error message

getSubSystem

public int getSubSystem()

Returns subsystem where this error occured.

Returns:

the sub system

shouldExceptionBeLogged

public boolean shouldExceptionBeLogged()

Returns true if the exception should be logged

Returns:

true if exception should be logged.

exceptionLogged

public boolean exceptionLogged()

Returns true if the exception has been logged

Returns:

true if exception is logged.

exceptionSeriousness

public int exceptionSeriousness()

Returns the seriousnes of exception. Should be one of WARNING, ERROR or FATAL_ERROR

Returns:

the seriousnes of the exception

exceptionSeriousnessToString

public String exceptionSeriousnessToString()

Returns the seriousnes of exception as a string

Returns:

String representation of the seriousness of the exception

getOriginalException

public Throwable getOriginalException()

Returns the original error which triggered this exception, if it exist

Returns:

the original exception

log

protected void log()

Override this to make your own logging mechanism

toString

public String toString()

Overrides:

toString in class Throwable

toStringSuper

public String toStringSuper()

Invokes toString method of the Exception class.

Returns:

a string representation of this exception.

See Also:

Throwable.toString()