Package com.shri.restinpeace.annotation.pagination

Enum PaginationAdvance

java.lang.Object

java.lang.Enum<PaginationAdvance>

com.shri.restinpeace.annotation.pagination.PaginationAdvance

All Implemented Interfaces:

Serializable, Comparable<PaginationAdvance>, java.lang.constant.Constable

public enum PaginationAdvance
extends Enum<PaginationAdvance>

How the client advances to the next page on its own, when pointerSource = NONE (no server-given pointer at all) - offset or page-number arithmetic instead of following an extracted value. See docs/design/pagination-helper.md §6.1 and §6.5 (rollout chunk 7, §12).

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INCREMENT_BY_ONE	Advance the page number by one each fetch.
INCREMENT_BY_PAGE_SIZE	Advance the offset by pageSize each fetch.
NONE	No client-driven advancement - the default, used whenever pointerSource != NONE.

Method Summary

Modifier and Type	Method	Description
static PaginationAdvance	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PaginationAdvance[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final PaginationAdvance NONE

No client-driven advancement - the default, used whenever pointerSource != NONE.

INCREMENT_BY_PAGE_SIZE

public static final PaginationAdvance INCREMENT_BY_PAGE_SIZE

Advance the offset by pageSize each fetch.

INCREMENT_BY_ONE

public static final PaginationAdvance INCREMENT_BY_ONE

Advance the page number by one each fetch.

Method Details

values

public static PaginationAdvance[] values()

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

Returns:

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

valueOf

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