com.endeca.itl.cas.api
Enum CrawlMode

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

All Implemented Interfaces:

Serializable, Comparable<CrawlMode>

public enum CrawlMode
extends Enum<CrawlMode>

Enumeration representing possible modes for crawls: full or incremental.

Enum Constant Summary

FULL_CRAWL
The crawl's mode is a full acquisition

INCREMENTAL_CRAWL
The crawl's mode is an incremental acquisition

Method Summary

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

FULL_CRAWL

public static final CrawlMode FULL_CRAWL

The crawl's mode is a full acquisition

INCREMENTAL_CRAWL

public static final CrawlMode INCREMENTAL_CRAWL

The crawl's mode is an incremental acquisition

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<CrawlMode>

getAbbreviation

public String getAbbreviation()

Returns:

An abbreviation of the crawl mode used in the output filename.