Package com.redwood.scheduler.infrastructure.exception

Class BaseSchedulerException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.redwood.scheduler.infrastructure.exception.BaseSchedulerException

All Implemented Interfaces:

ExceptionData, Serializable

Direct Known Subclasses:

SchedulerException

public abstract class BaseSchedulerException
extends Exception
implements ExceptionData, Serializable

The BaseSchedulerException is the implementation of the SchedulerException except that it does not define the versions, so is safe to use with exceptions before logging is enabled. For all other cases SchedulerException should be used.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseSchedulerException(String newErrorCode, String initMessageFormat, Throwable initCause, Object[] initExceptionDataEN, Object[] initExceptionData)

Method Summary

Modifier and Type	Method	Description
boolean	bestException()	Is this exception the best exception for the purposes of the UI? Exceptions implementing this _MUST_ make sure that they display all or more information than their causes.
String	getDefaultMessageFormat()	Get the default (US English) message format.
String	getErrorCode()	Get the JCS error code of this exception.
Object[]	getExceptionData()	Get the data from the exception for formatting.
String	getLocalizedMessage()
String	getLocalizedMessage(Locale locale)
String	getMessage()
String	getMessageUnformatted()
String	getTranslation()	Get a translation for the exception.
boolean	isSystemLoggable()	Should this exception be logged to the system log, or only to the trace file.
boolean	skipException()	Should this exception be skipped for the purposes of showing an exception dump to the user.
String	toString()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, 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 Detail

BaseSchedulerException

protected BaseSchedulerException(String newErrorCode,
                                 String initMessageFormat,
                                 Throwable initCause,
                                 Object[] initExceptionDataEN,
                                 Object[] initExceptionData)

Method Detail

getExceptionData

public Object[] getExceptionData()

Description copied from interface: ExceptionData

Get the data from the exception for formatting.

Specified by:

getExceptionData in interface ExceptionData

Returns:

the exception data.

skipException

public boolean skipException()

Description copied from interface: ExceptionData

Should this exception be skipped for the purposes of showing an exception dump to the user.

Specified by:

skipException in interface ExceptionData

Returns:

true if so, false otherwise.

bestException

public boolean bestException()

Description copied from interface: ExceptionData

Is this exception the best exception for the purposes of the UI? Exceptions implementing this _MUST_ make sure that they display all or more information than their causes.

Specified by:

bestException in interface ExceptionData

Returns:

true if so, false otherwise.

getDefaultMessageFormat

public String getDefaultMessageFormat()

Description copied from interface: ExceptionData

Get the default (US English) message format.

Specified by:

getDefaultMessageFormat in interface ExceptionData

Returns:

the message format

isSystemLoggable

public boolean isSystemLoggable()

Description copied from interface: ExceptionData

Should this exception be logged to the system log, or only to the trace file.

Specified by:

isSystemLoggable in interface ExceptionData

Returns:

whether this should be logged to the system log, or only to the trace file

getLocalizedMessage

public String getLocalizedMessage()

Overrides:

getLocalizedMessage in class Throwable

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getLocalizedMessage

public String getLocalizedMessage(Locale locale)

getMessageUnformatted

public String getMessageUnformatted()

toString

public String toString()

Overrides:

toString in class Throwable

getTranslation

public String getTranslation()

Description copied from interface: ExceptionData

Get a translation for the exception.

Specified by:

getTranslation in interface ExceptionData

Returns:

a translatable description of this exception.

getErrorCode

public String getErrorCode()

Description copied from interface: ExceptionData

Get the JCS error code of this exception.

Specified by:

getErrorCode in interface ExceptionData

Returns:

the JCS error code, without the leading "JCS-"