Module org.refcodes.exception

Package org.refcodes.exception

Class AbstractRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.refcodes.exception.AbstractRuntimeException

All Implemented Interfaces:

Serializable, ErrorCodeAccessor, Trap

Direct Known Subclasses:

BugException, IntegrityException, IORuntimeException, LockedException.LockedRuntimeException, VerifyRuntimeException, VetoException.VetoRuntimeException

public abstract class AbstractRuntimeException
extends RuntimeException
implements Trap

Base exception for runtime (unchecked) / predictable (testable states) exceptions, providing functionality for exception specific multi-language messages. Regarding unchecked exception, "The Java Programming Language", by Gosling, Arnold, and Holmes says "... Unchecked runtime exceptions represent conditions that, generally speaking, reflect errors in your program's logic and cannot be reasonably recovered from at run time ...". Though you as a programmer can take care by according (business) logic to prevent such exception. Such exceptions may be accessing disposed components or any other cause where you can test a state beforehand.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.exception.ErrorCodeAccessor

ErrorCodeAccessor.ErrorCodeBuilder<B extends ErrorCodeAccessor.ErrorCodeBuilder<B>>, ErrorCodeAccessor.ErrorCodeMutator, ErrorCodeAccessor.ErrorCodeProperty

Constructor Summary

Constructors

Constructor	Description
AbstractRuntimeException(String message)	Instantiates a new abstract runtime exception.
AbstractRuntimeException(String aMessage, String aErrorCode)
AbstractRuntimeException(String message, Throwable cause)	Instantiates a new abstract runtime exception.
AbstractRuntimeException(String aMessage, Throwable aCause, String aErrorCode)
AbstractRuntimeException(Throwable cause)	Instantiates a new abstract runtime exception.
AbstractRuntimeException(Throwable aCause, String aErrorCode)

Method Summary

Modifier and Type	Method	Description
String	getErrorCode()	Provides the according exception code.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Constructor Detail

AbstractRuntimeException

public AbstractRuntimeException(String message,
                                Throwable cause)

Instantiates a new abstract runtime exception.

Parameters:

message - the message

cause - the cause

AbstractRuntimeException

public AbstractRuntimeException(String message)

Instantiates a new abstract runtime exception.

Parameters:

message - the message

AbstractRuntimeException

public AbstractRuntimeException(Throwable cause)

Instantiates a new abstract runtime exception.

Parameters:

cause - the cause

AbstractRuntimeException

public AbstractRuntimeException(String aMessage,
                                Throwable aCause,
                                String aErrorCode)

Parameters:

aMessage - - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

aCause - - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

aErrorCode - The exception code to be assigned to the exception. An exception code can be provided when creating an exception and it can be used by the business logic to retrieve a language depended exception message (multi-language support) from a language pack instead of just providing the single language message as being stored by the default exceptions.

AbstractRuntimeException

public AbstractRuntimeException(String aMessage,
                                String aErrorCode)

Parameters:

aMessage - - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

aErrorCode - The exception code to be assigned to the exception. An exception code can be provided when creating an exception and it can be used by the business logic to retrieve a language depended exception message (multi-language support) from a language pack instead of just providing the single language message as being stored by the default exceptions.

AbstractRuntimeException

public AbstractRuntimeException(Throwable aCause,
                                String aErrorCode)

Parameters:

aCause - - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

aErrorCode - The exception code to be assigned to the exception. An exception code can be provided when creating an exception and it can be used by the business logic to retrieve a language depended exception message (multi-language support) from a language pack instead of just providing the single language message as being stored by the default exceptions.

Method Detail

getErrorCode

public String getErrorCode()

Provides the according exception code. An exception code can be provided when creating an exception and it can be used by the business logic to retrieve a language depended exception message (multi-language support) from a language pack instead of just providing the single language message as being stored by the default exceptions.

Specified by:

getErrorCode in interface ErrorCodeAccessor

Returns:

The exception code in question.