Module org.refcodes.exception

Package org.refcodes.exception

Enum Class MessageDetails

java.lang.Object

java.lang.Enum<MessageDetails>

org.refcodes.exception.MessageDetails

All Implemented Interfaces:

Serializable, Comparable<MessageDetails>, Constable, Function<Throwable,String>

public enum MessageDetails
extends Enum<MessageDetails>
implements Function<Throwable,String>

The MessageDetails enumeration provides different detail levels when generating exception messages from Throwable exceptions using the Trap.toMessage(MessageDetails) method. The MessageDetails enumeration actually defines Function methods for construction the messages and the Trap.toMessage(MessageDetails) method actually just forwards its MessageDetails argument (itself being a Function) to the Trap.toMessage(Function) method.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FULL	All messages including all (children's) causes (Throwable.getCause()) together with all (children's) suppressed exceptions (Throwable.getSuppressed()) are taken into account.
FULL_LOCALIZED	All localized messages including all (children's) causes (Throwable.getCause()) together with all (children's) suppressed exceptions (Throwable.getSuppressed()) are taken into account.
PLAIN	Same as Throwable.getMessage()
PLAIN_LOCALIZED	Same as Throwable.getLocalizedMessage()
SHORT	Just the messages from the root causes (the roots of Throwable.getCause()) and root suppressed exceptions (the roots of Throwable.getSuppressed()) are taken into account.
SHORT_LOCALIZED	Just the localized messages from the root causes (the roots of Throwable.getCause()) and root suppressed exceptions (the roots of Throwable.getSuppressed()) are taken into account.

Method Summary

Modifier and Type	Method	Description
String	apply(Throwable eException)
static MessageDetails	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MessageDetails[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.function.Function

andThen, compose

Enum Constant Details

PLAIN

public static final MessageDetails PLAIN

Same as Throwable.getMessage()

PLAIN_LOCALIZED

public static final MessageDetails PLAIN_LOCALIZED

Same as Throwable.getLocalizedMessage()

SHORT

public static final MessageDetails SHORT

Just the messages from the root causes (the roots of Throwable.getCause()) and root suppressed exceptions (the roots of Throwable.getSuppressed()) are taken into account.

SHORT_LOCALIZED

public static final MessageDetails SHORT_LOCALIZED

Just the localized messages from the root causes (the roots of Throwable.getCause()) and root suppressed exceptions (the roots of Throwable.getSuppressed()) are taken into account.

FULL

public static final MessageDetails FULL

All messages including all (children's) causes (Throwable.getCause()) together with all (children's) suppressed exceptions (Throwable.getSuppressed()) are taken into account.

FULL_LOCALIZED

public static final MessageDetails FULL_LOCALIZED

All localized messages including all (children's) causes (Throwable.getCause()) together with all (children's) suppressed exceptions (Throwable.getSuppressed()) are taken into account.

Method Details

values

public static MessageDetails[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static MessageDetails valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

apply

public String apply(Throwable eException)

Specified by:

apply in interface Function<Throwable,String>