org.starchartlabs.calamari.core.paging

Class GitHubPageIterator<T>

java.lang.Object

org.starchartlabs.calamari.core.paging.GitHubPageIterator<T>

Type Parameters:

T - Type representing an individual paged element

All Implemented Interfaces:

java.util.Iterator<java.util.Collection<T>>, org.starchartlabs.alloy.core.collections.PageIterator<T>

public class GitHubPageIterator<T>
extends java.lang.Object
implements org.starchartlabs.alloy.core.collections.PageIterator<T>

An implementation of PageIterator for traversing paged data read from GitHub APIs

Allows mapping of read elements at the Iterator level to prevent overhead in later steps

Uses paging links to estimate remaining size

See MoreSpliterators.ofPaged(PageIterator) for a path to consuming paged data as a Java Stream via spliterator

Since:

0.3.0

See Also:

MoreSpliterators.ofPaged(PageIterator)

Constructor Summary

Constructors

Constructor and Description
GitHubPageIterator(java.lang.String url, java.util.function.Supplier<java.lang.String> authorizationHeader, java.lang.String userAgent, java.util.function.Function<java.lang.String,java.util.Collection<T>> jsonDeserializer) Creates a new GitHubPageIterator
GitHubPageIterator(java.lang.String url, java.util.function.Supplier<java.lang.String> authorizationHeader, java.lang.String userAgent, java.util.function.Function<java.lang.String,java.util.Collection<T>> jsonDeserializer, java.lang.String mediaType) Creates a new GitHubPageIterator

Method Summary

Modifier and Type	Method and Description
long	estimateSize()
static GitHubPageIterator<com.google.gson.JsonElement>	gson(java.lang.String url, java.util.function.Supplier<java.lang.String> authorizationHeader, java.lang.String userAgent) Creates a new GitHubPageIterator configured to extract paged elements into Gson JsonElement instances
static GitHubPageIterator<com.google.gson.JsonElement>	gson(java.lang.String url, java.util.function.Supplier<java.lang.String> authorizationHeader, java.lang.String userAgent, java.lang.String mediaType) Creates a new GitHubPageIterator configured to extract paged elements into Gson JsonElement instances
boolean	hasNext()
<S> GitHubPageIterator<S>	map(java.util.function.Function<T,S> mapperPerElement) Transforms each element of paged data encountered via the provided function
java.util.Collection<T>	next()
org.starchartlabs.alloy.core.collections.PageIterator<T>	trySplit()

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

Constructor Detail

GitHubPageIterator

public GitHubPageIterator(java.lang.String url,
                          java.util.function.Supplier<java.lang.String> authorizationHeader,
                          java.lang.String userAgent,
                          java.util.function.Function<java.lang.String,java.util.Collection<T>> jsonDeserializer)

Creates a new GitHubPageIterator

Parameters:

url - The initial URL to request paged data from

authorizationHeader - Supplier which provides contents for the Authorization header when making requests

userAgent - The user agent to make web requests as, as required by GitHub

jsonDeserializer - Function which transforms a raw JSON response representing a full page into individual data elements

Since:

0.3.0

GitHubPageIterator

public GitHubPageIterator(java.lang.String url,
                          java.util.function.Supplier<java.lang.String> authorizationHeader,
                          java.lang.String userAgent,
                          java.util.function.Function<java.lang.String,java.util.Collection<T>> jsonDeserializer,
                          java.lang.String mediaType)

Creates a new GitHubPageIterator

Parameters:

url - The initial URL to request paged data from

authorizationHeader - Supplier which provides contents for the Authorization header when making requests

userAgent - The user agent to make web requests as, as required by GitHub

jsonDeserializer - Function which transforms a raw JSON response representing a full page into individual data elements

mediaType - The media type to request from the server via Accept header

Since:

0.3.0

Method Detail

map

public <S> GitHubPageIterator<S> map(java.util.function.Function<T,S> mapperPerElement)

Transforms each element of paged data encountered via the provided function

Type Parameters:

S - New type representing an individual paged element

Parameters:

mapperPerElement - Function to apply to each element representation, for transforming from the current element representation to a new one

Returns:

A GitHubPageInterator which will provide elements as the desired representation

Since:

0.3.0

hasNext

public boolean hasNext()

Specified by:

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

next

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

Specified by:

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

trySplit

public org.starchartlabs.alloy.core.collections.PageIterator<T> trySplit()

Specified by:

trySplit in interface org.starchartlabs.alloy.core.collections.PageIterator<T>

estimateSize

public long estimateSize()

Specified by:

estimateSize in interface org.starchartlabs.alloy.core.collections.PageIterator<T>

gson

public static GitHubPageIterator<com.google.gson.JsonElement> gson(java.lang.String url,
                                                                   java.util.function.Supplier<java.lang.String> authorizationHeader,
                                                                   java.lang.String userAgent)

Creates a new GitHubPageIterator configured to extract paged elements into Gson JsonElement instances

Parameters:

url - The initial URL to request paged data from

authorizationHeader - Supplier which provides contents for the Authorization header when making requests

userAgent - The user agent to make web requests as, as required by GitHub

Returns:

A GitHubPageIterator which allows iteration over elements as JsonElement instances

Since:

0.3.0

gson

public static GitHubPageIterator<com.google.gson.JsonElement> gson(java.lang.String url,
                                                                   java.util.function.Supplier<java.lang.String> authorizationHeader,
                                                                   java.lang.String userAgent,
                                                                   java.lang.String mediaType)

Creates a new GitHubPageIterator configured to extract paged elements into Gson JsonElement instances

Parameters:

url - The initial URL to request paged data from

authorizationHeader - Supplier which provides contents for the Authorization header when making requests

userAgent - The user agent to make web requests as, as required by GitHub

mediaType - The media type to request from the server via Accept header

Returns:

A GitHubPageIterator which allows iteration over elements as JsonElement instances

Since:

0.3.0