Module gg.xp.xivapi

Package gg.xp.xivapi.pagination

Class XivApiPaginator<X extends XivApiObject>

java.lang.Object

gg.xp.xivapi.pagination.XivApiPaginator<X>

Type Parameters:

X -

All Implemented Interfaces:

Iterator<X>

Direct Known Subclasses:

XivApiListPaginator, XivApiSearchPaginator

public abstract sealed class XivApiPaginator<X extends XivApiObject>
extends Object
implements Iterator<X>
permits XivApiListPaginator<X>, XivApiSearchPaginator<X>

Base list/search paginator implementation. Not thread safe. Does not do any prefetching.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	XivApiPaginator.XivApiPage

Field Summary

Fields

Modifier and Type	Field	Description
protected XivApiPaginator<X>.XivApiPage	currentPage
protected final URI	originalUri
protected final int	perPageItemCount

Method Summary

Modifier and Type	Method	Description
protected abstract URI	getNextPageUri()
protected abstract com.fasterxml.jackson.databind.JsonNode	getResultsNode(com.fasterxml.jackson.databind.JsonNode rootNode)
protected boolean	hasMorePages()
boolean	hasNext()
X	next()
Stream<X>	stream()
Iterator<X>	toBufferedIterator(int bufferSize)
Stream<X>	toBufferedStream(int bufferSize)
List<X>	toList()

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

Field Details

originalUri

protected final URI originalUri

perPageItemCount

protected final int perPageItemCount

currentPage

protected XivApiPaginator<X extends XivApiObject>.XivApiPage currentPage

Method Details

getNextPageUri

protected abstract URI getNextPageUri()

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<X extends XivApiObject>

hasMorePages

protected boolean hasMorePages()

next

public X next()

Specified by:

next in interface Iterator<X extends XivApiObject>

getResultsNode

protected abstract com.fasterxml.jackson.databind.JsonNode getResultsNode(com.fasterxml.jackson.databind.JsonNode rootNode)

toList

public List<X> toList()

stream

public Stream<X> stream()

toBufferedIterator

public Iterator<X> toBufferedIterator(int bufferSize)

toBufferedStream

public Stream<X> toBufferedStream(int bufferSize)