com.endeca.itl.cas.api
Enum CrawlStopCause

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

All Implemented Interfaces:

Serializable, Comparable<CrawlStopCause>

public enum CrawlStopCause
extends Enum<CrawlStopCause>

Enumerator representing the way in which a crawl was stopped.

Enum Constant Summary

ABORTED
The crawl was aborted by the user.

COMPLETED
The crawl completed successfully.

FAILED
The crawl stopped due to a processing failure.

Method Summary

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

COMPLETED

public static final CrawlStopCause COMPLETED

The crawl completed successfully.

ABORTED

public static final CrawlStopCause ABORTED

The crawl was aborted by the user.

FAILED

public static final CrawlStopCause FAILED

The crawl stopped due to a processing failure.

Method Detail

values

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

Returns:

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

valueOf

public static CrawlStopCause 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 CrawlStopCause fromValue(String v)

toString

public String toString()

Overrides:

toString in class Enum<CrawlStopCause>