# Pagination

interface Pagination : ClosedRange < Int > (source)

Base interface of pagination

If you want to request something, you should use SimplePagination. If you need to return some result including pagination - PaginationResult

#### Inheritors

PaginationResult
SimplePagination

## Properties

asUrlQueryArrayParts
Link copied to clipboard
val Pagination . asUrlQueryArrayParts : Array < Pair < String , String >>
asUrlQueryParts
Link copied to clipboard
val Pagination . asUrlQueryParts : Map < String , String >
endInclusive
Link copied to clipboard
open override val endInclusive : Int
firstIndex
Link copied to clipboard
val Pagination . firstIndex : Int

First number in index of objects. It can be used as offset for databases or other data sources

isFirstPage
Link copied to clipboard
val Pagination . isFirstPage : Boolean

Logical shortcut for comparison that page is 0

lastIndex
Link copied to clipboard
val Pagination . lastIndex : Int

Last number in index of objects. In fact, one Pagination object represent data in next range:

lastIndexExclusive
Link copied to clipboard
val Pagination . lastIndexExclusive : Int

Last number in index of objects. In fact, one Pagination object represent data in next range:

page
Link copied to clipboard
abstract val page : Int

Started with 0. Number of page inside of pagination. Offset can be calculated as page * size

size
Link copied to clipboard
abstract val size : Int

Can be 0, but can't be < 0 Size of current page. Offset can be calculated as page * size

start
Link copied to clipboard
open override val start : Int

## Functions

contains
Link copied to clipboard
open operator fun contains (value: Int ): Boolean
firstPage
Link copied to clipboard
fun Pagination . firstPage (): Pagination
intersect
Link copied to clipboard
fun < T : Comparable < T >> ClosedRange < T >. intersect (other: ClosedRange < T >): Pair < T , T >?

Computes the intersection of this range with other. Returns a pair representing the intersecting range, or null if the ranges don't overlap.

fun Pagination . intersect (other: Pagination ): Pagination ?
isEmpty
Link copied to clipboard
open fun isEmpty (): Boolean
limitClause
Link copied to clipboard
fun Pagination . limitClause (): String
nextPage
Link copied to clipboard
inline fun Pagination . nextPage (): SimplePagination
optionallyReverse
Link copied to clipboard
fun Pagination . optionallyReverse (objectsCount: Int , reverse: Boolean ): Pagination
fun Pagination . optionallyReverse (objectsCount: Long , reverse: Boolean ): Pagination
previousPage
Link copied to clipboard
inline fun Pagination . previousPage (): SimplePagination

This method DO NOT check Pagination.page of receiver. Returns pagination for previous page

reverse
Link copied to clipboard
fun Pagination . reverse (objectsCount: Int ): SimplePagination

Shortcut for reverse

fun Pagination . reverse (datasetSize: Long ): SimplePagination

Example: