net.sf.eos.lucene
Enum CommonDocument.FieldName

java.lang.Object
  java.lang.Enum<CommonDocument.FieldName>
      net.sf.eos.lucene.CommonDocument.FieldName

All Implemented Interfaces:

Serializable, Comparable<CommonDocument.FieldName>

Enclosing interface:

CommonDocument

public static enum CommonDocument.FieldName
extends Enum<CommonDocument.FieldName>

The field names.

Enum Constant Summary

CONTENT
The name of the content field.

CREATOR
The name of the creator meta values.

ID
The name of the ID meta values.

YEAR
The name of the creator meta values.

Method Summary

static CommonDocument.FieldName	valueOf(String name) Returns the enum constant of this type with the specified name.
static CommonDocument.FieldName[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONTENT

public static final CommonDocument.FieldName CONTENT

The name of the content field. Represents the value of EosDocument.getText().

See Also:

DefaultLuceneDocumentCreator

CREATOR

public static final CommonDocument.FieldName CREATOR

The name of the creator meta values.

See Also:

DefaultLuceneDocumentCreator

ID

public static final CommonDocument.FieldName ID

The name of the ID meta values.

See Also:

DefaultLuceneDocumentCreator

YEAR

public static final CommonDocument.FieldName YEAR

The name of the creator meta values.

See Also:

DefaultLuceneDocumentCreator

Method Detail

values

public static final CommonDocument.FieldName[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(CommonDocument.FieldName c : CommonDocument.FieldName.values())
        System.out.println(c);

Returns:

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

valueOf

public static CommonDocument.FieldName 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