Package com.atlassian.bitbucket.util

Class AbstractPagedSummary

java.lang.Object
com.atlassian.bitbucket.util.AbstractSummary
com.atlassian.bitbucket.util.AbstractPagedSummary
Direct Known Subclasses:
ContentTreeSummary, FileSummary
public abstract class AbstractPagedSummary extends AbstractSummary
Extends AbstractSummary and adds additional properties for summarizing a page of output.

  • Constructor Details

  • Method Details

    • getNextPageRequest

      @Nullable public PageRequest getNextPageRequest()
      If this is not the last page, retrieves the PageRequest which can be used to request the next page. If this is the last page, returns null.
      Returns:
      a PageRequest to request the next page, or null if this is the last page

    • getPageRequest

      @Nonnull public PageRequest getPageRequest()
      Retrieves the PageRequest that was used to retrieve this page of results.
      Returns:
      the PageRequest for the current page

    • getSize

      public int getSize()
      Retrieves the number of results that were retrieved. This value will always be less than or equal to the limit of the current page request.
      Returns:
      the size of the current page

    • isLastPage

      public boolean isLastPage()
      Retrieves a flag indicating whether this page is the last page of results.
      Returns:
      true if this is the final page of results; otherwise, false if there is a next page