Package rx.exceptions

Class CompositeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

rx.exceptions.CompositeException

All Implemented Interfaces:

Serializable

public final class CompositeException
extends RuntimeException

Represents an exception that is a composite of one or more other exceptions. A CompositeException does not modify the structure of any exception it wraps, but at print-time it iterates through the list of Throwables contained in the composite in order to print them all. Its invariant is to contain an immutable, ordered (by insertion order), unique list of non-composite exceptions. You can retrieve individual exceptions in this list with getExceptions(). The printStackTrace() implementation handles the StackTrace in a customized way instead of using getCause() so that it can avoid circular references. If you invoke getCause(), it will lazily create the causal chain but will stop if it finds any Throwable in the chain that it has already seen.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	CompositeException.CompositeExceptionCausalChain
(package private) static class	CompositeException.PrintStreamOrWriter
(package private) static final class	CompositeException.WrappedPrintStream	Same abstraction and implementation as in JDK to allow PrintStream and PrintWriter to share implementation
(package private) static final class	CompositeException.WrappedPrintWriter

Field Summary

Fields

Modifier and Type	Field	Description
private Throwable	cause
private final List<Throwable>	exceptions
private final String	message
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
CompositeException(String messagePrefix, Collection<? extends Throwable> errors)	Deprecated. please use CompositeException(Collection)
CompositeException(Throwable... errors)	Constructs a CompositeException instance with the supplied initial Throwables.
CompositeException(Collection<? extends Throwable> errors)

Method Summary

Modifier and Type	Method	Description
private void	appendStackTrace(StringBuilder bldr, Throwable ex, String prefix)
Throwable	getCause()
List<Throwable>	getExceptions()	Retrieves the list of exceptions that make up the CompositeException
private List<Throwable>	getListOfCauses(Throwable ex)
String	getMessage()
private Throwable	getRootCause(Throwable e)	Returns the root cause of e.
void	printStackTrace()	All of the following printStackTrace functionality is derived from JDK Throwable printStackTrace.
void	printStackTrace(PrintStream s)
void	printStackTrace(PrintWriter s)
private void	printStackTrace(CompositeException.PrintStreamOrWriter s)	Special handling for printing out a CompositeException.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getLocalizedMessage, getStackTrace, getSuppressed, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

exceptions

private final List<Throwable> exceptions

message

private final String message

cause

private Throwable cause

Constructor Details

CompositeException

@Deprecated
public CompositeException(String messagePrefix,
 Collection<? extends Throwable> errors)

Deprecated.

please use CompositeException(Collection)

Constructs a CompositeException with the given prefix and error collection.

Parameters:

messagePrefix - the prefix to use (actually unused)

errors - the collection of errors

CompositeException

public CompositeException(Collection<? extends Throwable> errors)

CompositeException

@Experimental
public CompositeException(Throwable... errors)

Constructs a CompositeException instance with the supplied initial Throwables.

Parameters:

errors - the array of Throwables

Method Details

getExceptions

public List<Throwable> getExceptions()

Retrieves the list of exceptions that make up the CompositeException

Returns:

the exceptions that make up the CompositeException, as a List of Throwables

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getCause

public Throwable getCause()

Overrides:

getCause in class Throwable

printStackTrace

public void printStackTrace()

All of the following printStackTrace functionality is derived from JDK Throwable printStackTrace. In particular, the PrintStreamOrWriter abstraction is copied wholesale. Changes from the official JDK implementation:

• no infinite loop detection
• smaller critical section holding PrintStream lock
• explicit knowledge about the exceptions List that this loops through

Overrides:

printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintStream s)

Overrides:

printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintWriter s)

Overrides:

printStackTrace in class Throwable

printStackTrace

private void printStackTrace(CompositeException.PrintStreamOrWriter s)

Special handling for printing out a CompositeException. Loops through all inner exceptions and prints them out.

Parameters:

s - stream to print to

appendStackTrace

private void appendStackTrace(StringBuilder bldr,
 Throwable ex,
 String prefix)

getListOfCauses

private List<Throwable> getListOfCauses(Throwable ex)

getRootCause

private Throwable getRootCause(Throwable e)

Returns the root cause of e. If e.getCause() returns or e, just return e itself.

Parameters:

e - the Throwable e.

Returns:

The root cause of e. If e.getCause() returns or e, just return e itself.