com.jdroid.github.client

Class PageIterator<V>

java.lang.Object

com.jdroid.github.client.PageIterator<V>

Type Parameters:

V - type of resource being iterated over

All Implemented Interfaces:

java.lang.Iterable<java.util.Collection<V>>, java.util.Iterator<java.util.Collection<V>>

public class PageIterator<V>
extends java.lang.Object
implements java.util.Iterator<java.util.Collection<V>>, java.lang.Iterable<java.util.Collection<V>>

Iterator for getting paged responses. Each call to next() will make a client request for the next page of resources using the URI returned from the previous request. The hasNext() method can be used to determine if the last executed request contained the location of the next page of results. This iterator also provides the next and last page numbers as well as the next and last URIs.

Field Summary

Fields

Modifier and Type	Field and Description
protected GitHubClient	client Client
protected java.lang.String	last Last uri to be fetched
protected int	lastPage Last page number
protected java.lang.String	next Next uri to be fetched
protected int	nextPage Current page number
protected PagedRequest<V>	request Request

Constructor Summary

Constructors

Constructor and Description
PageIterator(PagedRequest<V> request, GitHubClient client) Create page iterator

Method Summary

Modifier and Type	Method and Description
int	getLastPage() Get number of last page
java.lang.String	getLastUri() Get uri of last page
int	getNextPage() Get number of next page to be read
java.lang.String	getNextUri() Get URI of next request
PagedRequest<V>	getRequest() Get request being executed
boolean	hasNext()
java.util.Iterator<java.util.Collection<V>>	iterator()
java.util.Collection<V>	next()
protected int	parsePageNumber(java.lang.String uri) Parse page number from uri
void	remove()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

request

protected final PagedRequest<V> request

Request

client

protected final GitHubClient client

Client

nextPage

protected int nextPage

Current page number

lastPage

protected int lastPage

Last page number

next

protected java.lang.String next

Next uri to be fetched

last

protected java.lang.String last

Last uri to be fetched

Constructor Detail

PageIterator

public PageIterator(PagedRequest<V> request,
                    GitHubClient client)

Create page iterator

Parameters:

request -

client -

Method Detail

parsePageNumber

protected int parsePageNumber(java.lang.String uri)

Parse page number from uri

Parameters:

uri -

Returns:

page number

getNextPage

public int getNextPage()

Get number of next page to be read

Returns:

next page

getLastPage

public int getLastPage()

Get number of last page

Returns:

page number

getNextUri

public java.lang.String getNextUri()

Get URI of next request

Returns:

next page uri

getLastUri

public java.lang.String getLastUri()

Get uri of last page

Returns:

last page uri

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<java.util.Collection<V>>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<java.util.Collection<V>>

next

public java.util.Collection<V> next()

Specified by:

next in interface java.util.Iterator<java.util.Collection<V>>

getRequest

public PagedRequest<V> getRequest()

Get request being executed

Returns:

request

iterator

public java.util.Iterator<java.util.Collection<V>> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.util.Collection<V>>

Returns:

this page iterator