com.lucidworks.apollo.component

Enum BlobConfiguration.Field

java.lang.Object

java.lang.Enum<BlobConfiguration.Field>

com.lucidworks.apollo.component.BlobConfiguration.Field

All Implemented Interfaces:

com.lucidworks.apollo.common.EnumeratedField, java.io.Serializable, java.lang.Comparable<BlobConfiguration.Field>

Enclosing class:

BlobConfiguration

public static enum BlobConfiguration.Field
extends java.lang.Enum<BlobConfiguration.Field>
implements com.lucidworks.apollo.common.EnumeratedField

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTENT_TYPE
DIR the full directory leading to the blob specified in the FQPN
DIRS all of the legitimate path parts that come from the FQPN of the blob
FILENAME the filename portion of the FQPN of the blob
ID
MD5
MODIFICATION_TIME
NAME the fully qualified path name (FQPN) to the blob
PARTS
PATH
RAWDATA
ROOT
SEQUENCE
SIZE
TYPE
VERSION

Method Summary

Modifier and Type	Method and Description
static java.util.Set<java.lang.String>	getAllFieldNames()
static java.util.Set<java.lang.String>	getAllPrettyNames()
java.lang.String	getFieldName()
java.lang.String	getPrettyName()
static java.util.Set<BlobConfiguration.Field>	getRequiredManifestFields()
boolean	isManifestField()
boolean	isRequired()
static BlobConfiguration.Field	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BlobConfiguration.Field[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NAME

public static final BlobConfiguration.Field NAME

the fully qualified path name (FQPN) to the blob

PATH

public static final BlobConfiguration.Field PATH

SIZE

public static final BlobConfiguration.Field SIZE

MD5

public static final BlobConfiguration.Field MD5

MODIFICATION_TIME

public static final BlobConfiguration.Field MODIFICATION_TIME

CONTENT_TYPE

public static final BlobConfiguration.Field CONTENT_TYPE

VERSION

public static final BlobConfiguration.Field VERSION

TYPE

public static final BlobConfiguration.Field TYPE

ID

public static final BlobConfiguration.Field ID

PARTS

public static final BlobConfiguration.Field PARTS

RAWDATA

public static final BlobConfiguration.Field RAWDATA

SEQUENCE

public static final BlobConfiguration.Field SEQUENCE

ROOT

public static final BlobConfiguration.Field ROOT

DIRS

public static final BlobConfiguration.Field DIRS

all of the legitimate path parts that come from the FQPN of the blob

DIR

public static final BlobConfiguration.Field DIR

the full directory leading to the blob specified in the FQPN

FILENAME

public static final BlobConfiguration.Field FILENAME

the filename portion of the FQPN of the blob

Method Detail

values

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

Returns:

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

valueOf

public static BlobConfiguration.Field valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getRequiredManifestFields

public static java.util.Set<BlobConfiguration.Field> getRequiredManifestFields()

getAllFieldNames

public static java.util.Set<java.lang.String> getAllFieldNames()

getAllPrettyNames

public static java.util.Set<java.lang.String> getAllPrettyNames()

getFieldName

public java.lang.String getFieldName()

Specified by:

getFieldName in interface com.lucidworks.apollo.common.EnumeratedField

getPrettyName

public java.lang.String getPrettyName()

Specified by:

getPrettyName in interface com.lucidworks.apollo.common.EnumeratedField

isRequired

public boolean isRequired()

Specified by:

isRequired in interface com.lucidworks.apollo.common.EnumeratedField

isManifestField

public boolean isManifestField()