org.jboss.aerogear.controller.router.rest.pagination

Class PaginationMetadata

java.lang.Object

org.jboss.aerogear.controller.router.rest.pagination.PaginationMetadata

public class PaginationMetadata
extends Object

Represents information about pagination in AeroGear Controller.

Provides access to "raw" Links, and PaginationProperties to enable developers to assemble pagination information in whatever way they choose.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_HEADER_PREFIX
private com.google.common.base.Optional<String>	headerPrefix
private Links	links
private PaginationProperties	params
private WebLinking	webLinking

Constructor Summary

Constructors

Modifier	Constructor and Description
	PaginationMetadata(PaginationProperties paging, RequestPathParser requestPathParser)
private	PaginationMetadata(PaginationProperties params, RequestPathParser requestPathParser, com.google.common.base.Optional<String> headerPrefix)
	PaginationMetadata(PaginationProperties paging, RequestPathParser requestPathParser, String headerPrefix)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,String>	getHeaders(int resultsSize)
Links	getLinks()
WebLinking	getWebLinking()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_HEADER_PREFIX

public static final String DEFAULT_HEADER_PREFIX

See Also:

Constant Field Values

links

private final Links links

webLinking

private final WebLinking webLinking

params

private final PaginationProperties params

headerPrefix

private final com.google.common.base.Optional<String> headerPrefix

Constructor Detail

PaginationMetadata

public PaginationMetadata(PaginationProperties paging,
                  RequestPathParser requestPathParser)

PaginationMetadata

public PaginationMetadata(PaginationProperties paging,
                  RequestPathParser requestPathParser,
                  String headerPrefix)

PaginationMetadata

private PaginationMetadata(PaginationProperties params,
                  RequestPathParser requestPathParser,
                  com.google.common.base.Optional<String> headerPrefix)

Method Detail

getLinks

public Links getLinks()

getHeaders

public Map<String,String> getHeaders(int resultsSize)

getWebLinking

public WebLinking getWebLinking()

toString

public String toString()

Overrides:

toString in class Object