Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.sun.syndication.feed.synd
Interface SyndEntry  view SyndEntry download SyndEntry.java

All Superinterfaces:
java.lang.Cloneable, com.sun.syndication.feed.CopyFrom
All Known Implementing Classes:
SyndEntryImpl

public interface SyndEntry
extends java.lang.Cloneable, com.sun.syndication.feed.CopyFrom

Bean interface for entries of SyndFeedImpl feeds.


Method Summary
 java.lang.Object clone()
          Creates a deep clone of the object.
 java.lang.String getAuthor()
          Returns the name of the first entry author in the collection of authors.
 java.util.List getAuthors()
          Returns the entry authors.
 java.util.List getCategories()
          Returns the entry categories.
 java.util.List getContents()
          Returns the entry contents.
 java.util.List getContributors()
          Returns the feed author.
 SyndContent getDescription()
          Returns the entry description.
 java.util.List getEnclosures()
          Returns the entry enclosures.
 java.lang.String getLink()
          Returns the entry 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 entry modules.
 java.util.Date getPublishedDate()
          Returns the entry published date.
 java.lang.String getTitle()
          Returns the entry title.
 java.util.Date getUpdatedDate()
          Returns the entry updated date.
 java.lang.String getUri()
          Returns the entry URI.
 void setAuthor(java.lang.String author)
          Sets the entry author.
 void setAuthors(java.util.List authors)
          Sets the entry author.
 void setCategories(java.util.List categories)
          Sets the entry categories.
 void setContents(java.util.List contents)
          Sets the entry contents.
 void setContributors(java.util.List contributors)
          Sets the feed author.
 void setDescription(SyndContent description)
          Sets the entry description.
 void setEnclosures(java.util.List enclosures)
          Sets the entry enclosures.
 void setLink(java.lang.String link)
          Sets the entry link.
 void setLinks(java.util.List links)
          Sets the entry links.
 void setModules(java.util.List modules)
          Sets the entry modules.
 void setPublishedDate(java.util.Date publishedDate)
          Sets the entry published date.
 void setTitle(java.lang.String title)
          Sets the entry title.
 void setUpdatedDate(java.util.Date updatedDate)
          Sets the entry updated date.
 void setUri(java.lang.String uri)
          Sets the entry URI.
 
Methods inherited from interface com.sun.syndication.feed.CopyFrom
copyFrom, getInterface
 

Method Detail

getUri

public java.lang.String getUri()
Returns the entry URI.

How the entry 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.


setUri

public void setUri(java.lang.String uri)
Sets the entry URI.

How the entry 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.


getTitle

public java.lang.String getTitle()
Returns the entry title.


setTitle

public void setTitle(java.lang.String title)
Sets the entry title.


getLink

public java.lang.String getLink()
Returns the entry link.


setLink

public void setLink(java.lang.String link)
Sets the entry link.


getLinks

public java.util.List getLinks()
Returns the entry links


setLinks

public void setLinks(java.util.List links)
Sets the entry links.


getDescription

public SyndContent getDescription()
Returns the entry description.


setDescription

public void setDescription(SyndContent description)
Sets the entry description.


getContents

public java.util.List getContents()
Returns the entry contents.


setContents

public void setContents(java.util.List contents)
Sets the entry contents.


getEnclosures

public java.util.List getEnclosures()
Returns the entry enclosures.


setEnclosures

public void setEnclosures(java.util.List enclosures)
Sets the entry enclosures.


getPublishedDate

public java.util.Date getPublishedDate()
Returns the entry 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 entry published date.

This method is a convenience method, it maps to the Dublin Core module date.


getUpdatedDate

public java.util.Date getUpdatedDate()
Returns the entry updated date.


setUpdatedDate

public void setUpdatedDate(java.util.Date updatedDate)
Sets the entry updated date.


getAuthors

public java.util.List getAuthors()
Returns the entry 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 entry 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 entry 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 entry 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.


getCategories

public java.util.List getCategories()
Returns the entry 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 entry categories.

This method is a convenience method, it maps to the Dublin Core module subjects.


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 entry modules.


setModules

public void setModules(java.util.List modules)
Sets the entry modules.


clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Creates a deep clone of the object.