Package com.norconex.crawler.core.fetch

Enum Class FetchDirective

java.lang.Object

java.lang.Enum<FetchDirective>

com.norconex.crawler.core.fetch.FetchDirective

All Implemented Interfaces:

Serializable, Comparable<FetchDirective>, Constable

public enum FetchDirective
extends Enum<FetchDirective>

Whether to perform metadata extraction on its own before (or instead) performing document extraction as a whole (including metadata).

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
DOCUMENT	A directive to execute a fetch request for the entire document, including metadata.
METADATA	A directive to execute a fetch request separate from document fetch.

Method Summary

Modifier and Type	Method	Description
boolean	is(FetchDirective fetchDirective)
static FetchDirective	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FetchDirective[]	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

METADATA

public static final FetchDirective METADATA

A directive to execute a fetch request separate from document fetch.

DOCUMENT

public static final FetchDirective DOCUMENT

A directive to execute a fetch request for the entire document, including metadata.

Method Details

values

public static FetchDirective[] 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 FetchDirective 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(FetchDirective fetchDirective)