net.sf.mmm.util.exception.api

Class ComposedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

net.sf.mmm.util.exception.api.NlsRuntimeException

net.sf.mmm.util.exception.api.ComposedException

All Implemented Interfaces:

Serializable, Cloneable, NlsThrowable, AttributeReadMessage, AttributeReadMessageCode, AttributeReadUuid, NlsObject

public class ComposedException
extends NlsRuntimeException

An ComposedException combines a list of exceptions in one single exception. This is helpful if you are validating something and want to collect all errors and throw them as one exception with all information.
Otherwise you would stop at the first error, the user could fix it, restart and end up with the next error and so on.

Since:

2.0.1

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Throwable[]	errors The child errors.
static String	MESSAGE_CODE
private static long	serialVersionUID UID for serialization.

Fields inherited from interface net.sf.mmm.util.nls.api.NlsObject

KEY_ANNOTATION, KEY_ARGUMENT, KEY_CAPACITY, KEY_CONTAINER, KEY_DEFAULT, KEY_DIRECTORY, KEY_ERROR, KEY_EXISTING, KEY_EXPECTED, KEY_FILE, KEY_FUNCTION, KEY_ID, KEY_KEY, KEY_LOCATION, KEY_MAX, KEY_MIN, KEY_MODE, KEY_NAME, KEY_OBJECT, KEY_OPERAND, KEY_OPERATION, KEY_OPTION, KEY_PATH, KEY_PROPERTY, KEY_QUERY, KEY_RESOURCE, KEY_SIZE, KEY_SOURCE, KEY_TARGET_TYPE, KEY_TITLE, KEY_TYPE, KEY_URI, KEY_USER, KEY_VALUE

Constructor Summary

Constructors

Constructor and Description
ComposedException(NlsObject... errors) The constructor.
ComposedException(Throwable... errors) The constructor.

Method Summary

Modifier and Type	Method and Description
private static NlsMessage	createSubMessage(Object[] errors) This method creates the NlsMessage wrapping the given errors.
String	getCode() This method gets the code that identifies the detailed type of this object.
void	printStackTrace(Locale locale, Appendable buffer) This method prints the stack trace with localized exception message(s).

Methods inherited from class net.sf.mmm.util.exception.api.NlsRuntimeException

createBundle, createCopy, createCopyViaClone, createUuid, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getMessage, getNlsMessage, getUuid, isForUser, isTechnical, printStackTrace, toNlsMessage, toString, toString, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.mmm.util.exception.api.NlsThrowable

getCause, getStackTrace

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

MESSAGE_CODE

public static final String MESSAGE_CODE

See Also:

getCode(), Constant Field Values

errors

private Throwable[] errors

The child errors.

Constructor Detail

ComposedException

public ComposedException(Throwable... errors)

The constructor.

Parameters:

errors - are the errors that have been collected.

ComposedException

public ComposedException(NlsObject... errors)

The constructor.

Parameters:

errors - are the error messages that have been collected.

Method Detail

createSubMessage

private static NlsMessage createSubMessage(Object[] errors)

This method creates the NlsMessage wrapping the given errors.

Parameters:

errors - are the errors that have been collected.

Returns:

the combined NlsMessage.

printStackTrace

public void printStackTrace(Locale locale,
                            Appendable buffer)

This method prints the stack trace with localized exception message(s).

Specified by:

printStackTrace in interface NlsThrowable

Overrides:

printStackTrace in class NlsRuntimeException

Parameters:

locale - is the locale to translate to.

buffer - is where to write the stack trace to.

getCode

public String getCode()

This method gets the code that identifies the detailed type of this object. While UUID or ID are typically unique per instance of an object the code is unique for all instances of the exact same kind. So e.g. a particular kind of exception or ValidationFailure can be identified by its code. A simple generic implementation may return the classname or the key of the NLS message. However, the code should remain stable after refactoring (so at least after the rename the previous code should be returned as String literal). This code may be used as a compact identifier to reference the related problem or information as well as for automatic tests of error situations that should remain stable even if the message text gets improved or the locale is unknown.

Specified by:

getCode in interface AttributeReadMessageCode

Overrides:

getCode in class NlsRuntimeException

Returns:

the message text.

See Also:

Throwable.getMessage(), NlsThrowable, Message