Module org.kohsuke.github.api

Package org.kohsuke.github

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 Summary

Modifier and Type	Method	Description
PagedIterator<T>	_iterator(int pageSize)	Iterator.
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)	With page size.

Methods inherited from class org.kohsuke.github.PagedIterable

iterator, toArray, toArray, toList, toSet

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