org.xwiki.store

Class TransactionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.xwiki.store.TransactionException

All Implemented Interfaces:

Serializable

public class TransactionException
extends Exception

An exception made up of a group of exceptions. This class satisfies the use case when multiple things which may throw exceptions must be done, each may throw an exception but the others must run all the same.

Since:

3.0M2

Version:

$Id: 0adbb2a0ab71fe6b01e5284f9afc3ca0917982f4 $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TransactionException(List<Throwable> causes) Constructor with message specified.
TransactionException(String message, List<Throwable> causes) Constructor with message specified.
TransactionException(String message, List<Throwable> causes, boolean isNonRecoverable) Constructor with message specified.

Method Summary

Modifier and Type	Method and Description
int	exceptionCount()
Throwable	getCause()
List<Throwable>	getCauses()
String	getMessage()
String	getStackTraceString() Utility method to get the stack trace for this exception as a string.
boolean	isNonRecoverable()
void	printStackTrace()
void	printStackTrace(PrintStream writeTo)
void	printStackTrace(PrintWriter writeTo)

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

Constructor Detail

TransactionException

public TransactionException(List<Throwable> causes)

Constructor with message specified.

Parameters:

causes - the list of Throwables which caused this exception.

TransactionException

public TransactionException(String message,
                            List<Throwable> causes)

Constructor with message specified.

Parameters:

message - the message to give with the exception.

causes - the list of Throwables which caused this exception.

TransactionException

public TransactionException(String message,
                            List<Throwable> causes,
                            boolean isNonRecoverable)

Constructor with message specified.

Parameters:

message - the message to give with the exception.

causes - the list of Throwables which caused this exception.

isNonRecoverable - true if the storage engine could not recover from this exception and corruption might have resulted.

Method Detail

getCause

public Throwable getCause()

Overrides:

getCause in class Throwable

getCauses

public List<Throwable> getCauses()

Returns:

all of the exceptions which caused this exception to be thrown.

exceptionCount

public int exceptionCount()

Returns:

the total number of exceptions which caused this exception to be thrown.

isNonRecoverable

public boolean isNonRecoverable()

Returns:

true if the storage engine could not recover from an exception in this group and corruption of the storage engine might have resulted.

getMessage

public String getMessage()

In this implementation the message is also included in the stack trace so calling both is redundant.

Overrides:

getMessage in class Throwable

See Also:

Throwable.getMessage()

getStackTraceString

public String getStackTraceString()

Utility method to get the stack trace for this exception as a string.

Returns:

what printStackTrace() would have printed.

printStackTrace

public void printStackTrace()

Overrides:

printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintStream writeTo)

Overrides:

printStackTrace in class Throwable

printStackTrace

public void printStackTrace(PrintWriter writeTo)

Overrides:

printStackTrace in class Throwable