com.marklogic.client.query

Enum StructuredQueryBuilder.FragmentScope

java.lang.Object

java.lang.Enum<StructuredQueryBuilder.FragmentScope>

com.marklogic.client.query.StructuredQueryBuilder.FragmentScope

All Implemented Interfaces:

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

Enclosing class:

StructuredQueryBuilder

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

Whether a query should search the document or its associated properties.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOCUMENTS
PROPERTIES

Method Summary

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

DOCUMENTS

public static final StructuredQueryBuilder.FragmentScope DOCUMENTS

PROPERTIES

public static final StructuredQueryBuilder.FragmentScope PROPERTIES

Method Detail

values

public static StructuredQueryBuilder.FragmentScope[] 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.FragmentScope c : StructuredQueryBuilder.FragmentScope.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.FragmentScope 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