com.ibm.cloud.objectstorage.util

Enum Throwables

java.lang.Object

java.lang.Enum<Throwables>

com.ibm.cloud.objectstorage.util.Throwables

All Implemented Interfaces:

Serializable, Comparable<Throwables>

public enum Throwables
extends Enum<Throwables>

Utility for use with errors or exceptions.

Method Summary

Modifier and Type	Method and Description
static RuntimeException	failure(Throwable t) Used to help perform common throw-up with minimal wrapping.
static RuntimeException	failure(Throwable t, String errmsg) Same as Throwables.failure(Throwable), but the given errmsg will be used if it was wrapped as either an AmazonClientException or AbortedException.
static Throwable	getRootCause(Throwable orig) Returns the root cause of the given throwable, or null if the given throwable is null.
static Throwables	valueOf(String name) Returns the enum constant of this type with the specified name.
static Throwables[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static Throwables[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Throwables c : Throwables.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Throwables valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getRootCause

public static Throwable getRootCause(Throwable orig)

Returns the root cause of the given throwable, or null if the given throwable is null. If the root cause is over 1000 level deep, the original throwable will be returned defensively as this is heuristically considered a circular reference, however unlikely.

failure

public static RuntimeException failure(Throwable t)

Used to help perform common throw-up with minimal wrapping.

failure

public static RuntimeException failure(Throwable t,
                                       String errmsg)

Same as Throwables.failure(Throwable), but the given errmsg will be used if it was wrapped as either an AmazonClientException or AbortedException.