Class PagedSearchIterable<T>

java.lang.Object
org.kohsuke.github.PagedIterable<T>
org.kohsuke.github.PagedSearchIterable<T>
Type Parameters:
T - the type parameter
All Implemented Interfaces:
Iterable<T>

public class PagedSearchIterable<T> extends PagedIterable<T>
PagedIterable enhanced to report search result specific information.
Author:
Kohsuke Kawaguchi
  • Method Details

    • withPageSize

      public PagedSearchIterable<T> withPageSize(int size)
      With page size.
      Overrides:
      withPageSize in class PagedIterable<T>
      Parameters:
      size - the size
      Returns:
      the paged search iterable
    • getTotalCount

      public int getTotalCount()
      Returns the total number of hit, including the results that's not yet fetched.
      Returns:
      the total count
    • isIncomplete

      public boolean isIncomplete()
      Is incomplete boolean.
      Returns:
      the boolean
    • _iterator

      @Nonnull public PagedIterator<T> _iterator(int pageSize)
      Iterator.
      Specified by:
      _iterator in class PagedIterable<T>
      Parameters:
      pageSize - the page size
      Returns:
      the paged iterator
    • adapt

      protected Iterator<T[]> adapt(Iterator<? extends org.kohsuke.github.SearchResult<T>> base)
      Adapts Iterator.
      Parameters:
      base - the base
      Returns:
      the iterator