com.marklogic.client.admin.config

Enum QueryOptions.QueryGrammar.QueryStarter.StarterApply

java.lang.Object

java.lang.Enum<QueryOptions.QueryGrammar.QueryStarter.StarterApply>

com.marklogic.client.admin.config.QueryOptions.QueryGrammar.QueryStarter.StarterApply

All Implemented Interfaces:

Serializable, Comparable<QueryOptions.QueryGrammar.QueryStarter.StarterApply>

Enclosing class:

QueryOptions.QueryGrammar.QueryStarter

public static enum QueryOptions.QueryGrammar.QueryStarter.StarterApply
extends Enum<QueryOptions.QueryGrammar.QueryStarter.StarterApply>

A StarterApply enumerates the built-in functions available to start terms.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GROUPING Groups the terms
PREFIX Prepends to the terms

Method Summary

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

GROUPING

public static final QueryOptions.QueryGrammar.QueryStarter.StarterApply GROUPING

Groups the terms

PREFIX

public static final QueryOptions.QueryGrammar.QueryStarter.StarterApply PREFIX

Prepends to the terms

Method Detail

values

public static QueryOptions.QueryGrammar.QueryStarter.StarterApply[] 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 (QueryOptions.QueryGrammar.QueryStarter.StarterApply c : QueryOptions.QueryGrammar.QueryStarter.StarterApply.values())
    System.out.println(c);

Returns:

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

valueOf

public static QueryOptions.QueryGrammar.QueryStarter.StarterApply 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