com.marklogic.client.type

Enum PlanValueOption

java.lang.Object

java.lang.Enum<PlanValueOption>

com.marklogic.client.type.PlanValueOption

All Implemented Interfaces:

PlanGroupConcatOptionSeq, PlanValueOptionSeq, java.io.Serializable, java.lang.Comparable<PlanValueOption>

public enum PlanValueOption
extends java.lang.Enum<PlanValueOption>
implements PlanValueOptionSeq

An option controlling whether to calculate over all values including duplicates or over distinct values for an aggregate expression in a row pipeline.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISTINCT
DUPLICATE

Method Summary

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

DISTINCT

public static final PlanValueOption DISTINCT

DUPLICATE

public static final PlanValueOption DUPLICATE

Method Detail

values

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

Returns:

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

valueOf

public static PlanValueOption 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