com.yahoo.bard.webservice.web.util

Enum PaginationLink

java.lang.Object

java.lang.Enum<PaginationLink>

com.yahoo.bard.webservice.web.util.PaginationLink

All Implemented Interfaces:

Serializable, Comparable<PaginationLink>

public enum PaginationLink
extends Enum<PaginationLink>

Enumerates the names of the page links that may show up in the headers and/or bodies of responses that contain pagination.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIRST
LAST
NEXT
PREVIOUS

Method Summary

Modifier and Type	Method and Description
String	getBodyName()
String	getHeaderName()
abstract OptionalInt	getPage(Pagination<?> page) Get the page number if the specified page exists relative to the current page.
static PaginationLink	valueOf(String name) Returns the enum constant of this type with the specified name.
static PaginationLink[]	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

FIRST

public static final PaginationLink FIRST

LAST

public static final PaginationLink LAST

NEXT

public static final PaginationLink NEXT

PREVIOUS

public static final PaginationLink PREVIOUS

Method Detail

values

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

Returns:

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

valueOf

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

getHeaderName

public String getHeaderName()

getBodyName

public String getBodyName()

getPage

public abstract OptionalInt getPage(Pagination<?> page)

Get the page number if the specified page exists relative to the current page.

Parameters:

page - Current page to evaluate

Returns:

a populated Optional if the page exists based on the current page, empty if not