org.xins.common

Class ProgrammingException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.xins.common.ProgrammingException

All Implemented Interfaces:

Serializable

public final class ProgrammingException
extends RuntimeException

Exception thrown when a programming error is detected.

Since:

XINS 1.1.0

Version:

$Revision: 1.21 $ $Date: 2011/03/19 09:11:18 $

Author:

Ernst de Haan

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProgrammingException(String detectingClass, String detectingMethod, String subjectClass, String subjectMethod, String detail, Throwable cause) Constructs a new ProgrammingException for the specified class and method, indicating which class and method detected the problem.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDetail() Returns the detail message.
String	getDetectingClass() Returns the name of the class that detected the problem.
String	getDetectingMethod() Returns the name of the method where the problem was detected.
String	getSubjectClass() Returns the name of the class which exposes the programming error.
String	getSubjectMethod() Returns the name of the method which exposes the programming error.

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

ProgrammingException

public ProgrammingException(String detectingClass,
                    String detectingMethod,
                    String subjectClass,
                    String subjectMethod,
                    String detail,
                    Throwable cause)

Constructs a new ProgrammingException for the specified class and method, indicating which class and method detected the problem.

Parameters:

detectingClass - the name of the class that detected the problem, or null if unknown.

detectingMethod - the name of the method within the detectingClass that detected the problem, or null if unknown.

subjectClass - the name of the class which exposes the programming error, or null if unknown.

subjectMethod - the name of the method (within the subjectClass) which exposes the programming error, or null if unknown.

detail - the detail message, can be null.

cause - the cause exception, can be null.

Method Detail

getDetectingClass

public String getDetectingClass()

Returns the name of the class that detected the problem.

Returns:

the name of the class that detected the problem, or null if unknown.

Since:

XINS 1.3.0

getDetectingMethod

public String getDetectingMethod()

Returns the name of the method where the problem was detected.

Returns:

the name of the method that detected the problem, or null if unknown.

Since:

XINS 1.3.0

getSubjectClass

public String getSubjectClass()

Returns the name of the class which exposes the programming error.

Returns:

the name of the class that exposed the problem, or null if unknown.

Since:

XINS 1.3.0

getSubjectMethod

public String getSubjectMethod()

Returns the name of the method which exposes the programming error.

Returns:

the name of the method that exposed the problem, or null if unknown.

Since:

XINS 1.3.0

getDetail

public String getDetail()

Returns the detail message.

Returns:

the detail message, can be null.

Since:

XINS 1.3.0