Module com.itemis.jscdlib

Package com.itemis.jscdlib.problem

Class JScdException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.itemis.jscdlib.problem.JScdException

All Implemented Interfaces:

Serializable

public final class JScdException
extends RuntimeException

An (unchecked) RuntimeException that is thrown by many of JScdLib's methods. Instances of this class usually hold a meaningful error message and a JScdProblem object with further error information.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_MESSAGE	Message of DEFAULT_PROBLEM.
static final JScdProblem	DEFAULT_PROBLEM	If no other problem applies, use this.

Constructor Summary

Constructors

Constructor	Description
JScdException()	Uses DEFAULT_PROBLEM and DEFAULT_MESSAGE.
JScdException(JScdProblem problem)	Construct an exception out of problem and problem's message.
JScdException(JScdProblem problem, String appendix)	Like JScdException(JScdProblem) but appends appendix to problem's message.
JScdException(Throwable cause)	Uses DEFAULT_PROBLEM and a combination of DEFAULT_MESSAGE and cause's message.

Method Summary

Modifier and Type	Method	Description
JScdProblem	problem()

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

Field Details

DEFAULT_PROBLEM

public static final JScdProblem DEFAULT_PROBLEM

If no other problem applies, use this.

DEFAULT_MESSAGE

public static final String DEFAULT_MESSAGE

Message of DEFAULT_PROBLEM.

Constructor Details

JScdException

public JScdException()

Uses DEFAULT_PROBLEM and DEFAULT_MESSAGE.

JScdException

public JScdException(Throwable cause)

Uses DEFAULT_PROBLEM and a combination of DEFAULT_MESSAGE and cause's message.

Parameters:

cause -

JScdException

public JScdException(JScdProblem problem)

Construct an exception out of problem and problem's message.

Parameters:

problem -

JScdException

public JScdException(JScdProblem problem,
 String appendix)

Like JScdException(JScdProblem) but appends appendix to problem's message.

Parameters:

problem -

appendix -

Method Details

problem

public JScdProblem problem()

Returns:

The problem encapsulated by this exception.