org.gedcomx.rs.client.util

Class PagedFeedIterator

java.lang.Object

org.gedcomx.rs.client.util.PagedFeedIterator

All Implemented Interfaces:

Iterator<Feed>

public class PagedFeedIterator
extends Object
implements Iterator<Feed>

A paged feed iterator. The HTTP GET requests can be customized by using a custom PagedFeedIterator.WebResourceProvider and/or adding PagedFeedIterator.WebResourceBuilderExtensions.

See Also:

Paged Feeds

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PagedFeedIterator.WebResourceBuilderExtension Interface for extending HTTP GET requests (e.g.
static interface	PagedFeedIterator.WebResourceProvider Interface for providing WebResources to use for fetching paged feed documents.

Field Summary

Fields

Modifier and Type	Field and Description
static PagedFeedIterator.WebResourceProvider	DEFAULT_WEB_RESOURCE_PROVIDER The default PagedFeedIterator.WebResourceProvider which simply calls Client.resource(String).

Method Summary

Modifier and Type	Method and Description
void	addWebResourceBuilderExtension(PagedFeedIterator.WebResourceBuilderExtension extension) Adds a PagedFeedIterator.WebResourceBuilderExtension in order to add cookies, header values, etc.
void	clearWebResourceBuilderExtensions()
Feed	first()
org.gedcomx.common.URI	firstHRef()
static PagedFeedIterator	fromFeed(Feed feed) Creates a new paged feed iterator using the specified Feed.
static PagedFeedIterator	fromUri(org.gedcomx.common.URI uri) Creates a new paged feed iterator using the specified URI.
com.sun.jersey.api.client.Client	getClient() Gets the Client being used to get paged feed documents.
static org.gedcomx.common.URI	getLinkRelHref(Feed feed, String rel) Gets the hypertext reference from the specified Feed for the specified rel link.
List<PagedFeedIterator.WebResourceBuilderExtension>	getWebResourceBuilderExtensions()
PagedFeedIterator.WebResourceProvider	getWebResourceProvider() Gets the PagedFeedIterator.WebResourceProvider.
boolean	hasFirst()
boolean	hasLast()
boolean	hasNext()
boolean	hasPrevious()
Feed	last()
org.gedcomx.common.URI	lastHRef()
Feed	next()
org.gedcomx.common.URI	nextHRef()
Feed	previous()
org.gedcomx.common.URI	previousHRef()
void	remove()
void	removeWebResourceBuilderExtension(PagedFeedIterator.WebResourceBuilderExtension extension) Removes a PagedFeedIterator.WebResourceBuilderExtension.
void	setClient(com.sun.jersey.api.client.Client client) Sets the Client to use to get paged feed documents.
void	setWebResourceProvider(PagedFeedIterator.WebResourceProvider webResourceProvider) Sets the PagedFeedIterator.WebResourceProvider.
PagedFeedIterator	withClient(com.sun.jersey.api.client.Client client) Sets the Client to use to get paged feed documents.
PagedFeedIterator	withWebResourceBuilderExtension(PagedFeedIterator.WebResourceBuilderExtension extension) Adds a PagedFeedIterator.WebResourceBuilderExtension in order to add cookies, header values, etc.
PagedFeedIterator	withWebResourceProvider(PagedFeedIterator.WebResourceProvider webResourceProvider) Sets the PagedFeedIterator.WebResourceProvider.

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

Field Detail

DEFAULT_WEB_RESOURCE_PROVIDER

public static PagedFeedIterator.WebResourceProvider DEFAULT_WEB_RESOURCE_PROVIDER

The default PagedFeedIterator.WebResourceProvider which simply calls Client.resource(String).

Method Detail

fromUri

public static PagedFeedIterator fromUri(org.gedcomx.common.URI uri)

Creates a new paged feed iterator using the specified URI.

Parameters:

uri - the URI to use to get the initial (next) paged feed document and from which future values of first, last, previous, and next hypertext references will be acquired.

Returns:

a new PagedFeedIterator

fromFeed

public static PagedFeedIterator fromFeed(Feed feed)

Creates a new paged feed iterator using the specified Feed.

Parameters:

feed - the feed document from which the initial first, last, previous, and next hypertext references will be acquired.

Returns:

a new PagedFeedIterator

getLinkRelHref

public static org.gedcomx.common.URI getLinkRelHref(Feed feed,
                                                    String rel)

Gets the hypertext reference from the specified Feed for the specified rel link.

Parameters:

feed - the source feed document

rel - the desired rel

Returns:

the hypertext reference, if it exists; otherwise null

getWebResourceBuilderExtensions

public List<PagedFeedIterator.WebResourceBuilderExtension> getWebResourceBuilderExtensions()

addWebResourceBuilderExtension

public void addWebResourceBuilderExtension(PagedFeedIterator.WebResourceBuilderExtension extension)

Adds a PagedFeedIterator.WebResourceBuilderExtension in order to add cookies, header values, etc. to the paged feed document GET request.

Parameters:

extension - the extension to add

removeWebResourceBuilderExtension

public void removeWebResourceBuilderExtension(PagedFeedIterator.WebResourceBuilderExtension extension)

Removes a PagedFeedIterator.WebResourceBuilderExtension.

Parameters:

extension - the extension to remove

clearWebResourceBuilderExtensions

public void clearWebResourceBuilderExtensions()

withWebResourceBuilderExtension

public PagedFeedIterator withWebResourceBuilderExtension(PagedFeedIterator.WebResourceBuilderExtension extension)

Adds a PagedFeedIterator.WebResourceBuilderExtension in order to add cookies, header values, etc. to the paged feed document GET request.

Parameters:

extension - the extension

Returns:

a reference to this PagedFeedIterator for fluent configuration chaining

getClient

public com.sun.jersey.api.client.Client getClient()

Gets the Client being used to get paged feed documents.

Returns:

the Client being used to get paged feed documents.

setClient

public void setClient(com.sun.jersey.api.client.Client client)

Sets the Client to use to get paged feed documents.

Parameters:

client - the Client to use to get paged feed documents.

withClient

public PagedFeedIterator withClient(com.sun.jersey.api.client.Client client)

Sets the Client to use to get paged feed documents.

Parameters:

client - the Client to use to get paged feed documents.

Returns:

a reference to this PagedFeedIterator for fluent configuration chaining

getWebResourceProvider

public PagedFeedIterator.WebResourceProvider getWebResourceProvider()

Gets the PagedFeedIterator.WebResourceProvider.

Returns:

the PagedFeedIterator.WebResourceProvider.

See Also:

DEFAULT_WEB_RESOURCE_PROVIDER

setWebResourceProvider

public void setWebResourceProvider(PagedFeedIterator.WebResourceProvider webResourceProvider)

Sets the PagedFeedIterator.WebResourceProvider.

Parameters:

webResourceProvider - the desired PagedFeedIterator.WebResourceProvider.

See Also:

DEFAULT_WEB_RESOURCE_PROVIDER

withWebResourceProvider

public PagedFeedIterator withWebResourceProvider(PagedFeedIterator.WebResourceProvider webResourceProvider)

Sets the PagedFeedIterator.WebResourceProvider.

Parameters:

webResourceProvider - the desired PagedFeedIterator.WebResourceProvider.

Returns:

a reference to this PagedFeedIterator for fluent configuration chaining

See Also:

DEFAULT_WEB_RESOURCE_PROVIDER

hasFirst

public boolean hasFirst()

firstHRef

public org.gedcomx.common.URI firstHRef()

first

public Feed first()

lastHRef

public org.gedcomx.common.URI lastHRef()

hasLast

public boolean hasLast()

last

public Feed last()

previousHRef

public org.gedcomx.common.URI previousHRef()

hasPrevious

public boolean hasPrevious()

previous

public Feed previous()

nextHRef

public org.gedcomx.common.URI nextHRef()

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Feed>

next

public Feed next()

Specified by:

next in interface Iterator<Feed>

remove

public void remove()

Specified by:

remove in interface Iterator<Feed>