@PublicApi public interface

PageRequest

com.atlassian.jira.util.PageRequest

@PublicApi

This interface 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

Pagination request.

Summary

Constants
int MAX_PAGE_LIMIT The maximum size of any page limit.
Public Methods
int getLimit()
long getStart()

Constants

public static final int MAX_PAGE_LIMIT

The maximum size of any page limit.

Constant Value: 1048576 (0x00100000)

Public Methods

public int getLimit ()

Returns
  • the maximum allowed number of elements on the page

public long getStart ()

Returns
  • the index of the element in the result set that this page will start at