fr.gouv.vitam.common.database.builder.request.configuration

Enum BuilderToken.FACETARGS

java.lang.Object

java.lang.Enum<BuilderToken.FACETARGS>

fr.gouv.vitam.common.database.builder.request.configuration.BuilderToken.FACETARGS

All Implemented Interfaces:

Serializable, Comparable<BuilderToken.FACETARGS>

Enclosing class:

BuilderToken

public static enum BuilderToken.FACETARGS
extends Enum<BuilderToken.FACETARGS>

FACET args model

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIELD Used in all facets
FORMAT Used in range facets
FROM Used in range facets
NAME Used in all facets
ORDER Used in terms facet
QUERY Used in filters facets
QUERY_FILTERS Used in filters facets
RANGES Used in range facets
SIZE Used in terms facet
TO Used in range facets

Method Summary

Modifier and Type	Method and Description
String	exactToken()
static BuilderToken.FACETARGS	valueOf(String name) Returns the enum constant of this type with the specified name.
static BuilderToken.FACETARGS[]	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

NAME

public static final BuilderToken.FACETARGS NAME

Used in all facets

FIELD

public static final BuilderToken.FACETARGS FIELD

Used in all facets

SIZE

public static final BuilderToken.FACETARGS SIZE

Used in terms facet

FROM

public static final BuilderToken.FACETARGS FROM

Used in range facets

TO

public static final BuilderToken.FACETARGS TO

Used in range facets

FORMAT

public static final BuilderToken.FACETARGS FORMAT

Used in range facets

QUERY_FILTERS

public static final BuilderToken.FACETARGS QUERY_FILTERS

Used in filters facets

QUERY

public static final BuilderToken.FACETARGS QUERY

Used in filters facets

RANGES

public static final BuilderToken.FACETARGS RANGES

Used in range facets

ORDER

public static final BuilderToken.FACETARGS ORDER

Used in terms facet

Method Detail

values

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

Returns:

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

valueOf

public static BuilderToken.FACETARGS 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

exactToken

public final String exactToken()

Returns:

the exact token