java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
org.refcodes.exception.AbstractHiddenException
- All Implemented Interfaces:
Serializable
,ErrorCodeAccessor
,Trap
Base exception for hidden (unchecked) / subsystem exceptions, providing
functionality for exception specific multi-language messages. A hidden
exception is an exception not representing the behavior of a system by its
declared checked and runtime exceptions. Moreover, hidden exceptions may
originate from subsystems wrapped by a system without the wrapping system
being able to declare the actual subsystem's aCause in its declarations (due
to e.g. interface compliance reasons). You as a programmer cannot take care
to prevent such exception as them may be even undocumented. Such exceptions
may be exceptions wrapping an actual aCause. Requiring a hidden exceptions
may point to problems of your software design, the use of hidden exceptrions
should be avoided.
- See Also:
-
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
ConstructorDescriptionAbstractHiddenException
(String aMessage, Throwable aCause) Instantiates a new according exception.AbstractHiddenException
(String aMessage, Throwable aCause, String aErrorCode) AbstractHiddenException
(Throwable aCause) Instantiates a new according exception.AbstractHiddenException
(Throwable aCause, String aErrorCode) -
Method Summary
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
Methods inherited from interface org.refcodes.exception.Trap
getPatternArguments, toLocalizedMessage, toMessage, toMessage, toMessage, toShortLocalizedMessage, toShortMessage
-
Constructor Details
-
AbstractHiddenException
Instantiates a new according exception. -
AbstractHiddenException
Instantiates a new according exception. -
AbstractHiddenException
- Parameters:
aMessage
- - the detail aMessage (which is saved for later retrieval by the Throwable.getMessage() method).aCause
- - the aCause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the aCause 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 aMessage (multi-language support) from a language pack instead of just providing the single language aMessage as being stored by the default exceptions.
-
AbstractHiddenException
- Parameters:
aCause
- - the aCause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the aCause 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 aMessage (multi-language support) from a language pack instead of just providing the single language aMessage as being stored by the default exceptions.
-
-
Method Details
-
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 interfaceErrorCodeAccessor
- Returns:
- The exception code in question.
-