Package com.yahoo.documentapi.messagebus.protocol

Enum DocumentProtocol.Priority

java.lang.Object

java.lang.Enum<DocumentProtocol.Priority>

com.yahoo.documentapi.messagebus.protocol.DocumentProtocol.Priority

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DocumentProtocol.Priority>

Enclosing class:

DocumentProtocol

public static enum DocumentProtocol.Priority
extends java.lang.Enum<DocumentProtocol.Priority>

Defines the different priorities allowed for document api messages. Most user traffic should be fit into the NORMAL categories. Traffic in the HIGH end will be usually be prioritized over important maintenance operations. Traffic in the LOW end will be prioritized after these operations.

Enum Constant Summary

Enum Constants

Enum Constant	Description
HIGH_1
HIGH_2
HIGH_3
HIGHEST
LOW_1
LOW_2
LOW_3
LOWEST
NORMAL_1
NORMAL_2
NORMAL_3
NORMAL_4
NORMAL_5
NORMAL_6
VERY_HIGH
VERY_LOW

Method Summary

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

HIGHEST

public static final DocumentProtocol.Priority HIGHEST

VERY_HIGH

public static final DocumentProtocol.Priority VERY_HIGH

HIGH_1

public static final DocumentProtocol.Priority HIGH_1

HIGH_2

public static final DocumentProtocol.Priority HIGH_2

HIGH_3

public static final DocumentProtocol.Priority HIGH_3

NORMAL_1

public static final DocumentProtocol.Priority NORMAL_1

NORMAL_2

public static final DocumentProtocol.Priority NORMAL_2

NORMAL_3

public static final DocumentProtocol.Priority NORMAL_3

NORMAL_4

public static final DocumentProtocol.Priority NORMAL_4

NORMAL_5

public static final DocumentProtocol.Priority NORMAL_5

NORMAL_6

public static final DocumentProtocol.Priority NORMAL_6

LOW_1

public static final DocumentProtocol.Priority LOW_1

LOW_2

public static final DocumentProtocol.Priority LOW_2

LOW_3

public static final DocumentProtocol.Priority LOW_3

VERY_LOW

public static final DocumentProtocol.Priority VERY_LOW

LOWEST

public static final DocumentProtocol.Priority LOWEST

Method Detail

values

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

Returns:

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

valueOf

public static DocumentProtocol.Priority valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getValue

public int getValue()