atg.endeca.index.admin

Enum Status

java.lang.Object

java.lang.Enum<Status>

atg.endeca.index.admin.Status

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Status>

public enum Status
extends java.lang.Enum<Status>

A basic status enum for indexing tasks.

Created: November 23 2011

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELED
CANCELING
CLEANING
COMPLETE
PENDING
RUNNING
WAITING_FOR_CLEANUP

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string from source code control system.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayName(java.util.Locale pLocale) Return the status name in the specified Locale.
static java.lang.String	getResourceBundleName() Return the name of our resource bundle.
static Status	getStatusForOrdinal(int pOrdinal) Return the Status that corresponds to the specified ordinal value.
boolean	hasStarted() Return whether this indexing task ever started (in other words, not PENDING).
boolean	isFinished() Whether we are done.
boolean	isInProcess() Return whether hits status is in process.
static Status	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Status[]	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

PENDING

public static final Status PENDING

RUNNING

public static final Status RUNNING

WAITING_FOR_CLEANUP

public static final Status WAITING_FOR_CLEANUP

CLEANING

public static final Status CLEANING

CANCELING

public static final Status CANCELING

COMPLETE

public static final Status COMPLETE

CANCELED

public static final Status CANCELED

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string from source code control system.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getResourceBundleName

public static java.lang.String getResourceBundleName()

Return the name of our resource bundle.

getDisplayName

public java.lang.String getDisplayName(java.util.Locale pLocale)

Return the status name in the specified Locale. If there's no matching resource, return the default "name".

isInProcess

public boolean isInProcess()

Return whether hits status is in process. This does not include PENDING or CANCELED or COMPLETE.

hasStarted

public boolean hasStarted()

Return whether this indexing task ever started (in other words, not PENDING).

isFinished

public boolean isFinished()

Whether we are done.

getStatusForOrdinal

public static Status getStatusForOrdinal(int pOrdinal)

Return the Status that corresponds to the specified ordinal value.

Parameters:

pOrdinal - the integer ordinary value.