Package org.apache.juneau.commons.utils

Class ThrowableUtils

java.lang.Object

org.apache.juneau.commons.utils.ThrowableUtils

public class ThrowableUtils
extends Object

Various utility methods for creating and working with throwables.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ThrowableUtils.SupplierWithThrowable<T>	Interface used with Utils.safeSupplier(SupplierWithThrowable).

Constructor Summary

Constructors

Constructor	Description
ThrowableUtils()

Method Summary

Modifier and Type	Method	Description
static BeanRuntimeException	bex(Class<?> c, String msg, Object... args)	Shortcut for creating a BeanRuntimeException with a message and associated class.
static BeanRuntimeException	bex(String msg, Object... args)	Creates a RuntimeException.
static BeanRuntimeException	bex(Throwable cause)	Creates a RuntimeException wrapping the given throwable.
static BeanRuntimeException	bex(Throwable e, Class<?> c, String msg, Object... args)	Shortcut for creating a BeanRuntimeException with a cause, message, and associated class.
static BeanRuntimeException	bex(Throwable cause, String msg, Object... args)	Creates a RuntimeException with a cause.
static BeanRuntimeException	bex(Throwable e, ClassInfo c, String msg, Object... args)	Shortcut for creating a BeanRuntimeException with a cause, message, and associated class.
static BeanRuntimeException	bex(ClassInfo c, String msg, Object... args)	Shortcut for creating a BeanRuntimeException with a message and associated class.
static <T> T	castException(Class<T> type, Throwable t)	Casts or wraps the specified throwable to the specified type.
static ExecutableException	exex(String msg, Object... args)	Shortcut for creating an ExecutableException with a message.
static ExecutableException	exex(Throwable cause)	Creates an ExecutableException wrapping the given throwable.
static ExecutableException	exex(Throwable cause, String msg, Object... args)	Creates an ExecutableException with a cause.
static <T extends Throwable> Optional<T>	findCause(Throwable e, Class<T> cause)	Searches through the cause chain of an exception to find an exception of the specified type.
static String	getStackTrace(Throwable t)	Convenience method for getting a stack trace as a string.
static <T extends Throwable> T	getThrowableCause(Class<T> c, Throwable t)	Same as Throwable.getCause() but searches the throwable chain for an exception of the specified type.
static int	hash(Throwable t, String stopClass)	Calculates a 16-bit hash for the specified throwable based on it's stack trace.
static IllegalArgumentException	illegalArg(String msg, Object... args)	Creates an IllegalArgumentException.
static IllegalArgumentException	illegalArg(Throwable cause)	Creates an IllegalArgumentException wrapping the given throwable.
static IllegalArgumentException	illegalArg(Throwable cause, String msg, Object... args)	Creates an IllegalArgumentException with a cause.
static IllegalStateException	illegalState(String msg, Object... args)	Creates an IllegalStateException with a formatted message.
static IOException	ioex(String msg, Object... args)	Creates an IOException.
static IOException	ioex(Throwable cause)	Creates an IOException wrapping the given throwable.
static IOException	ioex(Throwable cause, String msg, Object... args)	Creates an IOException with a cause.
static String	lm(Throwable t)	Convenience method for calling Throwable.getLocalizedMessage().
static void	printStackTrace(Throwable t, PrintWriter pw, Integer maxDepth)	Prints a stack trace with a maximum depth limit.
static void	printStackTrace(Throwable t, Integer maxDepth)	Prints a stack trace with a maximum depth limit to standard error.
static RuntimeException	rex(String msg, Object... args)	Creates a RuntimeException.
static RuntimeException	rex(Throwable cause)	Creates a RuntimeException wrapping the given throwable.
static RuntimeException	rex(Throwable cause, String msg, Object... args)	Creates a RuntimeException with a cause.
static RuntimeException	toRex(Throwable cause)	Creates a new RuntimeException.
static UnsupportedOperationException	unsupportedOp()	Creates an UnsupportedOperationException with a default message.
static UnsupportedOperationException	unsupportedOp(String msg, Object... args)	Creates an UnsupportedOperationException.
static UnsupportedOperationException	unsupportedOp(Throwable cause)	Creates an UnsupportedOperationException wrapping the given throwable.
static UnsupportedOperationException	unsupportedOp(Throwable cause, String msg, Object... args)	Creates an UnsupportedOperationException with a cause.
static UnsupportedOperationException	unsupportedOpReadOnly()	Creates an UnsupportedOperationException for read-only objects.

Methods inherited from class java.lang.Object

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

Constructor Details

ThrowableUtils

public ThrowableUtils()

Method Details

bex

public static BeanRuntimeException bex(Class<?> c,
 String msg,
 Object... args)

Shortcut for creating a BeanRuntimeException with a message and associated class.

Parameters:

c - The class associated with the exception.

msg - The message.

args - Optional String.format(String, Object...) arguments.

Returns:

A new BeanRuntimeException.

bex

public static BeanRuntimeException bex(ClassInfo c,
 String msg,
 Object... args)

Shortcut for creating a BeanRuntimeException with a message and associated class.

Same as the bex(Class, String, Object...) method but accepts a ClassInfo instead of a Class.

Parameters:

c - The class info associated with the exception.

msg - The message.

args - Optional String.format(String, Object...) arguments.

Returns:

A new BeanRuntimeException.

bex

public static BeanRuntimeException bex(String msg,
 Object... args)

Creates a RuntimeException.

Parameters:

msg - The exception message.

args - The arguments to substitute into the message.

Returns:

A new RuntimeException with the formatted message.

bex

public static BeanRuntimeException bex(Throwable cause)

Creates a RuntimeException wrapping the given throwable.

Parameters:

cause - The cause of the exception.

Returns:

A new RuntimeException wrapping the given cause.

bex

public static BeanRuntimeException bex(Throwable e,
 Class<?> c,
 String msg,
 Object... args)

Shortcut for creating a BeanRuntimeException with a cause, message, and associated class.

Parameters:

e - The cause of the exception.

c - The class associated with the exception.

msg - The message.

args - Optional String.format(String, Object...) arguments.

Returns:

A new BeanRuntimeException.

bex

public static BeanRuntimeException bex(Throwable e,
 ClassInfo c,
 String msg,
 Object... args)

Shortcut for creating a BeanRuntimeException with a cause, message, and associated class.

Same as the bex(Throwable, Class, String, Object...) method but accepts a ClassInfo instead of a Class.

Parameters:

e - The cause of the exception.

c - The class info associated with the exception.

msg - The message.

args - Optional String.format(String, Object...) arguments.

Returns:

A new BeanRuntimeException.

bex

public static BeanRuntimeException bex(Throwable cause,
 String msg,
 Object... args)

Creates a RuntimeException with a cause.

Parameters:

cause - The cause of the exception.

msg - The exception message.

args - The arguments to substitute into the message.

Returns:

A new RuntimeException with the formatted message and cause.

exex

public static ExecutableException exex(String msg,
 Object... args)

Shortcut for creating an ExecutableException with a message.

Parameters:

msg - The message.

args - Optional String.format(String, Object...) arguments.

Returns:

A new ExecutableException.

exex

public static ExecutableException exex(Throwable cause)

Creates an ExecutableException wrapping the given throwable.

Parameters:

cause - The cause of the exception.

Returns:

A new ExecutableException wrapping the given cause.

exex

public static ExecutableException exex(Throwable cause,
 String msg,
 Object... args)

Creates an ExecutableException with a cause.

Parameters:

cause - The cause of the exception.

msg - The exception message.

args - The arguments to substitute into the message.

Returns:

A new ExecutableException with the formatted message and cause.

castException

public static <T> T castException(Class<T> type,
 Throwable t)

Casts or wraps the specified throwable to the specified type.

Type Parameters:

T - The class to cast to.

Parameters:

type - The class to cast to.

t - The throwable to cast.

Returns:

Either the same exception if it's already the specified type, or a wrapped exception.

findCause

public static <T extends Throwable> Optional<T> findCause(Throwable e,
 Class<T> cause)

Searches through the cause chain of an exception to find an exception of the specified type.

Type Parameters:

T - The cause type.

Parameters:

e - The exception to search.

cause - The cause type to search for.

Returns:

An Optional containing the cause if found, or empty if not found.

getStackTrace

public static String getStackTrace(Throwable t)

Convenience method for getting a stack trace as a string.

Parameters:

t - The throwable to get the stack trace from.

Returns:

The same content that would normally be rendered via t.printStackTrace()

printStackTrace

public static void printStackTrace(Throwable t,
 PrintWriter pw,
 Integer maxDepth)

Prints a stack trace with a maximum depth limit.

This method is useful for StackOverflowError situations where printing the full stack trace can cause additional errors due to stack exhaustion. The stack trace will be limited to the specified maximum number of elements.

Example:

try { // Some code that might cause StackOverflowError } catch (StackOverflowError e) { // Print only first 100 stack trace elements ThrowableUtils.printStackTrace(e, System.err, 100); }

Parameters:

t - The throwable to print the stack trace for.

pw - The print writer to write to.

maxDepth - The maximum number of stack trace elements to print. If null or negative, prints all elements.

printStackTrace

public static void printStackTrace(Throwable t,
 Integer maxDepth)

Prints a stack trace with a maximum depth limit to standard error.

This method is useful for StackOverflowError situations where printing the full stack trace can cause additional errors due to stack exhaustion. The stack trace will be limited to the specified maximum number of elements.

Same as printStackTrace(Throwable, PrintWriter, Integer) but writes to System.err.

Example:

try { // Some code that might cause StackOverflowError } catch (StackOverflowError e) { // Print only first 100 stack trace elements to stderr ThrowableUtils.printStackTrace(e, 100); }

Parameters:

t - The throwable to print the stack trace for.

maxDepth - The maximum number of stack trace elements to print. If null or negative, prints all elements.

getThrowableCause

public static <T extends Throwable> T getThrowableCause(Class<T> c,
 Throwable t)

Same as Throwable.getCause() but searches the throwable chain for an exception of the specified type.

Type Parameters:

T - The throwable type to search for.

Parameters:

c - The throwable type to search for.

t - The throwable to search.

Returns:

The exception, or null if not found.

hash

public static int hash(Throwable t,
 String stopClass)

Calculates a 16-bit hash for the specified throwable based on it's stack trace.

Parameters:

t - The throwable to calculate the stack trace on.

stopClass - Optional stop class on which to stop calculation of a stack trace beyond when found.

Returns:

A calculated hash.

illegalArg

public static IllegalArgumentException illegalArg(String msg,
 Object... args)

Creates an IllegalArgumentException.

Parameters:

msg - The exception message.

args - The arguments to substitute into the message.

Returns:

A new IllegalArgumentException with the formatted message.

illegalState

public static IllegalStateException illegalState(String msg,
 Object... args)

Creates an IllegalStateException with a formatted message.

This is a convenience method for creating state exceptions with formatted messages. The message is formatted using Utils.f(String, Object...).

Example:

throw illegalState("Invalid state: {0}", state);

Parameters:

msg - The message format string.

args - The arguments for the message format string.

Returns:

A new IllegalStateException with the formatted message.

See Also:

• Utils.f(String, Object...)
• illegalArg(String, Object...)

illegalArg

public static IllegalArgumentException illegalArg(Throwable cause)

Creates an IllegalArgumentException wrapping the given throwable.

Parameters:

cause - The cause of the exception.

Returns:

A new IllegalArgumentException wrapping the given cause.

illegalArg

public static IllegalArgumentException illegalArg(Throwable cause,
 String msg,
 Object... args)

Creates an IllegalArgumentException with a cause.

Parameters:

cause - The cause of the exception.

msg - The exception message.

args - The arguments to substitute into the message.

Returns:

A new IllegalArgumentException with the formatted message and cause.

ioex

public static IOException ioex(String msg,
 Object... args)

Creates an IOException.

Parameters:

msg - The exception message.

args - The arguments to substitute into the message.

Returns:

A new IOException with the formatted message.

ioex

public static IOException ioex(Throwable cause)

Creates an IOException wrapping the given throwable.

Parameters:

cause - The cause of the exception.

Returns:

A new IOException wrapping the given cause.

ioex

public static IOException ioex(Throwable cause,
 String msg,
 Object... args)

Creates an IOException with a cause.

Parameters:

cause - The cause of the exception.

msg - The exception message.

args - The arguments to substitute into the message.

Returns:

A new IOException with the formatted message and cause.

lm

public static String lm(Throwable t)

Convenience method for calling Throwable.getLocalizedMessage().

Parameters:

t - The throwable.

Returns:

The localized message of the throwable.

rex

public static RuntimeException rex(String msg,
 Object... args)

Creates a RuntimeException.

Parameters:

msg - The exception message.

args - The arguments to substitute into the message.

Returns:

A new RuntimeException with the formatted message.

rex

public static RuntimeException rex(Throwable cause)

Creates a RuntimeException wrapping the given throwable.

Parameters:

cause - The cause of the exception.

Returns:

A new RuntimeException wrapping the given cause.

rex

public static RuntimeException rex(Throwable cause,
 String msg,
 Object... args)

Creates a RuntimeException with a cause.

Parameters:

cause - The cause of the exception.

msg - The exception message.

args - The arguments to substitute into the message.

Returns:

A new RuntimeException with the formatted message and cause.

toRex

public static RuntimeException toRex(Throwable cause)

Creates a new RuntimeException.

Parameters:

cause - The caused-by exception.

Returns:

A new RuntimeException, or the same exception if it's already of that type.

unsupportedOp

public static UnsupportedOperationException unsupportedOp()

Creates an UnsupportedOperationException with a default message.

Returns:

A new UnsupportedOperationException with the message "Not supported."

unsupportedOp

public static UnsupportedOperationException unsupportedOp(String msg,
 Object... args)

Creates an UnsupportedOperationException.

Parameters:

msg - The exception message.

args - The arguments to substitute into the message.

Returns:

A new UnsupportedOperationException with the formatted message.

unsupportedOp

public static UnsupportedOperationException unsupportedOp(Throwable cause)

Creates an UnsupportedOperationException wrapping the given throwable.

Parameters:

cause - The cause of the exception.

Returns:

A new UnsupportedOperationException wrapping the given cause.

unsupportedOp

public static UnsupportedOperationException unsupportedOp(Throwable cause,
 String msg,
 Object... args)

Creates an UnsupportedOperationException with a cause.

Parameters:

cause - The cause of the exception.

msg - The exception message.

args - The arguments to substitute into the message.

Returns:

A new UnsupportedOperationException with the formatted message and cause.

unsupportedOpReadOnly

public static UnsupportedOperationException unsupportedOpReadOnly()

Creates an UnsupportedOperationException for read-only objects.

Returns:

A new UnsupportedOperationException with the message "Object is read only."