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. This class should be used only for paginating content on the frontend or handling paginated requests. For searching objects in the index, use PageRequest

  • 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 than 0 and the limit must be a number greater than 0 but lower than 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