@PublicApi public final class

PageRequests

extends Object
java.lang.Object
   ↳ com.atlassian.jira.util.PageRequests

@PublicApi

This class is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Class containing static factory methods used to create PageRequest instances.

Summary

Public Constructors
PageRequests()
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PageRequests ()

Public Methods

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

public static PageRequest request (Long start, 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 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 MAX_PAGE_LIMIT if null
Returns
  • a page request object