org.icij.extract.queue

Enum DocumentQueueType

java.lang.Object

java.lang.Enum<DocumentQueueType>

org.icij.extract.queue.DocumentQueueType

All Implemented Interfaces:

Serializable, Comparable<DocumentQueueType>

public enum DocumentQueueType
extends Enum<DocumentQueueType>

An enumerated list of implemented queue types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARRAY
MYSQL
REDIS

Method Summary

Modifier and Type	Method and Description
static DocumentQueueType	parse(String queueType) Parse the given string representation of the type into an instance.
String	toString() Return the name of the queue type.
static DocumentQueueType	valueOf(String name) Returns the enum constant of this type with the specified name.
static DocumentQueueType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ARRAY

public static final DocumentQueueType ARRAY

REDIS

public static final DocumentQueueType REDIS

MYSQL

public static final DocumentQueueType MYSQL

Method Detail

values

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

Returns:

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

valueOf

public static DocumentQueueType 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

toString

public String toString()

Return the name of the queue type.

Overrides:

toString in class Enum<DocumentQueueType>

Returns:

The name of the queue type.

parse

public static DocumentQueueType parse(String queueType)

Parse the given string representation of the type into an instance.

Parameters:

queueType - the type of queue as a string value

Returns:

The type of queue as a DocumentQueueType instance.