Class 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 Detail

      • withPageSize

        public PagedSearchIterable<T> withPageSize​(int size)
        Description copied from class: PagedIterable
        Sets the pagination size.

        When set to non-zero, each API call will retrieve this many entries.

        Overrides:
        withPageSize in class PagedIterable<T>
        Parameters:
        size - the size
        Returns:
        the paged 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
      • adapt

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