de.susebox.java.lang

Class ThrowableMessageFormatter

java.lang.Object

de.susebox.java.lang.ThrowableMessageFormatter

public final class ThrowableMessageFormatter
extends java.lang.Object

This class is used by the implementations of the ThrowableList interface. Its method getMessage(de.susebox.java.lang.ThrowableList) formats the message that should be returned by the Throwable.getMessage() overridden by implementations of the ThrowableList interface.

Author:

Heiko Blau

See Also:

ThrowableList, Throwable, MessageFormat

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MSG_IDENTATION Message indentation for nested exceptions.

Constructor Summary

Constructors

Constructor and Description
ThrowableMessageFormatter()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getMessage(ThrowableList ex) This method should be called by all implementations of the ThrowableList interface in their Throwable.getMessage() implementation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MSG_IDENTATION

public static final java.lang.String MSG_IDENTATION

Message indentation for nested exceptions.

See Also:

Constant Field Values

Constructor Detail

ThrowableMessageFormatter

public ThrowableMessageFormatter()

Method Detail

getMessage

public static final java.lang.String getMessage(ThrowableList ex)

This method should be called by all implementations of the ThrowableList interface in their Throwable.getMessage() implementation. It ensures that the formatting of throwable lists, nested or wrapped exceptions is done in a consistent way.
The method returns an throwable message assembled in this way:

1. If the calling throwable is a wrapper throwable (see ThrowableList.isWrapper()), it delegates the call to the wrapped throwable (wrappedEx.getMessage()).
2. If there is a nested throwable (the calling throwable has a message of its own), the returned message starts with the string returned by the Object.toString() method, followed and separated by a end-of-line sequence by the formatted message of the calling throwable.
3. If the calling throwable has only a message without parameters, this message is either appended to the string produced by processing a nested throwable or is taken as the entire return value if there is no nested or subsequent throwable present.
4. If the calling throwable provides parameters along with a format string (the return value of super.getMessage is interpreted as a format string), a formatted message produced by MessageFormat.format(java.lang.Object[], java.lang.StringBuffer, java.text.FieldPosition) is either appended to the string produced by processing a nested throwable or is taken as the entire return value if there is no nested or subsequent throwable present.

Parameters:

ex - the calling throwable

Returns:

the formatted throwable message

See Also:

MessageFormat, ThrowableList