| com.sun.syndication.feed.synd.SyndFeed
All known Subclasses: com.sun.syndication.feed.synd.SyndFeedImpl,
| SyndFeed | | public interface SyndFeed extends Cloneable,CopyFrom,Extendable(Code) | | Bean interface for all types of feeds.
It handles all RSS versions and Atom 0.3, it normalizes all info, it may lose information.
author:
Alejandro Abdelnur |
| createWireFeed | | WireFeed createWireFeed()(Code) | | Creates a real feed containing the information of the SyndFeedImpl.
The feed type of the created WireFeed is taken from the SyndFeedImpl feedType property.
the real feed. |
| createWireFeed | | WireFeed createWireFeed(String feedType)(Code) | | Creates a real feed containing the information of the SyndFeedImpl.
Parameters:
feedType - the feed type for the WireFeed to be created. the real feed. |
| getAuthor | | String getAuthor()(Code) | | Returns the name of the first feed author in the collection of authors.
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.
the feed author, null if none. |
| getAuthors | | List getAuthors()(Code) | | Returns the feed authors.
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.
the feed author, null if none. |
| getCategories | | List getCategories()(Code) | | Returns the feed categories.
This method is a convenience method, it maps to the Dublin Core module subjects.
a list of SyndCategoryImpl elements with the feed categories,an empty list if none. |
| getContributors | | public List getContributors()(Code) | | Returns the feed author.
For Atom feeds, this returns the contributors as a list of
SyndPerson objects
the feed author, null if none. |
| getCopyright | | String getCopyright()(Code) | | Returns the feed copyright.
This method is a convenience method, it maps to the Dublin Core module rights.
the feed copyright, null if none. |
| getDescription | | String getDescription()(Code) | | Returns the feed description.
the feed description, null if none. |
| getDescriptionEx | | SyndContent getDescriptionEx()(Code) | | Returns the feed description as a text construct.
the feed description, null if none. |
| getEncoding | | public String getEncoding()(Code) | | Returns the charset encoding of a the feed. This is not set by Rome parsers.
the charset encoding of the feed. |
| getEntries | | List getEntries()(Code) | | Returns the feed entries.
a list of SyndEntryImpl elements with the feed entries,an empty list if none. |
| getFeedType | | String getFeedType()(Code) | | Returns the wire feed type the feed had/will-have when coverted from/to a WireFeed.
the feed type, null if none. |
| getForeignMarkup | | public Object getForeignMarkup()(Code) | | Returns foreign markup found at channel level.
Opaque object to discourage use |
| getImage | | SyndImage getImage()(Code) | | Returns the feed image.
the feed image, null if none. |
| getLanguage | | String getLanguage()(Code) | | Returns the feed language.
This method is a convenience method, it maps to the Dublin Core module language.
the feed language, null if none. |
| getLink | | String getLink()(Code) | | Returns the feed link.
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.
the feed link, null if none. |
| getLinks | | List getLinks()(Code) | | Returns the entry links
the entry links, null if none. |
| getModule | | public Module getModule(String uri)(Code) | | Returns the module identified by a given URI.
Parameters:
uri - the URI of the ModuleImpl. The module with the given URI, null if none. |
| getModules | | List getModules()(Code) | | Returns the feed modules.
a list of ModuleImpl elements with the feed modules,an empty list if none. |
| getPublishedDate | | Date getPublishedDate()(Code) | | Returns the feed published date.
This method is a convenience method, it maps to the Dublin Core module date.
the feed published date, null if none. |
| getSupportedFeedTypes | | List getSupportedFeedTypes()(Code) | | Returns the real feed types the SyndFeedImpl supports when converting from and to.
the real feed type supported. |
| getTitle | | String getTitle()(Code) | | Returns the feed title.
the feed title, null if none. |
| getTitleEx | | SyndContent getTitleEx()(Code) | | Returns the feed title.
the feed title, null if none. |
| getUri | | String getUri()(Code) | | Returns the feed URI.
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.
the feed URI, null if none. |
| setAuthor | | void setAuthor(String author)(Code) | | Sets the feed author.
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. |
| setAuthors | | void setAuthors(List authors)(Code) | | Sets the feed author.
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. |
| setCategories | | void setCategories(List categories)(Code) | | Sets the feed categories.
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. |
| setContributors | | void setContributors(List contributors)(Code) | | Sets the feed author.
Returns contributors as a list of SyndPerson objects.
Parameters:
author - the feed author to set, null if none. |
| setCopyright | | void setCopyright(String copyright)(Code) | | Sets the feed copyright.
This method is a convenience method, it maps to the Dublin Core module rights.
Parameters:
copyright - the feed copyright to set, null if none. |
| setDescription | | void setDescription(String description)(Code) | | Sets the feed description.
Parameters:
description - the feed description to set, null if none. |
| setDescriptionEx | | void setDescriptionEx(SyndContent description)(Code) | | Sets the feed description as a text construct.
Parameters:
description - the feed description to set, null if none. |
| setEncoding | | public void setEncoding(String encoding)(Code) | | Sets the charset encoding of a the feed. This is not set by Rome parsers.
Parameters:
encoding - the charset encoding of the feed. |
| setEntries | | void setEntries(List entries)(Code) | | Sets the feed entries.
Parameters:
entries - the list of SyndEntryImpl elements with the feed entries to set,an empty list or null if none. |
| setFeedType | | void setFeedType(String feedType)(Code) | | Sets the wire feed type the feed will-have when coverted to a WireFeed.
Parameters:
feedType - the feed type to set, null if none. |
| setForeignMarkup | | public void setForeignMarkup(Object foreignMarkup)(Code) | | Sets foreign markup found at channel level.
Parameters:
foreignMarkup - Opaque object to discourage use |
| setImage | | void setImage(SyndImage image)(Code) | | Sets the feed image.
Parameters:
image - the feed image to set, null if none. |
| setLanguage | | void setLanguage(String language)(Code) | | Sets the feed language.
This method is a convenience method, it maps to the Dublin Core module language.
Parameters:
language - the feed language to set, null if none. |
| setLink | | void setLink(String link)(Code) | | Sets the feed link.
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. |
| setLinks | | void setLinks(List links)(Code) | | Sets the entry links.
Parameters:
links - the entry links to set, null if none. |
| setModules | | void setModules(List modules)(Code) | | Sets the feed modules.
Parameters:
modules - the list of ModuleImpl elements with the feed modules to set,an empty list or null if none. |
| setPublishedDate | | void setPublishedDate(Date publishedDate)(Code) | | Sets the feed published date.
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. |
| setTitle | | void setTitle(String title)(Code) | | Sets the feed title.
Parameters:
title - the feed title to set, null if none. |
| setTitleEx | | void setTitleEx(SyndContent title)(Code) | | Sets the feed title.
Parameters:
title - the feed title to set, null if none. |
| setUri | | void setUri(String uri)(Code) | | Sets the feed URI.
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. |
|
|