Package org.refcodes.exception
Class AbstractException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- org.refcodes.exception.AbstractException
-
- All Implemented Interfaces:
Serializable
,ErrorCodeAccessor
,Trap
- Direct Known Subclasses:
BreakOutException
,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 org.refcodes.exception.ErrorCodeAccessor
ErrorCodeAccessor.ErrorCodeBuilder<B extends ErrorCodeAccessor.ErrorCodeBuilder<B>>, ErrorCodeAccessor.ErrorCodeMutator, ErrorCodeAccessor.ErrorCodeProperty
-
-
Constructor Summary
Constructors Constructor Description AbstractException(String message)
Instantiates a new abstract exception.AbstractException(String aMessage, String aErrorCode)
AbstractException(String message, Throwable cause)
Instantiates a new abstract exception.AbstractException(String aMessage, Throwable aCause, String aErrorCode)
AbstractException(Throwable cause)
Instantiates a new abstract exception.AbstractException(Throwable aCause, String aErrorCode)
/**
-
Method Summary
All Methods Instance Methods Concrete Methods 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
-
AbstractException
public AbstractException(String message, Throwable cause)
Instantiates a new abstract exception.- Parameters:
message
- the messagecause
- the cause
-
AbstractException
public AbstractException(String message)
Instantiates a new abstract exception.- Parameters:
message
- the message
-
AbstractException
public AbstractException(Throwable cause)
Instantiates a new abstract exception.- Parameters:
cause
- the cause
-
AbstractException
public AbstractException(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.
-
AbstractException
public AbstractException(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.
-
AbstractException
public AbstractException(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 interfaceErrorCodeAccessor
- Returns:
- The exception code in question.
-
-