A B C D E F G H I J L O R S T U V

A

APPLICATION_ID - Static variable in class uk.org.rivernile.android.fetchutils.BuildConfig

AssetFileFetcher - Class in uk.org.rivernile.android.fetchutils.fetchers

An AssetFileFetcher fetches data from a given file path in the application assets.

AssetFileFetcher(Context, String) - Constructor for class uk.org.rivernile.android.fetchutils.fetchers.AssetFileFetcher

Create a new AssetFileFetcher.

B

BitmapFetcherStreamReader - Class in uk.org.rivernile.android.fetchutils.fetchers.readers

A BitmapFetcherStreamReader takes an InputStream and produces a Bitmap, should the data be formatted appropriately.

BitmapFetcherStreamReader() - Constructor for class uk.org.rivernile.android.fetchutils.fetchers.readers.BitmapFetcherStreamReader

build() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher.Builder

Create a new instance of HttpFetcher based on the snapshot of data in this Builder at the instance this method is called.

BUILD_TYPE - Static variable in class uk.org.rivernile.android.fetchutils.BuildConfig

BuildConfig - Class in uk.org.rivernile.android.fetchutils

BuildConfig() - Constructor for class uk.org.rivernile.android.fetchutils.BuildConfig

C

ConnectivityUnavailableException - Exception in uk.org.rivernile.android.fetchutils.fetchers

This Exception is thrown when it has been determined that there is no connectivity to a network which enables a Fetcher to complete its request.

ConnectivityUnavailableException() - Constructor for exception uk.org.rivernile.android.fetchutils.fetchers.ConnectivityUnavailableException

Constructs a new ConnectivityUnavailableException with the default message filled in.

ConnectivityUnavailableException(String) - Constructor for exception uk.org.rivernile.android.fetchutils.fetchers.ConnectivityUnavailableException

Constructs a new ConnectivityUnavailableException, specifying the message.

D

DEBUG - Static variable in class uk.org.rivernile.android.fetchutils.BuildConfig

deliverResult(D) - Method in class uk.org.rivernile.android.fetchutils.loaders.SimpleAsyncTaskLoader

deliverResult(D) - Method in class uk.org.rivernile.android.fetchutils.loaders.support.SimpleAsyncTaskLoader

doesAppend() - Method in class uk.org.rivernile.android.fetchutils.fetchers.readers.FileWriterFetcherStreamReader

Does output to the file append or overwrite?

E

executeFetcher(FetcherStreamReader) - Method in class uk.org.rivernile.android.fetchutils.fetchers.AssetFileFetcher

executeFetcher(FetcherStreamReader) - Method in interface uk.org.rivernile.android.fetchutils.fetchers.Fetcher

Start this Fetcher.

executeFetcher(FetcherStreamReader) - Method in class uk.org.rivernile.android.fetchutils.fetchers.FileFetcher

executeFetcher(FetcherStreamReader) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

F

Fetcher - Interface in uk.org.rivernile.android.fetchutils.fetchers

A Fetcher is a component which collects data from a source, such as a remote server or a local file.

FetcherFactory - Class in uk.org.rivernile.android.fetchutils.fetchers

This class contains a static method that allows an appropriate Fetcher to be created depending on the supplied Uri.

FetcherStreamReader - Interface in uk.org.rivernile.android.fetchutils.fetchers

A FetcherSteamReader is an interface that should be implemented by classes capturing a stream of data from a Fetcher.

FileFetcher - Class in uk.org.rivernile.android.fetchutils.fetchers

A FileFetcher fetches data from a given File or path.

FileFetcher(String) - Constructor for class uk.org.rivernile.android.fetchutils.fetchers.FileFetcher

Create a new instance of FileFetcher, specifying the path of the file.

FileFetcher(File) - Constructor for class uk.org.rivernile.android.fetchutils.fetchers.FileFetcher

Create a new instance of FileFetcher, specifying the File to read from.

FileWriterFetcherStreamReader - Class in uk.org.rivernile.android.fetchutils.fetchers.readers

A FileWriterFetcherStreamReader will take an InputStream and pipe the data out to the given file.

FileWriterFetcherStreamReader(File, boolean) - Constructor for class uk.org.rivernile.android.fetchutils.fetchers.readers.FileWriterFetcherStreamReader

Create a new FileWriterFetcherStreamReader.

FileWriterFetcherStreamReader(String, boolean) - Constructor for class uk.org.rivernile.android.fetchutils.fetchers.readers.FileWriterFetcherStreamReader

Create a new FileWriterFetcherStreamReader.

FLAVOR - Static variable in class uk.org.rivernile.android.fetchutils.BuildConfig

G

getBitmap() - Method in class uk.org.rivernile.android.fetchutils.fetchers.readers.BitmapFetcherStreamReader

Get the Bitmap that was returned from the stream.

getConnectTimeout() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

Get the connection timeout configured for this instance.

getContentEncoding() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

See URLConnection.getContentEncoding().

getContentLength() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

See URLConnection.getContentLength().

getContentType() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

See URLConnection.getContentType().

getCustomHeader(String, String) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

Get a custom header configured for this instance.

getCustomHeaders() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

Get the mapping of custom headers configured for this instance.

getData() - Method in class uk.org.rivernile.android.fetchutils.fetchers.readers.StringFetcherStreamReader

Get the data that was read from the stream as a String.

getDate() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

See URLConnection.getDate().

getError() - Method in class uk.org.rivernile.android.fetchutils.loaders.Result

Get the error Exception object.

getExpiration() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

See URLConnection.getExpiration().

getFetcher(Context, Uri) - Static method in class uk.org.rivernile.android.fetchutils.fetchers.FetcherFactory

Get the most appropriate Fetcher for the given Uri.

getFile() - Method in class uk.org.rivernile.android.fetchutils.fetchers.FileFetcher

Get the File that this instance uses to read data from.

getFile() - Method in class uk.org.rivernile.android.fetchutils.fetchers.readers.FileWriterFetcherStreamReader

Get a File object, describing the file that the data will be written out to.

getFilePath() - Method in class uk.org.rivernile.android.fetchutils.fetchers.AssetFileFetcher

Get the path to the file, as given in the constructor.

getHeaderField(String) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

See URLConnection.getHeaderField(String).

getHeaderField(int) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

See URLConnection.getHeaderField(int).

getHeaderFieldDate(String, long) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

See HttpURLConnection.getHeaderFieldDate(String, long).

getHeaderFieldInt(String, int) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

See URLConnection.getHeaderFieldInt(String, int).

getHeaderFieldKey(int) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

See URLConnection.getHeaderFieldKey(int).

getHeaderFields() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

See URLConnection.getHeaderFields().

getJSONArray() - Method in class uk.org.rivernile.android.fetchutils.fetchers.readers.JSONFetcherStreamReader

Get a JSONArray version of this data.

getJSONObject() - Method in class uk.org.rivernile.android.fetchutils.fetchers.readers.JSONFetcherStreamReader

Get a JSONObject version of this data.

getLastModified() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

See URLConnection.getLastModified().

getModifiedSince() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

Get the modification timestamp configured for this instance.

getProxy() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

Get the Proxy configured for this instance, if one is configured.

getReadTimeout() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

Get the read timeout configured for this instance.

getRequestMethod() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

Get the request method configured for this instance.

getResponseCode() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

See HttpURLConnection.getResponseCode().

getSuccess() - Method in class uk.org.rivernile.android.fetchutils.loaders.Result

Get the success object.

getUrl() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

Get the URL that this instance is configured for.

H

hasRun() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

Has this instance run yet? That is, has HttpFetcher.executeFetcher(FetcherStreamReader) been called?

HttpFetcher - Class in uk.org.rivernile.android.fetchutils.fetchers

A HttpFetcher fetches data from a HTTP server, specified by the given URL.

HttpFetcher.Builder - Class in uk.org.rivernile.android.fetchutils.fetchers

This class is used to construct a new HttpFetcher.

HttpFetcher.Builder(Context) - Constructor for class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher.Builder

Create a new Builder instance which can later be used to construct a HttpFetcher.

I

isAllowHostRedirects() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

Does this instance allow redirects between different hosts?

isError() - Method in class uk.org.rivernile.android.fetchutils.loaders.Result

Does this Result represent an error?

isFollowRedirects() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

Should this instance follow redirects?

isUseCaches() - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher

Get the cache status configured for this instance.

J

JSONFetcherStreamReader - Class in uk.org.rivernile.android.fetchutils.fetchers.readers

A JSONFetcherStreamReader takes an InputStream and produces a JSONObject or JSONArray version of this data.

JSONFetcherStreamReader() - Constructor for class uk.org.rivernile.android.fetchutils.fetchers.readers.JSONFetcherStreamReader

L

loadInBackground() - Method in class uk.org.rivernile.android.fetchutils.loaders.SimpleAsyncTaskLoader

loadInBackground() - Method in class uk.org.rivernile.android.fetchutils.loaders.support.SimpleAsyncTaskLoader

O

onReset() - Method in class uk.org.rivernile.android.fetchutils.loaders.SimpleAsyncTaskLoader

onReset() - Method in class uk.org.rivernile.android.fetchutils.loaders.support.SimpleAsyncTaskLoader

onStartLoading() - Method in class uk.org.rivernile.android.fetchutils.loaders.SimpleAsyncTaskLoader

onStartLoading() - Method in class uk.org.rivernile.android.fetchutils.loaders.support.SimpleAsyncTaskLoader

onStopLoading() - Method in class uk.org.rivernile.android.fetchutils.loaders.SimpleAsyncTaskLoader

onStopLoading() - Method in class uk.org.rivernile.android.fetchutils.loaders.support.SimpleAsyncTaskLoader

R

readInputStream(InputStream) - Method in interface uk.org.rivernile.android.fetchutils.fetchers.FetcherStreamReader

This method is called when an InputStream is available to read from.

readInputStream(InputStream) - Method in class uk.org.rivernile.android.fetchutils.fetchers.readers.BitmapFetcherStreamReader

readInputStream(InputStream) - Method in class uk.org.rivernile.android.fetchutils.fetchers.readers.FileWriterFetcherStreamReader

readInputStream(InputStream) - Method in class uk.org.rivernile.android.fetchutils.fetchers.readers.StringFetcherStreamReader

Result<S,E extends Exception> - Class in uk.org.rivernile.android.fetchutils.loaders

Loaders can only return a single object.

Result(S) - Constructor for class uk.org.rivernile.android.fetchutils.loaders.Result

Create a Result that holds a success object.

Result(E) - Constructor for class uk.org.rivernile.android.fetchutils.loaders.Result

Create a Result that holds an error.

S

setAllowHostRedirects(boolean) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher.Builder

Should the fetcher allow redirects between hosts? This is used to detect if a Wi-Fi sign in page has been encountered, in which case a UrlMismatchException is thrown.

setConnectTimeout(int) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher.Builder

See URLConnection.setConnectTimeout(int).

setCustomHeader(String, String) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher.Builder

Set a custom header to use in the request.

setFollowRedirects(boolean) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher.Builder

See HttpURLConnection.setInstanceFollowRedirects(boolean).

setIfModifiedSince(long) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher.Builder

See URLConnection.setIfModifiedSince(long).

setProxy(Proxy) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher.Builder

Set a proxy to use for the connection.

setReadTimeout(int) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher.Builder

See URLConnection.setReadTimeout(int).

setRequestMethod(String) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher.Builder

See HttpURLConnection.setRequestMethod(String).

setUrl(String) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher.Builder

Set the URL to request from the server.

setUseCaches(boolean) - Method in class uk.org.rivernile.android.fetchutils.fetchers.HttpFetcher.Builder

See URLConnection.setUseCaches(boolean).

SimpleAsyncTaskLoader<D> - Class in uk.org.rivernile.android.fetchutils.loaders

This class defines an easy to use Loader, based specifically on the Android framework's AsyncTaskLoader.

SimpleAsyncTaskLoader(Context) - Constructor for class uk.org.rivernile.android.fetchutils.loaders.SimpleAsyncTaskLoader

Create a new SimpleAsyncTaskLoader.

SimpleAsyncTaskLoader<D> - Class in uk.org.rivernile.android.fetchutils.loaders.support

This class defines an easy to use Loader, based specifically on the Android support library's AsyncTaskLoader.

SimpleAsyncTaskLoader(Context) - Constructor for class uk.org.rivernile.android.fetchutils.loaders.support.SimpleAsyncTaskLoader

Create a new SimpleAsyncTaskLoader.

StringFetcherStreamReader - Class in uk.org.rivernile.android.fetchutils.fetchers.readers

A StringFetcherStreamReader takes an InputStream and creates a String version of this data.

StringFetcherStreamReader() - Constructor for class uk.org.rivernile.android.fetchutils.fetchers.readers.StringFetcherStreamReader

T

toString() - Method in class uk.org.rivernile.android.fetchutils.fetchers.readers.StringFetcherStreamReader

U

uk.org.rivernile.android.fetchutils - package uk.org.rivernile.android.fetchutils

uk.org.rivernile.android.fetchutils.fetchers - package uk.org.rivernile.android.fetchutils.fetchers

uk.org.rivernile.android.fetchutils.fetchers.readers - package uk.org.rivernile.android.fetchutils.fetchers.readers

uk.org.rivernile.android.fetchutils.loaders - package uk.org.rivernile.android.fetchutils.loaders

uk.org.rivernile.android.fetchutils.loaders.support - package uk.org.rivernile.android.fetchutils.loaders.support

UrlMismatchException - Exception in uk.org.rivernile.android.fetchutils.fetchers

This IOException is thrown when the remote path of the data to be fetched from the server is not the same as the requested path.

UrlMismatchException() - Constructor for exception uk.org.rivernile.android.fetchutils.fetchers.UrlMismatchException

Constructs a new UrlMismatchException with the default message filled in.

UrlMismatchException(String) - Constructor for exception uk.org.rivernile.android.fetchutils.fetchers.UrlMismatchException

Constructs a new UrlMismatchException, specifying the message.

V

VERSION_CODE - Static variable in class uk.org.rivernile.android.fetchutils.BuildConfig

VERSION_NAME - Static variable in class uk.org.rivernile.android.fetchutils.BuildConfig

A B C D E F G H I J L O R S T U V