com.endeca.itl.cas.api
Enum CrawlerState

java.lang.Object
  java.lang.Enum<CrawlerState>
      com.endeca.itl.cas.api.CrawlerState

All Implemented Interfaces:

Serializable, Comparable<CrawlerState>

public enum CrawlerState
extends Enum<CrawlerState>

Represents possible states of a crawl.

Enum Constant Summary

NOT_RUNNING
The crawl is not running.

RUNNING
The crawl is currently running.

STOPPING
The crawl is in the process of stopping, in response to a stop request.

Method Summary

static CrawlerState	fromValue(String v)
String	toString()
String	value()
static CrawlerState	valueOf(String name) Returns the enum constant of this type with the specified name.
static CrawlerState[]	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

NOT_RUNNING

public static final CrawlerState NOT_RUNNING

The crawl is not running.

STOPPING

public static final CrawlerState STOPPING

The crawl is in the process of stopping, in response to a stop request.

RUNNING

public static final CrawlerState RUNNING

The crawl is currently running.

Method Detail

values

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

Returns:

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

valueOf

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

value

public String value()

fromValue

public static CrawlerState fromValue(String v)

toString

public String toString()

Overrides:

toString in class Enum<CrawlerState>