org.kohsuke.github

Class PagedIterable<T>

java.lang.Object

org.kohsuke.github.PagedIterable<T>

All Implemented Interfaces:

java.lang.Iterable<T>

Direct Known Subclasses:

PagedSearchIterable

public abstract class PagedIterable<T>
extends java.lang.Object
implements java.lang.Iterable<T>

Iterable that returns PagedIterator

Author:

Kohsuke Kawaguchi

Constructor Summary

Constructors

Constructor and Description
PagedIterable()

Method Summary

Modifier and Type	Method and Description
abstract PagedIterator<T>	_iterator(int pageSize)
java.util.List<T>	asList() Eagerly walk Iterable and return the result in a list.
java.util.Set<T>	asSet() Eagerly walk Iterable and 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

Constructor Detail

PagedIterable

public PagedIterable()

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.

iterator

public final PagedIterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T>

_iterator

public abstract PagedIterator<T> _iterator(int pageSize)

asList

public java.util.List<T> asList()

Eagerly walk Iterable and return the result in a list.

asSet

public java.util.Set<T> asSet()

Eagerly walk Iterable and return the result in a set.