Package org.forgerock.api.enums

Enum PagingMode

java.lang.Object

java.lang.Enum<PagingMode>

org.forgerock.api.enums.PagingMode

All Implemented Interfaces:

Serializable, Comparable<PagingMode>

public enum PagingMode
extends Enum<PagingMode>

Enum that represents the Query paging mode.

Enum Constant Summary

Enum Constants

Enum Constant	Description
COOKIE	Paging mode is supported by cookies.
OFFSET	Paging mode is supported by offset.

Method Summary

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

COOKIE

public static final PagingMode COOKIE

Paging mode is supported by cookies.

OFFSET

public static final PagingMode OFFSET

Paging mode is supported by offset.

Method Detail

values

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

Returns:

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

valueOf

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