org.starchartlabs.calamari.core.paging

Class PagingLinks

java.lang.Object

org.starchartlabs.calamari.core.paging.PagingLinks

public class PagingLinks
extends java.lang.Object

Handles parsing of GitHub paging headers into distinct links for traversal of paged data

GitHub does not provide all headers on all returns. The first page only contains the "next" and "last" links. The last page only contains the "first" and "prev" links. All other pages contain all four headers. If there is only one page of data, none of the links are returned

Based on GitHub pagination documentation

Since:

0.3.0

Constructor Summary

Constructors

Constructor and Description
PagingLinks(java.util.Collection<java.lang.String> links) Parses one or more paging links from GitHub response headers

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.Optional<java.lang.String>	getFirstPageUrl()
java.util.Optional<java.lang.String>	getLastPageUrl()
java.util.Optional<java.lang.String>	getNextPageUrl()
static java.util.Optional<java.lang.Integer>	getPage(java.lang.String url) Reads the page index from a link.
static java.util.Optional<java.lang.Integer>	getPerPage(java.lang.String url) Reads the number of elements request per-page from a link
java.util.Optional<java.lang.String>	getPreviousPageUrl()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PagingLinks

public PagingLinks(java.util.Collection<java.lang.String> links)

Parses one or more paging links from GitHub response headers

Parameters:

links - One or more "Link" header values. Supports separated headers and headers contains a CSV of multiple link entries

Since:

0.3.0

Method Detail

getFirstPageUrl

public java.util.Optional<java.lang.String> getFirstPageUrl()

Returns:

URL to the first set of data in a paged sequence. Only present if the response providing the links was not the first page

Since:

0.3.0

getPreviousPageUrl

public java.util.Optional<java.lang.String> getPreviousPageUrl()

Returns:

URL to the previous set of data in a paged sequence. Only present if the response providing the links was not the first page

Since:

0.3.0

getNextPageUrl

public java.util.Optional<java.lang.String> getNextPageUrl()

Returns:

URL to the next set of data in a paged sequence. Only present if the response providing the links was not the last page

Since:

0.3.0

getLastPageUrl

public java.util.Optional<java.lang.String> getLastPageUrl()

Returns:

URL to the last set of data in a paged sequence. Only present if the response providing the links was not the last page

Since:

0.3.0

getPage

public static java.util.Optional<java.lang.Integer> getPage(java.lang.String url)

Reads the page index from a link. Page's are 1-indexed

Parameters:

url - The link URL to read page information from

Returns:

The page index, or empty if no valid per-page specification was found

Since:

0.3.0

getPerPage

public static java.util.Optional<java.lang.Integer> getPerPage(java.lang.String url)

Reads the number of elements request per-page from a link

Parameters:

url - The link URL to read per-page information from

Returns:

The number of elements per page, or empty if no valid per-page specification was found

Since:

0.3.0

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(@Nullable
                      java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object