|
|||||||||
| Home >> All >> com >> sun >> syndication >> feed >> [ synd overview ] | PREV CLASS NEXT CLASS | ||||||||
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||
com.sun.syndication.feed.synd
Interface SyndFeed
- All Superinterfaces:
- java.lang.Cloneable, com.sun.syndication.feed.CopyFrom
- All Known Implementing Classes:
- SyndFeedImpl
- public interface SyndFeed
- extends java.lang.Cloneable, com.sun.syndication.feed.CopyFrom
Bean interface for all types of feeds.
It handles all RSS versions and Atom 0.3, it normalizes all info, it may lose information.
| Method Summary | |
java.lang.Object |
clone()
Creates a deep clone of the object. |
com.sun.syndication.feed.WireFeed |
createWireFeed()
Creates a real feed containing the information of the SyndFeedImpl. |
com.sun.syndication.feed.WireFeed |
createWireFeed(java.lang.String feedType)
Creates a real feed containing the information of the SyndFeedImpl. |
java.lang.String |
getAuthor()
Returns the name of the first feed author in the collection of authors. |
java.util.List |
getAuthors()
Returns the feed authors. |
java.util.List |
getCategories()
Returns the feed categories. |
java.util.List |
getContributors()
Returns the feed author. |
java.lang.String |
getCopyright()
Returns the feed copyright. |
java.lang.String |
getDescription()
Returns the feed description. |
java.lang.String |
getEncoding()
Returns the charset encoding of a the feed. |
java.util.List |
getEntries()
Returns the feed entries. |
java.lang.String |
getFeedType()
Returns the wire feed type the feed had/will-have when coverted from/to a WireFeed. |
SyndImage |
getImage()
Returns the feed image. |
java.lang.String |
getLanguage()
Returns the feed language. |
java.lang.String |
getLink()
Returns the feed link. |
java.util.List |
getLinks()
Returns the entry links |
com.sun.syndication.feed.module.Module |
getModule(java.lang.String uri)
Returns the module identified by a given URI. |
java.util.List |
getModules()
Returns the feed modules. |
java.util.Date |
getPublishedDate()
Returns the feed published date. |
java.util.List |
getSupportedFeedTypes()
Returns the real feed types the SyndFeedImpl supports when converting from and to. |
java.lang.String |
getTitle()
Returns the feed title. |
java.lang.String |
getUri()
Returns the feed URI. |
void |
setAuthor(java.lang.String author)
Sets the feed author. |
void |
setAuthors(java.util.List authors)
Sets the feed author. |
void |
setCategories(java.util.List categories)
Sets the feed categories. |
void |
setContributors(java.util.List contributors)
Sets the feed author. |
void |
setCopyright(java.lang.String copyright)
Sets the feed copyright. |
void |
setDescription(java.lang.String description)
Sets the feed description. |
void |
setEncoding(java.lang.String encoding)
Sets the charset encoding of a the feed. |
void |
setEntries(java.util.List entries)
Sets the feed entries. |
void |
setFeedType(java.lang.String feedType)
Sets the wire feed type the feed will-have when coverted to a WireFeed. |
void |
setImage(SyndImage image)
Sets the feed image. |
void |
setLanguage(java.lang.String language)
Sets the feed language. |
void |
setLink(java.lang.String link)
Sets the feed link. |
void |
setLinks(java.util.List links)
Sets the entry links. |
void |
setModules(java.util.List modules)
Sets the feed modules. |
void |
setPublishedDate(java.util.Date publishedDate)
Sets the feed published date. |
void |
setTitle(java.lang.String title)
Sets the feed title. |
void |
setUri(java.lang.String uri)
Sets the feed URI. |
| Methods inherited from interface com.sun.syndication.feed.CopyFrom |
copyFrom, getInterface |
| Method Detail |
getSupportedFeedTypes
public java.util.List getSupportedFeedTypes()
- Returns the real feed types the SyndFeedImpl supports when converting from and to.
createWireFeed
public com.sun.syndication.feed.WireFeed createWireFeed()
- Creates a real feed containing the information of the SyndFeedImpl.
The feed type of the created WireFeed is taken from the SyndFeedImpl feedType property.
createWireFeed
public com.sun.syndication.feed.WireFeed createWireFeed(java.lang.String feedType)
- Creates a real feed containing the information of the SyndFeedImpl.
getFeedType
public java.lang.String getFeedType()
- Returns the wire feed type the feed had/will-have when coverted from/to a WireFeed.
setFeedType
public void setFeedType(java.lang.String feedType)
- Sets the wire feed type the feed will-have when coverted to a WireFeed.
getEncoding
public java.lang.String getEncoding()
- Returns the charset encoding of a the feed. This is not set by Rome parsers.
setEncoding
public void setEncoding(java.lang.String encoding)
- Sets the charset encoding of a the feed. This is not set by Rome parsers.
getUri
public java.lang.String getUri()
- 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.
setUri
public void setUri(java.lang.String uri)
- 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.
getTitle
public java.lang.String getTitle()
- Returns the feed title.
setTitle
public void setTitle(java.lang.String title)
- Sets the feed title.
getLink
public java.lang.String getLink()
- 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.
setLink
public void setLink(java.lang.String link)
- 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.
getLinks
public java.util.List getLinks()
- Returns the entry links
setLinks
public void setLinks(java.util.List links)
- Sets the entry links.
getDescription
public java.lang.String getDescription()
- Returns the feed description.
setDescription
public void setDescription(java.lang.String description)
- Sets the feed description.
getPublishedDate
public java.util.Date getPublishedDate()
- Returns the feed published date.
This method is a convenience method, it maps to the Dublin Core module date.
setPublishedDate
public void setPublishedDate(java.util.Date publishedDate)
- Sets the feed published date.
This method is a convenience method, it maps to the Dublin Core module date.
getAuthors
public java.util.List getAuthors()
- 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.
setAuthors
public void setAuthors(java.util.List authors)
- 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.
getAuthor
public java.lang.String getAuthor()
- 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.
setAuthor
public void setAuthor(java.lang.String author)
- 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.
getContributors
public java.util.List getContributors()
- Returns the feed author.
For Atom feeds, this returns the contributors as a list of SyndPerson objects
setContributors
public void setContributors(java.util.List contributors)
- Sets the feed author.
Returns contributors as a list of SyndPerson objects.
getCopyright
public java.lang.String getCopyright()
- Returns the feed copyright.
This method is a convenience method, it maps to the Dublin Core module rights.
setCopyright
public void setCopyright(java.lang.String copyright)
- Sets the feed copyright.
This method is a convenience method, it maps to the Dublin Core module rights.
getImage
public SyndImage getImage()
- Returns the feed image.
setImage
public void setImage(SyndImage image)
- Sets the feed image.
getCategories
public java.util.List getCategories()
- Returns the feed categories.
This method is a convenience method, it maps to the Dublin Core module subjects.
setCategories
public void setCategories(java.util.List categories)
- Sets the feed categories.
This method is a convenience method, it maps to the Dublin Core module subjects.
getEntries
public java.util.List getEntries()
- Returns the feed entries.
setEntries
public void setEntries(java.util.List entries)
- Sets the feed entries.
getLanguage
public java.lang.String getLanguage()
- Returns the feed language.
This method is a convenience method, it maps to the Dublin Core module language.
setLanguage
public void setLanguage(java.lang.String language)
- Sets the feed language.
This method is a convenience method, it maps to the Dublin Core module language.
getModule
public com.sun.syndication.feed.module.Module getModule(java.lang.String uri)
- Returns the module identified by a given URI.
getModules
public java.util.List getModules()
- Returns the feed modules.
setModules
public void setModules(java.util.List modules)
- Sets the feed modules.
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
- Creates a deep clone of the object.
|
|||||||||
| Home >> All >> com >> sun >> syndication >> feed >> [ synd overview ] | PREV CLASS NEXT CLASS | ||||||||
|
SUMMARY: JAVADOC | SOURCE | DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||