Package-level declarations

Types

Pagination
Link copied to clipboard
interface Pagination : ClosedRange<Int>

Base interface of pagination

interface Pagination : ClosedRange<Int>

Base interface of pagination

interface Pagination : ClosedRange<Int>

Base interface of pagination

PaginationResult
Link copied to clipboard
data class PaginationResult<T>(val page: Int, val size: Int, val results: List<T>, val objectsNumber: Long) : Pagination
data class PaginationResult<T>(val page: Int, val size: Int, val results: List<T>, val objectsNumber: Long) : Pagination
data class PaginationResult<T>(val page: Int, val size: Int, val results: List<T>, val objectsNumber: Long) : Pagination
SimplePagination
Link copied to clipboard
data class SimplePagination(val page: Int, val size: Int) : Pagination
data class SimplePagination(val page: Int, val size: Int) : Pagination
data class SimplePagination(val page: Int, val size: Int) : Pagination

Functions

calculatePage
Link copied to clipboard
fun calculatePage(firstIndex: Int, resultsSize: Int): Int
fun calculatePage(firstIndex: Int, resultsSize: Int): Int
fun calculatePage(firstIndex: Int, resultsSize: Int): Int
calculatePagesNumber
Link copied to clipboard
fun calculatePagesNumber(datasetSize: Int, pageSize: Int): Int
fun calculatePagesNumber(datasetSize: Long, pageSize: Int): Int

Calculates pages count for given datasetSize

fun calculatePagesNumber(pageSize: Int, datasetSize: Long): Int

Calculates pages count for given datasetSize. As a fact, it is shortcut for calculatePagesNumber

fun calculatePagesNumber(datasetSize: Int, pageSize: Int): Int
fun calculatePagesNumber(datasetSize: Long, pageSize: Int): Int

Calculates pages count for given datasetSize

fun calculatePagesNumber(pageSize: Int, datasetSize: Long): Int

Calculates pages count for given datasetSize. As a fact, it is shortcut for calculatePagesNumber

fun calculatePagesNumber(datasetSize: Int, pageSize: Int): Int
fun calculatePagesNumber(datasetSize: Long, pageSize: Int): Int

Calculates pages count for given datasetSize

fun calculatePagesNumber(pageSize: Int, datasetSize: Long): Int

Calculates pages count for given datasetSize. As a fact, it is shortcut for calculatePagesNumber

changeResults
Link copied to clipboard
changeResultsUnchecked
Link copied to clipboard
createPaginationResult
Link copied to clipboard
fun <T> List<T>.createPaginationResult(pagination: Pagination, commonObjectsNumber: Long): PaginationResult<T>
fun <T> List<T>.createPaginationResult(firstIndex: Int, commonObjectsNumber: Long): PaginationResult<T>
fun <T> List<T>.createPaginationResult(pagination: Pagination, commonObjectsNumber: Long): PaginationResult<T>
fun <T> List<T>.createPaginationResult(firstIndex: Int, commonObjectsNumber: Long): PaginationResult<T>
fun <T> List<T>.createPaginationResult(pagination: Pagination, commonObjectsNumber: Long): PaginationResult<T>
fun <T> List<T>.createPaginationResult(firstIndex: Int, commonObjectsNumber: Long): PaginationResult<T>
currentPageIfNotEmpty
Link copied to clipboard
doWithPagination
Link copied to clipboard
inline fun doWithPagination(startPagination: Pagination = FirstPagePagination(), requestMaker: (pagination: Pagination) -> Pagination?)
inline fun doWithPagination(startPagination: Pagination = FirstPagePagination(), requestMaker: (pagination: Pagination) -> Pagination?)
inline fun doWithPagination(startPagination: Pagination = FirstPagePagination(), requestMaker: (pagination: Pagination) -> Pagination?)
emptyPaginationResult
Link copied to clipboard
FirstPagePagination
Link copied to clipboard
inline fun FirstPagePagination(size: Int = defaultPaginationPageSize): SimplePagination
inline fun FirstPagePagination(size: Int = defaultPaginationPageSize): SimplePagination
inline fun FirstPagePagination(size: Int = defaultPaginationPageSize): SimplePagination
intersect
Link copied to clipboard
nextPage
Link copied to clipboard
nextPageIfNotEmpty
Link copied to clipboard
Link copied to clipboard
fun <Error class: unknown class>.paginate(with: Pagination, orderBy: Pair<<Error class: unknown class><out <Error class: unknown class>>, <Error class: unknown class>>? = null): <Error class: unknown class>
fun <Error class: unknown class>.paginate(with: Pagination, orderBy: <Error class: unknown class><out <Error class: unknown class>>?, reversed: Boolean = false): <Error class: unknown class>
Pagination
Link copied to clipboard
fun Pagination(page: Int, size: Int): SimplePagination

Factory for SimplePagination

fun Pagination(page: Int, size: Int): SimplePagination

Factory for SimplePagination

fun Pagination(page: Int, size: Int): SimplePagination

Factory for SimplePagination

PaginationByIndexes
Link copied to clipboard
fun PaginationByIndexes(firstIndex: Int, lastIndex: Int): SimplePagination
fun PaginationByIndexes(firstIndex: Int, lastIndex: Int): SimplePagination
fun PaginationByIndexes(firstIndex: Int, lastIndex: Int): SimplePagination
thisPageIfNotEmpty
Link copied to clipboard

Properties

Link copied to clipboard
Link copied to clipboard
const val defaultLargePageSize: Int = 10
const val defaultLargePageSize: Int = 10
const val defaultLargePageSize: Int = 10
Link copied to clipboard
const val defaultMediumPageSize: Int = 5
const val defaultMediumPageSize: Int = 5
const val defaultMediumPageSize: Int = 5
Link copied to clipboard
const val defaultSmallPageSize: Int = 2
const val defaultSmallPageSize: Int = 2
const val defaultSmallPageSize: Int = 2
Link copied to clipboard
val <Error class: unknown class>.extractPagination: Pagination
val <Error class: unknown class>.extractPagination: Pagination
Link copied to clipboard

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

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

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

Link copied to clipboard

Logical shortcut for comparison that page is 0

Logical shortcut for comparison that page is 0

Logical shortcut for comparison that page is 0

Link copied to clipboard

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

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

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

Link copied to clipboard

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

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

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

Link copied to clipboard
Link copied to clipboard