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>

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) Iterator paged iterator.
List<T>	asList() Eagerly walk Iterable and return the result in a list.
Set<T>	asSet() Eagerly walk Iterable and return the result in a set.
PagedIterator<T>	iterator() Returns an iterator over elements of type T.
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.

Parameters:

size - the size

Returns:

the paged iterable

iterator

@Nonnull
public final PagedIterator<T> iterator()

Returns an iterator over elements of type T.

Specified by:

iterator in interface Iterable<T>

Returns:

an Iterator.

_iterator

@Nonnull
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 walk Iterable and return the result in a list.

Returns:

the list

asSet

public Set<T> asSet()

Eagerly walk Iterable and return the result in a set.

Returns:

the set