micro_utils.dokka/dev.inmo.micro_utils.pagination/PaginationResult

PaginationResult

@Serializable

data class PaginationResult<T>(val page: Int, val size: Int, val results: List<T>, val objectsNumber: Long) : Pagination(source)

Parameters

page

Current page number

size

Current page size. It can be greater than size of results

results

Result objects

objectsNumber

Count of all objects across all pages

Constructors

PaginationResult

constructor(page: Int, size: Int, results: List<T>, objectsNumber: Long)

constructor(page: Int, results: List<T>, pagesNumber: Int, size: Int = results.size)

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

isLastPage

val PaginationResult<*>.isLastPage: Boolean

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:

lastPage

val PaginationResult<*>.lastPage: Int

lastPageLong

val PaginationResult<*>.lastPageLong: Long

objectsNumber

val objectsNumber: Long

page

open override val page: Int

pagesNumber

@Transient

val pagesNumber: Int

Amount of pages for current pagination

pagesNumberLong

@EncodeDefault

@SerialName(value = "pagesNumber")

val pagesNumberLong: Long

Amount of pages for current pagination

results

val results: List<T>

size

open override val size: Int

start

open override val start: Int

Functions

changeResults

inline fun <I, O> PaginationResult.changeResults(block: PaginationResult.() -> List<O>): PaginationResult<O>

fun <I, O> PaginationResult.changeResults(data: List<O>): PaginationResult<O>

changeResultsUnchecked

inline fun <I, O> PaginationResult.changeResultsUnchecked(block: PaginationResult.() -> List<O>): PaginationResult<O>

fun <I, O> PaginationResult.changeResultsUnchecked(data: List<O>): PaginationResult<O>

contains

open operator fun contains(value: Int): Boolean

currentPageIfNotEmpty

fun <T> PaginationResult<T>.currentPageIfNotEmpty(): PaginationResult<T>?

currentPageIfNotEmptyOrLastPage

fun <T> PaginationResult<T>.currentPageIfNotEmptyOrLastPage(): PaginationResult<T>?

currentPageIfNotLastPage

fun <T> PaginationResult<T>.currentPageIfNotLastPage(): PaginationResult<T>?

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

nextPageIfNotEmpty

fun PaginationResult<*>.nextPageIfNotEmpty(): SimplePagination?

nextPageIfNotEmptyOrLastPage

fun PaginationResult<*>.nextPageIfNotEmptyOrLastPage(): SimplePagination?

nextPageIfNotLastPage

fun PaginationResult<*>.nextPageIfNotLastPage(): 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:

thisPageIfNotEmpty

fun <T> PaginationResult<T>.thisPageIfNotEmpty(): PaginationResult<T>?

thisPageIfNotEmptyOrLastPage

fun <T> PaginationResult<T>.thisPageIfNotEmptyOrLastPage(): PaginationResult<T>?

thisPageIfNotLastPage

fun <T> PaginationResult<T>.thisPageIfNotLastPage(): PaginationResult<T>?