Module org.refcodes.exception

Package org.refcodes.exception

Class AbstractIOException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

org.refcodes.exception.AbstractIOException

All Implemented Interfaces:

Serializable, ErrorCodeAccessor, Trap

Direct Known Subclasses:

TimeoutIOException

public abstract class AbstractIOException
extends IOException
implements Trap

Base exception for I/O 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
AbstractIOException(String aMessage)	Instantiates a new according exception.
AbstractIOException(String aMessage, String aErrorCode)
AbstractIOException(String aMessage, Throwable aCause)	Instantiates a new according exception.
AbstractIOException(String aMessage, Throwable aCause, String aErrorCode)
AbstractIOException(Throwable aCause)	Instantiates a new according exception.
AbstractIOException(Throwable aCause, String aErrorCode)

Method Summary

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

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

AbstractIOException

public AbstractIOException(String aMessage,
 Throwable aCause)

Instantiates a new according exception.

Parameters:

aMessage - The aMessage describing this exception.

aCause - The Throwable (Exception) causing this exception.

AbstractIOException

public AbstractIOException(String aMessage)

Instantiates a new according exception.

Parameters:

aMessage - The aMessage describing this exception.

AbstractIOException

public AbstractIOException(Throwable aCause)

Instantiates a new according exception.

Parameters:

aCause - The Throwable (Exception) causing this exception.

AbstractIOException

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

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.

AbstractIOException

public AbstractIOException(String aMessage,
 String aErrorCode)

Parameters:

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

AbstractIOException

public AbstractIOException(Throwable aCause,
 String aErrorCode)

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

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.