com.marklogic.client.query

Enum StructuredQueryBuilder.Ordering

java.lang.Object

java.lang.Enum<StructuredQueryBuilder.Ordering>

com.marklogic.client.query.StructuredQueryBuilder.Ordering

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StructuredQueryBuilder.Ordering>

Enclosing class:

StructuredQueryBuilder

public static enum StructuredQueryBuilder.Ordering
extends java.lang.Enum<StructuredQueryBuilder.Ordering>

Control over ordering for use in near queries.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ORDERED
UNORDERED

Method Summary

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

ORDERED

public static final StructuredQueryBuilder.Ordering ORDERED

UNORDERED

public static final StructuredQueryBuilder.Ordering UNORDERED

Method Detail

values

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

Returns:

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

valueOf

public static StructuredQueryBuilder.Ordering 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