com.cerner.beadledom.pagination.models

Class OffsetPaginationConfiguration

java.lang.Object

com.cerner.beadledom.pagination.models.OffsetPaginationConfiguration

public abstract class OffsetPaginationConfiguration
extends Object

Configuration for offset based pagination. Allows configuration of the parameter names, their default values, and their allowed values.

Since:

3.1

Author:

Ian Kottman

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OffsetPaginationConfiguration.Builder

Constructor Summary

Constructors

Constructor and Description
OffsetPaginationConfiguration()

Method Summary

Modifier and Type	Method and Description
static OffsetPaginationConfiguration.Builder	builder() Creates a builder for OffsetPaginationConfiguration.
abstract Integer	defaultLimit() Default value for limit.
abstract Long	defaultOffset() Default value for offset.
abstract String	limitFieldName() Query parameter name for limit.
abstract Integer	maxLimit() Maximum allowed value for limit.
abstract String	offsetFieldName() Query parameter name for offset.

Methods inherited from class java.lang.Object

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

Constructor Detail

OffsetPaginationConfiguration

public OffsetPaginationConfiguration()

Method Detail

maxLimit

public abstract Integer maxLimit()

Maximum allowed value for limit. Defaults to 100.

defaultLimit

public abstract Integer defaultLimit()

Default value for limit. Defaults to 20.

limitFieldName

public abstract String limitFieldName()

Query parameter name for limit. Defaults to limit.

defaultOffset

public abstract Long defaultOffset()

Default value for offset. Defaults to 0.

offsetFieldName

public abstract String offsetFieldName()

Query parameter name for offset. Defaults to offset.

builder

public static OffsetPaginationConfiguration.Builder builder()

Creates a builder for OffsetPaginationConfiguration.

Returns:

instance of OffsetPaginationConfiguration.Builder