jakarta.nosql.mapping

Interface Pagination

public interface Pagination

Pagination is the process of separating print or digital content into discrete pages. This instance represents this pagination process.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Pagination.PaginationBuilder The builder of Pagination
static interface	Pagination.PaginationBuilderProvider A provider of Pagination.PaginationBuilder where it will create from the Long value

Method Summary

Modifier and Type	Method and Description
long	getLimit()
long	getPageNumber() Returns the page to be returned.
long	getPageSize() Returns the number of items to be returned.
long	getSkip()
Pagination	next() Returns the Pagination requesting the next Pagination.
static Pagination.PaginationBuilder	page(long page) A builder to Pagination, as the first step it defines the page number or the page index that starts from page one.
Pagination	unmodifiable() Returns a pagination instance that is read-only, in other words, that is not allowed to use the next().

Method Detail

getPageNumber

long getPageNumber()

Returns the page to be returned.

Returns:

the page to be returned.

getPageSize

long getPageSize()

Returns the number of items to be returned.

Returns:

the number of items of that page

getLimit

long getLimit()

Returns:

The maximum number of results the select object was set to retrieve. According to the underlying page and page size.

getSkip

long getSkip()

Returns:

The position of the first result the select object was set to retrieve. According to the underlying page and page size.

next

Pagination next()

Returns the Pagination requesting the next Pagination.

Returns:

the next pagination

unmodifiable

Pagination unmodifiable()

Returns a pagination instance that is read-only, in other words, that is not allowed to use the next().

Returns:

a read-onlye Pagination instance

page

static Pagination.PaginationBuilder page(long page)

A builder to Pagination, as the first step it defines the page number or the page index that starts from page one.

Parameters:

page - the page index

Returns:

a new Pagination.PaginationBuilder instance

Throws:

IllegalArgumentException - when page is lesser equals than zero