com.atlassian.gadgets.feed
Interface GadgetFeedReader

public interface GadgetFeedReader

Reads a gadget feed and provides access to the feed's properties.

Since:

3.2

Method Summary

boolean	contains(URI gadgetSpecUri) Determines if the provided gadget spec exists in the gadget feed.
Iterable<URI>	entries() Get all of the gadget spec URI available in the feed.
String	getApplicationName() Get the name of the application providing the feed.
URI	getBaseUri() Get the base URI of the applications
URI	getIcon() Get the icon of the gadget feed.
String	getTitle() Get the title of the gadget feed.

Method Detail

getApplicationName

String getApplicationName()

Get the name of the application providing the feed.

Returns:

the name of the application providing the feed.

getTitle

String getTitle()

Get the title of the gadget feed.

Returns:

the title of the gadget feed

getIcon

URI getIcon()

Get the icon of the gadget feed. If the feed has no icon, null is returned.

Returns:

the icon of the gadget feed

getBaseUri

URI getBaseUri()

Get the base URI of the applications

Returns:

the base URI of the applications

contains

boolean contains(URI gadgetSpecUri)

Determines if the provided gadget spec exists in the gadget feed.

Parameters:

gadgetSpecUri - - the URI of gadget spec to search for.

Returns:

true if the provided gadget spec exists in the gadget feed.

entries

Iterable<URI> entries()

Get all of the gadget spec URI available in the feed.

Returns:

all of the gadget spec URI available in the feed.