Package com.yahoo.documentapi

Enum Class VisitorControlHandler.CompletionCode

java.lang.Object

java.lang.Enum<VisitorControlHandler.CompletionCode>

com.yahoo.documentapi.VisitorControlHandler.CompletionCode

All Implemented Interfaces:

Serializable, Comparable<VisitorControlHandler.CompletionCode>, Constable

Enclosing class:

VisitorControlHandler

public static enum VisitorControlHandler.CompletionCode
extends Enum<VisitorControlHandler.CompletionCode>

Possible completion codes for visiting.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABORTED	Aborted by user.
FAILURE	Fatal failure.
SUCCESS	Visited all specified data successfully.
TIMEOUT	Create visitor reply did not return within the specified timeframe, or the session timed out.

Method Summary

Modifier and Type	Method	Description
static VisitorControlHandler.CompletionCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VisitorControlHandler.CompletionCode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUCCESS

public static final VisitorControlHandler.CompletionCode SUCCESS

Visited all specified data successfully.

ABORTED

public static final VisitorControlHandler.CompletionCode ABORTED

Aborted by user.

FAILURE

public static final VisitorControlHandler.CompletionCode FAILURE

Fatal failure.

TIMEOUT

public static final VisitorControlHandler.CompletionCode TIMEOUT

Create visitor reply did not return within the specified timeframe, or the session timed out.

Method Details

values

public static VisitorControlHandler.CompletionCode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static VisitorControlHandler.CompletionCode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null