org.archive.crawler.framework

Enum CrawlStatus

java.lang.Object

java.lang.Enum<CrawlStatus>

org.archive.crawler.framework.CrawlStatus

All Implemented Interfaces:

Serializable, Comparable<CrawlStatus>

public enum CrawlStatus
extends Enum<CrawlStatus>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORTED Job was terminted by user input while crawling.
CHECKPOINTING Job is being checkpointed.
CREATED Inital value.
DELETED Job was deleted by user, will not be displayed in UI.
FINISHED Job finished normally having completed its crawl.
FINISHED_ABNORMAL Something went very wrong.
FINISHED_DATA_LIMIT Job finished normally when the specifed amount of data (MB) had been downloaded
FINISHED_DOCUMENT_LIMIT Job finished normally when the specified number of documents had been fetched.
FINISHED_TIME_LIMIT Job finished normally when the specified timelimit was hit.
FINISHED_WRITE_LIMIT
MISCONFIGURED Job could not be launced due to an InitializationException
PAUSED Job was temporarly stopped.
PENDING Job has been successfully submitted to a CrawlJobHandler.
PREPARING Prepared.
PROFILE Job is actually a profile
RUNNING Job is being crawled.
WAITING_FOR_PAUSE Job is going to be temporarly stopped after active threads are finished.

Field Summary

Fields

Modifier and Type	Field and Description
String	desc

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription()
static CrawlStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static CrawlStatus[]	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

CREATED

public static final CrawlStatus CREATED

Inital value. May not be ready to run/incomplete.

PENDING

public static final CrawlStatus PENDING

Job has been successfully submitted to a CrawlJobHandler.

RUNNING

public static final CrawlStatus RUNNING

Job is being crawled.

DELETED

public static final CrawlStatus DELETED

Job was deleted by user, will not be displayed in UI.

ABORTED

public static final CrawlStatus ABORTED

Job was terminted by user input while crawling.

FINISHED_ABNORMAL

public static final CrawlStatus FINISHED_ABNORMAL

Something went very wrong.

FINISHED

public static final CrawlStatus FINISHED

Job finished normally having completed its crawl.

FINISHED_TIME_LIMIT

public static final CrawlStatus FINISHED_TIME_LIMIT

Job finished normally when the specified timelimit was hit.

FINISHED_DATA_LIMIT

public static final CrawlStatus FINISHED_DATA_LIMIT

Job finished normally when the specifed amount of data (MB) had been downloaded

FINISHED_DOCUMENT_LIMIT

public static final CrawlStatus FINISHED_DOCUMENT_LIMIT

Job finished normally when the specified number of documents had been fetched.

FINISHED_WRITE_LIMIT

public static final CrawlStatus FINISHED_WRITE_LIMIT

WAITING_FOR_PAUSE

public static final CrawlStatus WAITING_FOR_PAUSE

Job is going to be temporarly stopped after active threads are finished.

PAUSED

public static final CrawlStatus PAUSED

Job was temporarly stopped. State is kept so it can be resumed

CHECKPOINTING

public static final CrawlStatus CHECKPOINTING

Job is being checkpointed. When finished checkpointing, job is set back to STATUS_PAUSED (Job must be first paused before checkpointing will run).

MISCONFIGURED

public static final CrawlStatus MISCONFIGURED

Job could not be launced due to an InitializationException

PROFILE

public static final CrawlStatus PROFILE

Job is actually a profile

PREPARING

public static final CrawlStatus PREPARING

Prepared.

Field Detail

desc

public final String desc

Method Detail

values

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

Returns:

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

valueOf

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

getDescription

public String getDescription()