Package com.shri.restinpeace.annotation.pagination

Enum PointerKind

java.lang.Object

java.lang.Enum<PointerKind>

com.shri.restinpeace.annotation.pagination.PointerKind

All Implemented Interfaces:

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

public enum PointerKind
extends Enum<PointerKind>

Whether a @Paginated method's extracted next-page pointer is a complete URL to follow verbatim, or a bare value to re-inject into the next request via a @PaginationCursor carrier. See docs/design/pagination-helper.md §6.1.

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
FULL_URL	The extracted pointer is a complete next-page URL, followed the same way an @Url parameter's value would be - no @PaginationCursor parameter is used (there's nothing to inject into).
VALUE	The extracted pointer is a bare cursor/token/page-number value, resent via whichever parameter carries @PaginationCursor.

Method Summary

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

FULL_URL

public static final PointerKind FULL_URL

The extracted pointer is a complete next-page URL, followed the same way an @Url parameter's value would be - no @PaginationCursor parameter is used (there's nothing to inject into).

VALUE

public static final PointerKind VALUE

The extracted pointer is a bare cursor/token/page-number value, resent via whichever parameter carries @PaginationCursor.

Method Details

values

public static PointerKind[] 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 PointerKind 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