Package com.redwood.scheduler.api.exception

Class SchedulerCustomException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.redwood.scheduler.api.exception.SchedulerCustomException

All Implemented Interfaces:

ExceptionData, Serializable

public class SchedulerCustomException
extends Exception
implements ExceptionData

Custom exception, isBestException() returns true so will be chosen by the UI.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
SchedulerCustomException(String message)
SchedulerCustomException(String message, Throwable cause)

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.
static String	getMessageTrace(Throwable cause)
static String	getSQLExceptionInfo(Throwable cause)
static String	getStackTrace(Throwable cause)
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.

Methods inherited from class java.lang.Throwable

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

Constructor Detail

SchedulerCustomException

public SchedulerCustomException(String message,
                                Throwable cause)

SchedulerCustomException

public SchedulerCustomException(String message)

Method Detail

getStackTrace

public static String getStackTrace(Throwable cause)

getMessageTrace

public static String getMessageTrace(Throwable cause)

getSQLExceptionInfo

public static String getSQLExceptionInfo(Throwable cause)

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

getErrorCode

public final 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-"

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.

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.

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

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.