Module org.refcodes.exception

Package org.refcodes.exception

Interface Trap

All Superinterfaces:

ErrorCodeAccessor

All Known Implementing Classes:

AbstractException, AbstractHiddenException, AbstractIOException, AbstractRuntimeException, BugException, DisposedException, IntegrityException, IORuntimeException, LockedException, LockedException.LockedRuntimeException, MarshalException, TimeoutIOException, UnmarshalException, VerifyRuntimeException, VetoException, VetoException.VetoRuntimeException

public interface Trap
extends ErrorCodeAccessor

Interface declaring base exception functionality for all of refcodes exceptions.

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method	Description
default String	toLocalizedMessage()	Generates a localized message by considering a Throwable's Throwable.getCause() cause as well as Throwable.getSuppressed() exceptions.
static String	toLocalizedMessage(String aMessage, Exception aException)	Creates a message from the provided message and the Exception's contained localized message(s).
static String	toLocalizedMessage(Throwable aException)	Generates a localized message by considering a Throwable's cause Throwable.getCause() as well as Throwable.getSuppressed() exceptions.
default String	toMessage()	Generates a message by considering a Throwable's cause Throwable.getCause() as well as suppressed Throwable.getSuppressed() exceptions.
static String	toMessage(String aMessage, Exception aException)	Creates a message from the provided message and the Exception's contained message(s).
static String	toMessage(Throwable aException)	Generates a message by considering the Throwable's cause Throwable.getCause() as well as Throwable.getSuppressed() exceptions.
default String	toShortLocalizedMessage()	Generates a short localized message by just considering a Throwable's Throwable.getCause() root cause as well as root Throwable.getSuppressed() exceptions only.
static String	toShortLocalizedMessage(Throwable aException)	Generates a short localized message by just considering a Throwable's root cause Throwable.getCause() as well as Throwable.getSuppressed() root exceptions only.
default String	toShortMessage()	Generates a short message by just considering a Throwable's root cause Throwable.getCause() as well as root Throwable.getSuppressed() exceptions only.
static String	toShortMessage(Throwable aException)	Generates a short message by just considering the Throwable's root cause Throwable.getCause() as well as Throwable.getSuppressed() root exceptions only.

Methods inherited from interface org.refcodes.exception.ErrorCodeAccessor

getErrorCode

Method Details

toMessage

default String toMessage()

Generates a message by considering a Throwable's cause Throwable.getCause() as well as suppressed Throwable.getSuppressed() exceptions.

Returns:

The according more verbose Exception's message.

toLocalizedMessage

default String toLocalizedMessage()

Generates a localized message by considering a Throwable's Throwable.getCause() cause as well as Throwable.getSuppressed() exceptions.

Returns:

The according more verbose Exception's message.

toShortMessage

default String toShortMessage()

Generates a short message by just considering a Throwable's root cause Throwable.getCause() as well as root Throwable.getSuppressed() exceptions only.

Returns:

The according more verbose shorter Exception's message.

toShortLocalizedMessage

default String toShortLocalizedMessage()

Generates a short localized message by just considering a Throwable's Throwable.getCause() root cause as well as root Throwable.getSuppressed() exceptions only.

Returns:

The according more verbose shorter Exception's message.

toMessage

static String toMessage(Throwable aException)

Generates a message by considering the Throwable's cause Throwable.getCause() as well as Throwable.getSuppressed() exceptions.

Parameters:

aException - The Throwable from which to produce the message.

Returns:

The according more verbose Exception's message.

toLocalizedMessage

static String toLocalizedMessage(Throwable aException)

Generates a localized message by considering a Throwable's cause Throwable.getCause() as well as Throwable.getSuppressed() exceptions.

Parameters:

aException - The Throwable from which to produce the message.

Returns:

The according more verbose Exception's message.

toShortMessage

static String toShortMessage(Throwable aException)

Generates a short message by just considering the Throwable's root cause Throwable.getCause() as well as Throwable.getSuppressed() root exceptions only.

Parameters:

aException - The Throwable from which to produce the message.

Returns:

The according more verbose Exception's message.

toShortLocalizedMessage

static String toShortLocalizedMessage(Throwable aException)

Generates a short localized message by just considering a Throwable's root cause Throwable.getCause() as well as Throwable.getSuppressed() root exceptions only.

Parameters:

aException - The Throwable from which to produce the message.

Returns:

The according more verbose Exception's message.

toMessage

static String toMessage(String aMessage,
 Exception aException)

Creates a message from the provided message and the Exception's contained message(s).

Parameters:

aMessage - The message for which to generate the message.

aException - The Throwable from which to produce the message details.

Returns:

The resulting message.

toLocalizedMessage

static String toLocalizedMessage(String aMessage,
 Exception aException)

Creates a message from the provided message and the Exception's contained localized message(s).

Parameters:

aMessage - The message for which to generate the message.

aException - The Throwable from which to produce the message details.

Returns:

The resulting message.