Package org.kohsuke.github
Class PagedIterable<T>
- java.lang.Object
-
- org.kohsuke.github.PagedIterable<T>
-
- Type Parameters:
T- the type parameter
- All Implemented Interfaces:
Iterable<T>
- Direct Known Subclasses:
PagedSearchIterable
public abstract class PagedIterable<T> extends Object implements Iterable<T>
Iterablethat returnsPagedIterator- Author:
- Kohsuke Kawaguchi
-
-
Constructor Summary
Constructors Constructor Description PagedIterable()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract PagedIterator<T>_iterator(int pageSize)Iterator paged iterator.List<T>asList()Eagerly walkIterableand return the result in a list.Set<T>asSet()Eagerly walkIterableand return the result in a set.PagedIterator<T>iterator()PagedIterable<T>withPageSize(int size)Sets the pagination size.-
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 PagedIterable<T> withPageSize(int size)
Sets the pagination size.When set to non-zero, each API call will retrieve this many entries.
- Parameters:
size- the size- Returns:
- the paged iterable
-
iterator
public final PagedIterator<T> iterator()
-
_iterator
public abstract PagedIterator<T> _iterator(int pageSize)
Iterator paged iterator.- Parameters:
pageSize- the page size- Returns:
- the paged iterator
-
asList
public List<T> asList()
Eagerly walkIterableand return the result in a list.- Returns:
- the list
-
-