com.scvngr.levelup.core.net.request.factory

Class LocationListRequestFactory

java.lang.Object

com.scvngr.levelup.core.net.request.factory.AbstractRequestFactory

com.scvngr.levelup.core.net.request.factory.AbstractPagingRequestFactory

com.scvngr.levelup.core.net.request.factory.LocationListRequestFactory

@Immutable
 @LevelUpApi(contract=INTERNAL)
public final class LocationListRequestFactory
extends AbstractPagingRequestFactory

A summarized list of all LevelUp locations. This list is paged using the Link header. See LinkHeaderParser.

Nested Class Summary

Nested classes/interfaces inherited from class com.scvngr.levelup.core.net.request.factory.AbstractPagingRequestFactory

AbstractPagingRequestFactory.PageCacheRetriever

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_LOCATIONS The API endpoint for locations.

Constructor Summary

Constructors

Constructor and Description
LocationListRequestFactory(Context context, AccessTokenRetriever retriever, AbstractPagingRequestFactory.PageCacheRetriever pageCacheRetriever) Constructor.

Method Summary

Modifier and Type	Method and Description
AbstractRequest	getFirstPageRequest() Subclasses must implement this to construct a new request for the first page.
AbstractRequest	getPageRequest(Uri page) Subclasses must implement this to construct a new request for the given next page.

Methods inherited from class com.scvngr.levelup.core.net.request.factory.AbstractPagingRequestFactory

getNextPageRequest, getPageCacheRetriever, setNextPage

Methods inherited from class com.scvngr.levelup.core.net.request.factory.AbstractRequestFactory

getAccessTokenRetriever, getContext

Methods inherited from class java.lang.Object

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

Field Detail

ENDPOINT_LOCATIONS

public static final String ENDPOINT_LOCATIONS

The API endpoint for locations.

See Also:

Constant Field Values

Constructor Detail

LocationListRequestFactory

public LocationListRequestFactory(Context context,
                                  AccessTokenRetriever retriever,
                                  AbstractPagingRequestFactory.PageCacheRetriever pageCacheRetriever)

Constructor.

Parameters:

context - the context.

retriever - the access token retriever.

pageCacheRetriever - the retriever to use to get the last retrieved page from the cache.

Method Detail

getPageRequest

public AbstractRequest getPageRequest(Uri page)

Description copied from class: AbstractPagingRequestFactory

Subclasses must implement this to construct a new request for the given next page.

Specified by:

getPageRequest in class AbstractPagingRequestFactory

Parameters:

page - the URL of the next page that should be loaded.

Returns:

a request for the next page or null if there is an error.

getFirstPageRequest

public AbstractRequest getFirstPageRequest()

Description copied from class: AbstractPagingRequestFactory

Subclasses must implement this to construct a new request for the first page. This is usually just a request to the endpoint.

Specified by:

getFirstPageRequest in class AbstractPagingRequestFactory

Returns:

a request for the first page.