com.pkmmte.pkrss.downloader

Class Downloader

java.lang.Object

com.pkmmte.pkrss.downloader.Downloader

Direct Known Subclasses:

DefaultDownloader, OkHttpDownloader

public abstract class Downloader
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Downloader()

Method Summary

Methods

Modifier and Type	Method and Description
void	attachInstance(PkRSS singleton) Attaches a PkRSS singleton instance to this Parser for logging purposes.
abstract boolean	clearCache() Clears the Downloader cache.
abstract java.lang.String	execute(Request request) Executes the specified request and returns the response String.
abstract java.lang.String	toSafeUrl(Request request) Parses a request into a safe URL to be used for caching/tracking purposes.
abstract java.lang.String	toUrl(Request request) Parses a request into a URL to be used for execution.

Methods inherited from class java.lang.Object

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

Constructor Detail

Downloader

public Downloader()

Method Detail

clearCache

public abstract boolean clearCache()

Clears the Downloader cache.

Returns:

true if successful, false if otherwise.

execute

public abstract java.lang.String execute(Request request)
                                  throws java.lang.IllegalArgumentException,
                                         java.io.IOException

Executes the specified request and returns the response String.

Parameters:

request - PkRSS Request object containing all necessary parameters.

Returns:

Response String to parse

Throws:

java.lang.IllegalArgumentException

java.io.IOException

toSafeUrl

public abstract java.lang.String toSafeUrl(Request request)

Parses a request into a safe URL to be used for caching/tracking purposes.

Note: Returning an invalid URL may cause caching errors and mishandled memory.

Parameters:

request - PkRSS Request object containing all necessary parameters.

Returns:

Safe URL String to be used for tracking and caching purposes.

toUrl

public abstract java.lang.String toUrl(Request request)

Parses a request into a URL to be used for execution.

Parameters:

request - PkRSS Request object containing all necessary parameters.

Returns:

A URL String to load data from.

attachInstance

public final void attachInstance(PkRSS singleton)

Attaches a PkRSS singleton instance to this Parser for logging purposes.

Parameters:

singleton - Singleton instance to attach to this Parser