Package com.norconex.crawler.core.ledger

Enum Class ProcessingStatus

java.lang.Object

java.lang.Enum<ProcessingStatus>

com.norconex.crawler.core.ledger.ProcessingStatus

All Implemented Interfaces:

Serializable, Comparable<ProcessingStatus>, Constable

public enum ProcessingStatus
extends Enum<ProcessingStatus>
implements Serializable

The different stages of a crawl entry processing life-cycle: UNTRACKED -> QUEUED -> PROCESSING -> PROCESSED

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PROCESSED	Processing completed a crawl entry.
PROCESSING	Processing started but did not yet finish or failed.
QUEUED	Queued in ledger for processing.
UNTRACKED	Nothing was done with this entry yet.

Method Summary

Modifier and Type	Method	Description
boolean	is(ProcessingStatus processingStage)
static ProcessingStatus	of(String processingStatus)
static ProcessingStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ProcessingStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNTRACKED

public static final ProcessingStatus UNTRACKED

Nothing was done with this entry yet. Could be rejected before being queued, which would leave no trace in the ledger. This is the default stage when discovering new references not yet queued or otherwise asking for a status of a reference not in the ledger.

QUEUED

public static final ProcessingStatus QUEUED

Queued in ledger for processing. Queuing a reference automatically set the state to queued.

PROCESSING

public static final ProcessingStatus PROCESSING

Processing started but did not yet finish or failed. Documents identified as processing when a crawl session is over are considered to be the result of an unrecoverable error and should be dealt with on next run..

PROCESSED

public static final ProcessingStatus PROCESSED

Processing completed a crawl entry.

Method Details

values

public static ProcessingStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ProcessingStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

is

public boolean is(ProcessingStatus processingStage)

of

public static ProcessingStatus of(String processingStatus)