Class AbstractException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.refcodes.exception.AbstractException

All Implemented Interfaces:

Serializable, ErrorCodeAccessor, Trap

Direct Known Subclasses:

LockedException, MarshalException, UnmarshalException, VetoException

public abstract class AbstractException
extends Exception
implements Trap

Base exception for unpredictable / checked (untestable states) exceptions, providing functionality for exception specific multi-language messages. Unpredictable exceptions must be declared or explicitly caught. You as a programmer cannot take care to prevent such exceptions by according (business) logic. Such exceptions may be network connection loss or external peripheral failure.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface ErrorCodeAccessor

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

Constructor Summary

Constructors

Constructor	Description
AbstractException(String aMessage)	Instantiates the class AbstractException.
AbstractException(String aMessage, String aErrorCode)	Instantiates the class AbstractException.
AbstractException(String aMessage, Throwable aCause)	Instantiates the class AbstractException.
AbstractException(String aMessage, Throwable aCause, String aErrorCode)	Instantiates the class AbstractException.
AbstractException(Throwable aCause)	Instantiates the class AbstractException.
AbstractException(Throwable aCause, String aErrorCode)	Instantiates the class AbstractException.

Method Summary

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

Methods inherited from class Throwable

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

Methods inherited from class Object

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

Methods inherited from interface Trap

getPatternArguments, toLocalizedMessage, toMessage, toMessage, toMessage, toShortLocalizedMessage, toShortMessage

Constructor Details

AbstractException

public AbstractException(String aMessage,
 Throwable aCause)

Instantiates the class AbstractException.

See Also:

• Exception(java.lang.String, java.lang.Throwable)

AbstractException

public AbstractException(String aMessage)

Instantiates the class AbstractException.

See Also:

• Exception(java.lang.String)

AbstractException

public AbstractException(Throwable aCause)

Instantiates the class AbstractException.

See Also:

• Exception(java.lang.Throwable)

AbstractException

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

Instantiates the class AbstractException.

Parameters:

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 aMessage (multi-language support) from a language pack instead of just providing the single language aMessage as being stored by the default exceptions.

See Also:

• Exception(java.lang.String, java.lang.Throwable)

AbstractException

public AbstractException(String aMessage,
 String aErrorCode)

Instantiates the class AbstractException.

Parameters:

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 aMessage (multi-language support) from a language pack instead of just providing the single language aMessage as being stored by the default exceptions.

See Also:

• Exception(java.lang.String)

AbstractException

public AbstractException(Throwable aCause,
 String aErrorCode)

Instantiates the class AbstractException.

Parameters:

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 aMessage (multi-language support) from a language pack instead of just providing the single language aMessage as being stored by the default exceptions.

See Also:

• Exception(java.lang.Throwable)

Method Details

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

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 aMessage (multi-language support) from a language pack instead of just providing the single language aMessage as being stored by the default exceptions.

Specified by:

getErrorCode in interface ErrorCodeAccessor

Returns:

The exception code in question.