com.sun.syndication.feed.synd
public interface SyndFeed extends Cloneable, CopyFrom, Extendable
It handles all RSS versions and Atom 0.3, it normalizes all info, it may lose information.
Method Summary | |
---|---|
Object | clone()
Creates a deep clone of the object.
|
WireFeed | createWireFeed()
Creates a real feed containing the information of the SyndFeedImpl.
|
WireFeed | createWireFeed(String feedType)
Creates a real feed containing the information of the SyndFeedImpl.
|
String | getAuthor()
Returns the name of the first feed author in the collection of authors.
|
List | getAuthors()
Returns the feed authors.
|
List | getCategories()
Returns the feed categories.
|
List | getContributors()
Returns the feed author.
|
String | getCopyright()
Returns the feed copyright.
|
String | getDescription()
Returns the feed description.
|
SyndContent | getDescriptionEx()
Returns the feed description as a text construct.
|
String | getEncoding()
Returns the charset encoding of a the feed. |
List | getEntries()
Returns the feed entries.
|
String | getFeedType()
Returns the wire feed type the feed had/will-have when coverted from/to a WireFeed.
|
Object | getForeignMarkup()
Returns foreign markup found at channel level.
|
SyndImage | getImage()
Returns the feed image.
|
String | getLanguage()
Returns the feed language.
|
String | getLink()
Returns the feed link.
|
List | getLinks()
Returns the entry links
|
Module | getModule(String uri)
Returns the module identified by a given URI.
|
List | getModules()
Returns the feed modules.
|
Date | getPublishedDate()
Returns the feed published date.
|
List | getSupportedFeedTypes()
Returns the real feed types the SyndFeedImpl supports when converting from and to.
|
String | getTitle()
Returns the feed title.
|
SyndContent | getTitleEx()
Returns the feed title.
|
String | getUri()
Returns the feed URI.
|
void | setAuthor(String author)
Sets the feed author.
|
void | setAuthors(List authors)
Sets the feed author.
|
void | setCategories(List categories)
Sets the feed categories.
|
void | setContributors(List contributors)
Sets the feed author.
|
void | setCopyright(String copyright)
Sets the feed copyright.
|
void | setDescription(String description)
Sets the feed description.
|
void | setDescriptionEx(SyndContent description)
Sets the feed description as a text construct.
|
void | setEncoding(String encoding)
Sets the charset encoding of a the feed. |
void | setEntries(List entries)
Sets the feed entries.
|
void | setFeedType(String feedType)
Sets the wire feed type the feed will-have when coverted to a WireFeed.
|
void | setForeignMarkup(Object foreignMarkup)
Sets foreign markup found at channel level.
|
void | setImage(SyndImage image)
Sets the feed image.
|
void | setLanguage(String language)
Sets the feed language.
|
void | setLink(String link)
Sets the feed link.
|
void | setLinks(List links)
Sets the entry links.
|
void | setModules(List modules)
Sets the feed modules.
|
void | setPublishedDate(Date publishedDate)
Sets the feed published date.
|
void | setTitle(String title)
Sets the feed title.
|
void | setTitleEx(SyndContent title)
Sets the feed title.
|
void | setUri(String uri)
Sets the feed URI.
|
Returns: a clone of the object.
Throws: CloneNotSupportedException thrown if an element of the object cannot be cloned.
The feed type of the created WireFeed is taken from the SyndFeedImpl feedType property.
Returns: the real feed.
Parameters: feedType the feed type for the WireFeed to be created.
Returns: the real feed.
For Atom feeds, this returns the authors as a list of SyndPerson objects, for RSS feeds this method is a convenience method, it maps to the Dublin Core module creator.
Returns: the feed author, null if none.
For Atom feeds, this returns the authors as a list of SyndPerson objects, for RSS feeds this method is a convenience method, it maps to the Dublin Core module creator.
Returns: the feed author, null if none.
This method is a convenience method, it maps to the Dublin Core module subjects.
Returns: a list of SyndCategoryImpl elements with the feed categories, an empty list if none.
For Atom feeds, this returns the contributors as a list of SyndPerson objects
Returns: the feed author, null if none.
This method is a convenience method, it maps to the Dublin Core module rights.
Returns: the feed copyright, null if none.
Returns: the feed description, null if none.
Returns: the feed description, null if none.
Returns: the charset encoding of the feed.
Returns: a list of SyndEntryImpl elements with the feed entries, an empty list if none.
Returns: the feed type, null if none.
Returns: Opaque object to discourage use
Returns: the feed image, null if none.
This method is a convenience method, it maps to the Dublin Core module language.
Returns: the feed language, null if none.
Note: The URI is the unique identifier, in the RSS 2.0/atom case this is the GUID, for RSS 1.0 this is the URI attribute of the item. The Link is the URL that the item is accessible under, the URI is the permanent identifier which the aggregator should use to reference this item. Often the URI will use some standardized identifier scheme such as DOI's so that items can be identified even if they appear in multiple feeds with different "links" (they might be on different hosting platforms but be the same item). Also, though rare, there could be multiple items with the same link but a different URI and associated metadata which need to be treated as distinct entities. In the RSS 1.0 case the URI must be a valid RDF URI reference.
Returns: the feed link, null if none.
Returns: the entry links, null if none.
Parameters: uri the URI of the ModuleImpl.
Returns: The module with the given URI, null if none.
Returns: a list of ModuleImpl elements with the feed modules, an empty list if none.
This method is a convenience method, it maps to the Dublin Core module date.
Returns: the feed published date, null if none.
Returns: the real feed type supported.
Returns: the feed title, null if none.
Returns: the feed title, null if none.
How the feed URI maps to a concrete feed type (RSS or Atom) depends on the concrete feed type. This is explained in detail in Rome documentation, Feed and entry URI mapping.
The returned URI is a normalized URI as specified in RFC 2396bis.
Note: The URI is the unique identifier, in the RSS 2.0/atom case this is the GUID, for RSS 1.0 this is the URI attribute of the item. The Link is the URL that the item is accessible under, the URI is the permanent identifier which the aggregator should use to reference this item. Often the URI will use some standardized identifier scheme such as DOI's so that items can be identified even if they appear in multiple feeds with different "links" (they might be on different hosting platforms but be the same item). Also, though rare, there could be multiple items with the same link but a different URI and associated metadata which need to be treated as distinct entities. In the RSS 1.0 case the URI must be a valid RDF URI reference.
Returns: the feed URI, null if none.
For Atom feeds, this sets the feed author's name, for RSS feeds this method is a convenience method, it maps to the Dublin Core module creator.
Parameters: author the feed author to set, null if none.
For Atom feeds, this sets the authors as a list of SyndPerson objects, for RSS feeds this method is a convenience method, it maps to the Dublin Core module creator.
Parameters: author the feed author to set, null if none.
This method is a convenience method, it maps to the Dublin Core module subjects.
Parameters: categories the list of SyndCategoryImpl elements with the feed categories to set, an empty list or null if none.
Returns contributors as a list of SyndPerson objects.
Parameters: author the feed author to set, null if none.
This method is a convenience method, it maps to the Dublin Core module rights.
Parameters: copyright the feed copyright to set, null if none.
Parameters: description the feed description to set, null if none.
Parameters: description the feed description to set, null if none.
Parameters: encoding the charset encoding of the feed.
Parameters: entries the list of SyndEntryImpl elements with the feed entries to set, an empty list or null if none.
Parameters: feedType the feed type to set, null if none.
Parameters: foreignMarkup Opaque object to discourage use
Parameters: image the feed image to set, null if none.
This method is a convenience method, it maps to the Dublin Core module language.
Parameters: language the feed language to set, null if none.
Note: The URI is the unique identifier, in the RSS 2.0/atom case this is the GUID, for RSS 1.0 this is the URI attribute of the item. The Link is the URL that the item is accessible under, the URI is the permanent identifier which the aggregator should use to reference this item. Often the URI will use some standardized identifier scheme such as DOI's so that items can be identified even if they appear in multiple feeds with different "links" (they might be on different hosting platforms but be the same item). Also, though rare, there could be multiple items with the same link but a different URI and associated metadata which need to be treated as distinct entities. In the RSS 1.0 case the URI must be a valid RDF URI reference.
Parameters: link the feed link to set, null if none.
Parameters: links the entry links to set, null if none.
Parameters: modules the list of ModuleImpl elements with the feed modules to set, an empty list or null if none.
This method is a convenience method, it maps to the Dublin Core module date.
Parameters: publishedDate the feed published date to set, null if none.
Parameters: title the feed title to set, null if none.
Parameters: title the feed title to set, null if none.
How the feed URI maps to a concrete feed type (RSS or Atom) depends on the concrete feed type. This is explained in detail in Rome documentation, Feed and entry URI mapping.
Note: The URI is the unique identifier, in the RSS 2.0/atom case this is the GUID, for RSS 1.0 this is the URI attribute of the item. The Link is the URL that the item is accessible under, the URI is the permanent identifier which the aggregator should use to reference this item. Often the URI will use some standardized identifier scheme such as DOI's so that items can be identified even if they appear in multiple feeds with different "links" (they might be on different hosting platforms but be the same item). Also, though rare, there could be multiple items with the same link but a different URI and associated metadata which need to be treated as distinct entities. In the RSS 1.0 case the URI must be a valid RDF URI reference.
Parameters: uri the feed URI to set, null if none.