com.pkmmte.pkrss

Class RequestCreator

java.lang.Object

com.pkmmte.pkrss.RequestCreator

public class RequestCreator
extends java.lang.Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RequestCreator(PkRSS singleton, java.lang.String url)

Method Summary

Methods

Modifier and Type	Method and Description
void	async() Executes request asynchronously.
RequestCreator	callback(Callback callback) Adds a callback listener to this request.
java.util.List<Article>	get() Executes request and returns a full list containing all articles loaded from this request's URL.
Article	getFirst() Executes request and returns the first Article associated with this request.
RequestCreator	individual() Threats this request as an individual article, rather than full feed.
RequestCreator	nextPage() Loads the next page of the current RSS feed.
RequestCreator	page(int page) Loads a specific page of the RSS feed.
RequestCreator	search(java.lang.String search) Looks up a specific query on the RSS feed.
RequestCreator	skipCache() Ignores already cached responses when making this request.
RequestCreator	tag(java.lang.String tag) Assigns a reference tag to this request.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestCreator

protected RequestCreator(PkRSS singleton,
              java.lang.String url)

Method Detail

tag

public RequestCreator tag(java.lang.String tag)

Assigns a reference tag to this request. Leaving this empty will automatically generate a tag.

Parameters:

tag -

search

public RequestCreator search(java.lang.String search)

Looks up a specific query on the RSS feed. The query string is automatically encoded.

Parameters:

search -

individual

public RequestCreator individual()

Threats this request as an individual article, rather than full feed. Use only if you are sure that the load URL belongs to a single article.

skipCache

public RequestCreator skipCache()

Ignores already cached responses when making this request. Useful for refreshing feeds/articles.

page

public RequestCreator page(int page)

Loads a specific page of the RSS feed.

Parameters:

page - Page to load.

nextPage

public RequestCreator nextPage()

Loads the next page of the current RSS feed. If no page was previously loaded, this will request the first page.

callback

public RequestCreator callback(Callback callback)

Adds a callback listener to this request.

Parameters:

callback - Callback interface to respond to.

get

public java.util.List<Article> get()
                            throws java.io.IOException

Executes request and returns a full list containing all articles loaded from this request's URL.

If this request is marked as individual, the list will contain only 1 index. It is recommended to use getFirst() for individual requests instead.

Throws:

java.io.IOException

getFirst

public Article getFirst()

Executes request and returns the first Article associated with this request. This is useful for individual Article requests.

May return null.

Returns:

Returns the first article associated with this request.

async

public void async()

Executes request asynchronously.

Be sure to add a callback to handle this.