Package com.atlassian.jira.util

Class PageRequests

java.lang.Object

com.atlassian.jira.util.PageRequests

@PublicApi
public final class PageRequests
extends Object

Class containing static factory methods used to create PageRequest instances.

Constructor Summary

Constructors

Constructor	Description
PageRequests()

Method Summary

Modifier and Type	Method	Description
static PageRequest	limit(PageRequest pageRequest, int maxSize)	Takes a page request and if its limit is greater than maxSize then returns a new page request with limit equal to maxSize.
static PageRequest	request(Long start, Integer limit)	Creates an instance of PageRequest.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PageRequests

public PageRequests()

Method Details

request

public static PageRequest request(@Nullable
 Long start,
 @Nullable
 Integer limit)

Creates an instance of PageRequest.

Start of the page request can't be lower then 0 and the limit must be a number greater then 0 but lower then PageRequest.MAX_PAGE_LIMIT.

Parameters:

start - values offset, will be set to 0 if null

limit - maximum number of results on a page, will be set to PageRequest.MAX_PAGE_LIMIT if null

Returns:

a page request object

limit

public static PageRequest limit(PageRequest pageRequest,
 int maxSize)

Takes a page request and if its limit is greater than maxSize then returns a new page request with limit equal to maxSize. Otherwise the same page request is returned.

Parameters:

pageRequest - original page request

maxSize - maximum limit in page request

Returns:

page request with limit no greater than maxSize