org.apache.jackrabbit.oak.plugins.document

Enum DocumentStoreException.Type

java.lang.Object

java.lang.Enum<DocumentStoreException.Type>

org.apache.jackrabbit.oak.plugins.document.DocumentStoreException.Type

All Implemented Interfaces:

Serializable, Comparable<DocumentStoreException.Type>

Enclosing class:

DocumentStoreException

public static enum DocumentStoreException.Type
extends Enum<DocumentStoreException.Type>

Enum Constant Summary

Enum Constants

Enum Constant and Description
GENERIC A generic type of DocumentStoreException.
TRANSIENT A DocumentStoreException caused by a transient problem.

Method Summary

Modifier and Type	Method and Description
static DocumentStoreException.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static DocumentStoreException.Type[]	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

Enum Constant Detail

GENERIC

public static final DocumentStoreException.Type GENERIC

A generic type of DocumentStoreException. This type is used when no explicit type is given when a DocumentStoreException is constructed.

TRANSIENT

public static final DocumentStoreException.Type TRANSIENT

A DocumentStoreException caused by a transient problem. E.g. a network issue. This type of exception indicates a future invocation of the same operation may succeed if the underlying problem gets resolved.

Method Detail

values

public static DocumentStoreException.Type[] 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 (DocumentStoreException.Type c : DocumentStoreException.Type.values())
    System.out.println(c);

Returns:

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

valueOf

public static DocumentStoreException.Type 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