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

java.lang.Object
  org.jboss.aerogear.controller.router.rest.pagination.PaginationInfo

public class PaginationInfo
extends Object

Holds information related to pagination in AeroGear Controller.

The parameter names will be provided using the Paginated annotation and the values will be the values contained in the current request. If the configured parameters are missing from the request, the default values specified in Paginated will be used.

See Also:

Paginated

Nested Class Summary

static interface	PaginationInfo.PaginationInfoBuilder
static class	PaginationInfo.PaginationInfoBuilderImpl

Field Summary

static String	DEFAULT_LIMIT_PARAM_NAME
static String	DEFAULT_OFFSET_PARAM_NAME
private com.google.common.base.Optional<String>	headerPrefix
private int	limit
private String	limitParamName
private int	offset
private String	offsetParamName
private boolean	webLinking

Constructor Summary

	PaginationInfo(String offsetParamName, int offset, String limitParamName, int limit)
private	PaginationInfo(String offsetParamName, int offset, String limitParamName, int limit, boolean webLinking, com.google.common.base.Optional<String> headerPrefix)
	PaginationInfo(String offsetParamName, int offset, String limitParamName, int limit, String headerPrefix)

Method Summary

com.google.common.base.Optional<String>	getHeaderPrefix()
int	getLimit()
String	getLimitParamName()
int	getOffset()
String	getOffsetParamName()
static PaginationInfo.PaginationInfoBuilder	offset(int value)
static PaginationInfo.PaginationInfoBuilder	offset(String offsetParamName, int value)
String	toString()
boolean	webLinking()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_OFFSET_PARAM_NAME

public static final String DEFAULT_OFFSET_PARAM_NAME

See Also:

Constant Field Values

DEFAULT_LIMIT_PARAM_NAME

public static final String DEFAULT_LIMIT_PARAM_NAME

See Also:

Constant Field Values

offsetParamName

private final String offsetParamName

offset

private final int offset

limitParamName

private final String limitParamName

limit

private final int limit

webLinking

private final boolean webLinking

headerPrefix

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

Constructor Detail

PaginationInfo

public PaginationInfo(String offsetParamName,
                      int offset,
                      String limitParamName,
                      int limit)

PaginationInfo

public PaginationInfo(String offsetParamName,
                      int offset,
                      String limitParamName,
                      int limit,
                      String headerPrefix)

PaginationInfo

private PaginationInfo(String offsetParamName,
                       int offset,
                       String limitParamName,
                       int limit,
                       boolean webLinking,
                       com.google.common.base.Optional<String> headerPrefix)

Method Detail

getOffsetParamName

public String getOffsetParamName()

getOffset

public int getOffset()

getLimitParamName

public String getLimitParamName()

getLimit

public int getLimit()

webLinking

public boolean webLinking()

toString

public String toString()

Overrides:

toString in class Object

getHeaderPrefix

public com.google.common.base.Optional<String> getHeaderPrefix()

offset

public static PaginationInfo.PaginationInfoBuilder offset(int value)

offset

public static PaginationInfo.PaginationInfoBuilder offset(String offsetParamName,
                                                          int value)