uk.org.rivernile.android.fetchutils.fetchers

Class FileFetcher

java.lang.Object

uk.org.rivernile.android.fetchutils.fetchers.FileFetcher

All Implemented Interfaces:

Fetcher

public class FileFetcher
extends Object
implements Fetcher

A FileFetcher fetches data from a given File or path. The data is then passed in to an instance of a FetcherStreamReader.

This class takes care of opening and closing the file.

Constructor Summary

Constructors

Constructor and Description
FileFetcher(File file) Create a new instance of FileFetcher, specifying the File to read from.
FileFetcher(String filePath) Create a new instance of FileFetcher, specifying the path of the file.

Method Summary

Methods

Modifier and Type	Method and Description
void	executeFetcher(FetcherStreamReader reader) Start this Fetcher.
File	getFile() Get the File that this instance uses to read data from.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileFetcher

public FileFetcher(String filePath)

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

Parameters:

filePath - The path to the file that is to be read from. Must not be null or empty.

FileFetcher

public FileFetcher(File file)

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

Parameters:

file - The File to read from. Must not be null.

Method Detail

executeFetcher

public void executeFetcher(FetcherStreamReader reader)
                    throws IOException

Description copied from interface: Fetcher

Start this Fetcher. This will execute the fetcher and feed the stream of data in to the supplied FetcherStreamReader.

Specified by:

executeFetcher in interface Fetcher

Parameters:

reader - Where the stream of data should be sent to.

Throws:

IOException - When there was a problem during the fetching process. This may be because, for example, of a network or a missing file.

getFile

public File getFile()

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

Returns:

A File object describing the file that this instance points at.