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

Enum BuilderToken.QUERYARGS

java.lang.Object

java.lang.Enum<BuilderToken.QUERYARGS>

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

All Implemented Interfaces:

Serializable, Comparable<BuilderToken.QUERYARGS>

Enclosing class:

BuilderToken

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

Query args model

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEPTH Used in Set Depth (relative) part of each request
EXACTDEPTH Used in Set Depth (exact) part of each request
FIELDS Used in MLT queries
LIKE Used in MLT queries
MAX_EXPANSIONS Used in Match request

Method Summary

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

LIKE

public static final BuilderToken.QUERYARGS LIKE

Used in MLT queries

FIELDS

public static final BuilderToken.QUERYARGS FIELDS

Used in MLT queries

MAX_EXPANSIONS

public static final BuilderToken.QUERYARGS MAX_EXPANSIONS

Used in Match request

EXACTDEPTH

public static final BuilderToken.QUERYARGS EXACTDEPTH

Used in Set Depth (exact) part of each request

DEPTH

public static final BuilderToken.QUERYARGS DEPTH

Used in Set Depth (relative) part of each request

Method Detail

values

public static BuilderToken.QUERYARGS[] 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.QUERYARGS c : BuilderToken.QUERYARGS.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.QUERYARGS 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