micro_utils.dokka/dev.inmo.micro_utils.pagination/Pagination

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

val Pagination.asUrlQueryArrayParts: Array<Pair<String, String>>

asUrlQueryParts

val Pagination.asUrlQueryParts: Map<String, String>

endInclusive

open override val endInclusive: Int

firstIndex

val Pagination.firstIndex: Int

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

isFirstPage

val Pagination.isFirstPage: Boolean

Logical shortcut for comparison that page is 0

lastIndex

val Pagination.lastIndex: Int

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

lastIndexExclusive

val Pagination.lastIndexExclusive: Int

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

page

abstract val page: Int

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

size

abstract val size: Int

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

start

open override val start: Int

Functions

contains

open operator fun contains(value: Int): Boolean

firstPage

fun Pagination.firstPage(): Pagination

intersect

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

open fun isEmpty(): Boolean

limitClause

fun Pagination.limitClause(): String

inline fun Pagination.nextPage(): SimplePagination

optionallyReverse

fun Pagination.optionallyReverse(objectsCount: Int, reverse: Boolean): Pagination

fun Pagination.optionallyReverse(objectsCount: Long, reverse: Boolean): Pagination

inline fun Pagination.previousPage(): SimplePagination

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

reverse

fun Pagination.reverse(objectsCount: Int): SimplePagination

Shortcut for reverse

fun Pagination.reverse(datasetSize: Long): SimplePagination

Example: