PagedSearchIterable (GitHub API for Java 1.101 API)

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 abstract class PagedSearchIterable<T>
extends PagedIterable<T>
```
PagedIterable enhanced to report search result specific information.

Author:

Kohsuke Kawaguchi

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected Iterator<T[]>`	`adapt(Iterator<? extends org.kohsuke.github.SearchResult<T>> base)`	Adapts `Iterator`.
`int`	`getTotalCount()`	Returns the total number of hit, including the results that's not yet fetched.
`boolean`	`isIncomplete()`	Is incomplete boolean.
`PagedSearchIterable<T>`	`withPageSize(int size)`	Sets the pagination size.

Methods inherited from class org.kohsuke.github.PagedIterable
_iterator, asList, asSet, iterator

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- 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