org.forgerock.api.enums

Enum CountPolicy

java.lang.Object

java.lang.Enum<CountPolicy>

org.forgerock.api.enums.CountPolicy

All Implemented Interfaces:

Serializable, Comparable<CountPolicy>

public enum CountPolicy
extends Enum<CountPolicy>

Enum that represents the Query supported count-policy.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ESTIMATE Estimate count policy is supported.
EXACT Exact count policy is supported.
NONE No count policy is supported.

Method Summary

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

ESTIMATE

public static final CountPolicy ESTIMATE

Estimate count policy is supported.

EXACT

public static final CountPolicy EXACT

Exact count policy is supported.

NONE

public static final CountPolicy NONE

No count policy is supported.

Method Detail

values

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

Returns:

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

valueOf

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