com.sun.syndication.feed.synd
public interface SyndEntry extends Cloneable, CopyFrom, Extendable
Method Summary | |
---|---|
Object | clone()
Creates a deep clone of the object.
|
String | getAuthor()
Returns the name of the first entry author in the collection of authors.
|
List | getAuthors()
Returns the entry authors.
|
List | getCategories()
Returns the entry categories.
|
List | getContents()
Returns the entry contents.
|
List | getContributors()
Returns the feed author.
|
SyndContent | getDescription()
Returns the entry description.
|
List | getEnclosures()
Returns the entry enclosures.
|
Object | getForeignMarkup()
Returns foreign markup found at channel level.
|
String | getLink()
Returns the entry link.
|
List | getLinks()
Returns the entry links
|
Module | getModule(String uri)
Returns the module identified by a given URI.
|
List | getModules()
Returns the entry modules.
|
Date | getPublishedDate()
Returns the entry published date.
|
String | getTitle()
Returns the entry title.
|
SyndContent | getTitleEx()
Returns the entry title as a text construct.
|
Date | getUpdatedDate()
Returns the entry updated date.
|
String | getUri()
Returns the entry URI.
|
void | setAuthor(String author)
Sets the entry author.
|
void | setAuthors(List authors)
Sets the entry author.
|
void | setCategories(List categories)
Sets the entry categories.
|
void | setContents(List contents)
Sets the entry contents.
|
void | setContributors(List contributors)
Sets the feed author.
|
void | setDescription(SyndContent description)
Sets the entry description.
|
void | setEnclosures(List enclosures)
Sets the entry enclosures.
|
void | setForeignMarkup(Object foreignMarkup)
Sets foreign markup found at channel level.
|
void | setLink(String link)
Sets the entry link.
|
void | setLinks(List links)
Sets the entry links.
|
void | setModules(List modules)
Sets the entry modules.
|
void | setPublishedDate(Date publishedDate)
Sets the entry published date.
|
void | setTitle(String title)
Sets the entry title.
|
void | setTitleEx(SyndContent title)
Sets the entry title as a text construct.
|
void | setUpdatedDate(Date updatedDate)
Sets the entry updated date.
|
void | setUri(String uri)
Sets the entry URI.
|
Returns: a clone of the object.
Throws: CloneNotSupportedException thrown if an element of the object cannot be cloned.
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 entry categories, an empty list if none.
Returns: a list of SyndContentImpl elements with the entry contents, 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.
Returns: the entry description, null if none.
Returns: a list of SyndEnclosure elements with the entry enclosures, an empty list if none.
Returns: Opaque object to discourage use
Returns: the entry 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 entry modules, an empty list if none.
This method is a convenience method, it maps to the Dublin Core module date.
Returns: the entry published date, null if none.
Returns: the entry title, null if none.
Returns: the entry title, null if none.
Returns: the entry updated date, null if none.
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.
Returns: the entry 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 entry categories to set, an empty list or null if none.
Parameters: contents the list of SyndContentImpl elements with the entry contents 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.
Parameters: description the entry description to set, null if none.
Parameters: enclosures the list of SyndEnclosure elements with the entry enclosures to set, an empty list or null if none.
Parameters: foreignMarkup Opaque object to discourage use
Parameters: link the entry 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 entry 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 entry published date to set, null if none.
Parameters: title the entry title to set, null if none.
Parameters: title the entry title to set, null if none.
Parameters: publishedDate the entry updated date to set, null if none.
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.
Parameters: uri the entry URI to set, null if none.