net.sf.regain.crawler.config
Enum AuxiliaryField.SourceField

java.lang.Object
  java.lang.Enum<AuxiliaryField.SourceField>
      net.sf.regain.crawler.config.AuxiliaryField.SourceField

All Implemented Interfaces:

Serializable, Comparable<AuxiliaryField.SourceField>

Enclosing class:

AuxiliaryField

public static enum AuxiliaryField.SourceField
extends Enum<AuxiliaryField.SourceField>

The source field types

Enum Constant Summary

PATH
The document's path.

URL
The document's URL

Method Summary

static AuxiliaryField.SourceField	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuxiliaryField.SourceField[]	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

URL

public static final AuxiliaryField.SourceField URL

The document's URL

PATH

public static final AuxiliaryField.SourceField PATH

The document's path. For a file this is the path from the file system. For other documents this equals the URL

Method Detail

values

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

Returns:

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

valueOf

public static AuxiliaryField.SourceField 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