Top Description Methods
com.rometools.rome.feed.synd

public Interface SyndEntry

extends Cloneable, CopyFrom, Extendable
Known Direct Implementers
com.rometools.rome.feed.synd.SyndEntryImpl
Imports
java.util.Date, .List, org.jdom2.Element, com.rometools.rome.feed.CopyFrom, com.rometools.rome.feed.module.Extendable, .Module
Bean interface for entries of SyndFeedImpl feeds.

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

a clone of the object.
clone()

Creates a deep clone of the object.

public String

Returns:

the feed author, empty string if none.
getAuthor()

Returns the name of the first entry author in the collection of authors.

public List<SyndPerson>

Returns:

the feed authors, empty list if none.
getAuthors()

Returns the entry authors.

public List<SyndCategory>

Returns:

a list of SyndCategoryImpl elements with the entry categories, an empty list if none.
getCategories()

Returns the entry categories.

public String

Returns:

comments URL or null.
getComments()

URL of a page for comments relating to the item.

public List<SyndContent>

Returns:

a list of SyndContentImpl elements with the entry contents, an empty list if none.
getContents()

Returns the entry contents.

public List<SyndPerson>

Returns:

the feed author, null if none.
getContributors()

Returns the feed author.

public SyndContent

Returns:

the entry description, null if none.
getDescription()

Returns the entry description.

public List<SyndEnclosure>

Returns:

a list of SyndEnclosure elements with the entry enclosures, an empty list if none.
getEnclosures()

Returns the entry enclosures.

public List<Element>

Returns:

Opaque object to discourage use
getForeignMarkup()

Returns foreign markup found at channel level.

public Module

Returns:

The module with the given URI, null if none.
getModule(String
the URI of the ModuleImpl.
uri)

Redeclares com.rometools.rome.feed.module.Extendable.getModule.

Returns the module identified by a given URI.
public List<Module>

Returns:

a list of ModuleImpl elements with the entry modules, an empty list if none.
getModules()

Redeclares com.rometools.rome.feed.module.Extendable.getModules.

Returns the entry modules.
public Date

Returns:

the entry published date, null if none.
getPublishedDate()

Returns the entry published date.

public SyndFeed

Returns:

the SyndFeed to which this entry is attributed
getSource()

Returns the entry source.

public String

Returns:

the entry title, null if none.
getTitle()

Returns the entry title.

public SyndContent

Returns:

the entry title, null if none.
getTitleEx()

Returns the entry title as a text construct.

public Date

Returns:

the entry updated date, null if none.
getUpdatedDate()

Returns the entry updated date.

public String

Returns:

the entry URI, null if none.
getUri()

Returns the entry URI.

public Object

Returns:

the WireFeed Item or Entry this Entry is generated from, or null
getWireEntry()

Return the original item this SyndEntry is generated from.

public void
setAuthor(String
the feed author to set, null if none.
author)

Sets the entry author.

public void
setAuthors(List<SyndPerson>
the feed authors to set, null if none.
authors)

Sets the entry authors.

public void
setCategories(List<SyndCategory>
the list of SyndCategoryImpl elements with the entry categories to set, an empty list or null if none.
categories)

Sets the entry categories.

public void
setComments(String
URL
comments)

URL of a page for comments relating to the item.

public void
setContents(List<SyndContent>
the list of SyndContentImpl elements with the entry contents to set, an empty list or null if none.
contents)

Sets the entry contents.

public void
setContributors(List<SyndPerson>
the feed contributors to set, null if none.
contributors)

Sets the feed contributors.

public void
setDescription(SyndContent
the entry description to set, null if none.
description)

Sets the entry description.

public void
setEnclosures(List<SyndEnclosure>
the list of SyndEnclosure elements with the entry enclosures to set, an empty list or null if none.
enclosures)

Sets the entry enclosures.

public void
setForeignMarkup(List<Element>
Opaque object to discourage use
foreignMarkup)

Sets foreign markup found at channel level.

public void
setModules(List<Module>
the list of ModuleImpl elements with the entry modules to set, an empty list or null if none.
modules)

Redeclares com.rometools.rome.feed.module.Extendable.setModules.

Sets the entry modules.
public void
setPublishedDate(Date
the entry published date to set, null if none.
publishedDate)

Sets the entry published date.

public void
setSource(SyndFeed
the original SyndFeed that contained this article
source)

Sets the entry source feed (for use if different from containing feed)

public void
setTitle(String
the entry title to set, null if none.
title)

Sets the entry title.

public void
setTitleEx(SyndContent
the entry title to set, null if none.
title)

Sets the entry title as a text construct.

public void
setUpdatedDate(Date
the entry updated date to set, null if none.
updatedDate)

Sets the entry updated date.

public void
setUri(String
the entry URI to set, null if none.
uri)

Sets the entry URI.

Inherited from com.rometools.rome.feed.CopyFrom:
copyFromgetInterface

Method Detail

cloneback to summary
public Object clone() throws CloneNotSupportedException

Creates a deep clone of the object.

Returns:Object

a clone of the object.

Exceptions
CloneNotSupportedException:
thrown if an element of the object cannot be cloned.
findRelatedLinkback to summary
public SyndLink findRelatedLink(String relation)

Returns the first instance of a SyndLink with the specified relation, or null

getAuthorback to summary
public 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.

Returns:String

the feed author, empty string if none.

getAuthorsback to summary
public List<SyndPerson> getAuthors()

Returns the entry authors.

For Atom feeds, this returns the authors as a list of SyndPerson objects.

Returns:List<SyndPerson>

the feed authors, empty list if none.

getCategoriesback to summary
public List<SyndCategory> getCategories()

Returns the entry categories.

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

Returns:List<SyndCategory>

a list of SyndCategoryImpl elements with the entry categories, an empty list if none.

getCommentsback to summary
public String getComments()

URL of a page for comments relating to the item.

Returns:String

comments URL or null.

Since
2.0.0
getContentsback to summary
public List<SyndContent> getContents()

Returns the entry contents.

Returns:List<SyndContent>

a list of SyndContentImpl elements with the entry contents, an empty list if none.

getContributorsback to summary
public List<SyndPerson> getContributors()

Returns the feed author.

For Atom feeds, this returns the contributors as a list of SyndPerson objects

Returns:List<SyndPerson>

the feed author, null if none.

getDescriptionback to summary
public SyndContent getDescription()

Returns the entry description.

Returns:SyndContent

the entry description, null if none.

getEnclosuresback to summary
public List<SyndEnclosure> getEnclosures()

Returns the entry enclosures.

Returns:List<SyndEnclosure>

a list of SyndEnclosure elements with the entry enclosures, an empty list if none.

getForeignMarkupback to summary
public List<Element> getForeignMarkup()

Returns foreign markup found at channel level.

Returns:List<Element>

Opaque object to discourage use

getLinkback to summary
public String getLink()

Returns the entry link.

Returns:String

the entry link, null if none.

getLinksback to summary
public List<SyndLink> getLinks()

Returns the entry links

Returns:List<SyndLink>

the entry links, null if none.

getModuleback to summary
public Module getModule(String uri)

Redeclares com.rometools.rome.feed.module.Extendable.getModule.

Returns the module identified by a given URI.

Parameters
uri:String

the URI of the ModuleImpl.

Returns:Module

The module with the given URI, null if none.

Annotations
@Override
getModulesback to summary
public List<Module> getModules()

Redeclares com.rometools.rome.feed.module.Extendable.getModules.

Returns the entry modules.

Returns:List<Module>

a list of ModuleImpl elements with the entry modules, an empty list if none.

Annotations
@Override
getPublishedDateback to summary
public Date getPublishedDate()

Returns the entry published date.

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

Returns:Date

the entry published date, null if none.

getSourceback to summary
public SyndFeed getSource()

Returns the entry source.

This returns the entry source as a SyndFeed

Returns:SyndFeed

the SyndFeed to which this entry is attributed

getTitleback to summary
public String getTitle()

Returns the entry title.

Returns:String

the entry title, null if none.

getTitleExback to summary
public SyndContent getTitleEx()

Returns the entry title as a text construct.

Returns:SyndContent

the entry title, null if none.

getUpdatedDateback to summary
public Date getUpdatedDate()

Returns the entry updated date.

Returns:Date

the entry updated date, null if none.

getUriback to summary
public 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.

Returns:String

the entry URI, null if none.

getWireEntryback to summary
public Object getWireEntry()

Return the original item this SyndEntry is generated from. The type of the object returned depends on the original type of the feed. Atom 0.3/1.0 will return com.rometools.rome.feed.atom.Entry, while RSS will return com.rometools.rome.feed.rss.Item.java. If this entry was not generated from a WireFeed, or the SyndFeed was not set to preserve the WireFeed then it will return null

Returns:Object

the WireFeed Item or Entry this Entry is generated from, or null

setAuthorback to summary
public void setAuthor(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.

Parameters
author:String

the feed author to set, null if none.

setAuthorsback to summary
public void setAuthors(List<SyndPerson> authors)

Sets the entry authors.

For Atom feeds, this sets the authors as a list of SyndPerson objects.

Parameters
authors:List<SyndPerson>

the feed authors to set, null if none.

setCategoriesback to summary
public void setCategories(List<SyndCategory> categories)

Sets the entry categories.

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

Parameters
categories:List<SyndCategory>

the list of SyndCategoryImpl elements with the entry categories to set, an empty list or null if none.

setCommentsback to summary
public void setComments(String comments)

URL of a page for comments relating to the item.

Parameters
comments:String

URL

Since
2.0.0
setContentsback to summary
public void setContents(List<SyndContent> contents)

Sets the entry contents.

Parameters
contents:List<SyndContent>

the list of SyndContentImpl elements with the entry contents to set, an empty list or null if none.

setContributorsback to summary
public void setContributors(List<SyndPerson> contributors)

Sets the feed contributors.

Returns contributors as a list of SyndPerson objects.

Parameters
contributors:List<SyndPerson>

the feed contributors to set, null if none.

setDescriptionback to summary
public void setDescription(SyndContent description)

Sets the entry description.

Parameters
description:SyndContent

the entry description to set, null if none.

setEnclosuresback to summary
public void setEnclosures(List<SyndEnclosure> enclosures)

Sets the entry enclosures.

Parameters
enclosures:List<SyndEnclosure>

the list of SyndEnclosure elements with the entry enclosures to set, an empty list or null if none.

setForeignMarkupback to summary
public void setForeignMarkup(List<Element> foreignMarkup)

Sets foreign markup found at channel level.

Parameters
foreignMarkup:List<Element>

Opaque object to discourage use

setLinkback to summary
public void setLink(String link)

Sets the entry link.

Parameters
link:String

the entry link to set, null if none.

setLinksback to summary
public void setLinks(List<SyndLink> links)

Sets the entry links.

Parameters
links:List<SyndLink>

the entry links to set, null if none.

setModulesback to summary
public void setModules(List<Module> modules)

Redeclares com.rometools.rome.feed.module.Extendable.setModules.

Sets the entry modules.

Parameters
modules:List<Module>

the list of ModuleImpl elements with the entry modules to set, an empty list or null if none.

Annotations
@Override
setPublishedDateback to summary
public void setPublishedDate(Date publishedDate)

Sets the entry published date.

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

Parameters
publishedDate:Date

the entry published date to set, null if none.

setSourceback to summary
public void setSource(SyndFeed source)

Sets the entry source feed (for use if different from containing feed)

Parameters
source:SyndFeed

the original SyndFeed that contained this article

setTitleback to summary
public void setTitle(String title)

Sets the entry title.

Parameters
title:String

the entry title to set, null if none.

setTitleExback to summary
public void setTitleEx(SyndContent title)

Sets the entry title as a text construct.

Parameters
title:SyndContent

the entry title to set, null if none.

setUpdatedDateback to summary
public void setUpdatedDate(Date updatedDate)

Sets the entry updated date.

Parameters
updatedDate:Date

the entry updated date to set, null if none.

setUriback to summary
public void setUri(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.

Parameters
uri:String

the entry URI to set, null if none.