rome 2.1.0 · com.rometools.rome.feed.atom.Feed

Modifier and Type	Field and Description
private List<Link>	alternateLinks
private List<SyndPerson>	authors
private List<Category>	categories
private List<SyndPerson>	contributors
private List<Entry>	entries
private Generator	generator
private String	icon
private String	id
private Content	info
private String	language
private String	logo
private List<Module>	modules Hides com.rometools.rome.feed.WireFeed.modules.
private List<Link>	otherLinks
private String	rights
private static final long	serialVersionUID Hides com.rometools.rome.feed.WireFeed.serialVersionUID.
private Content	subtitle
private Content	title
private Date	updated
private String	xmlBase

Access	Constructor and Description
public	Feed() Default constructor, for bean cloning purposes only.
public	Feed(final String the type of the Atom feed. type) Feed Constructor.

Method Summary

Modifier and Type	Method and Description
public List<Link>	Returns: a list of Link elements with the feed alternate links, an empty list if none. getAlternateLinks() Returns the feed alternate links.
public List<SyndPerson>	Returns: the feed author, null if none. getAuthors() Returns the feed author.
public List<Category>	Returns: Returns the categories. getCategories() Returns the categories
public List<SyndPerson>	Returns: a list of Person elements with the feed contributors, an empty list if none. getContributors() Returns the feed contributors.
public String	Returns: the feed copyright, null if none. getCopyright() Returns the feed copyright (Atom 0.3, maps to `getRights()`).
public List<Entry>	Returns: a list of Entry elements with the feed entries, an empty list if none. getEntries() Returns the feed entries.
public Generator	Returns: the feed generator, null if none. getGenerator() Returns the feed generator.
public String	Returns: Returns the icon. getIcon() Returns the icon
public String	Returns: the feed ID, null if none. getId() Returns the feed ID.
public Content	Returns: the feed info, null if none. getInfo() Returns the feed info (Atom 0.3 only)
public String	Returns: the feed language, null if none. getLanguage() Returns the feed language (Atom 0.3 only)
public String	Returns: Returns the logo. getLogo() Returns the logo
public Date	Returns: the feed modified date, null if none. getModified() Returns the feed modified date (Atom 0.3, maps to `getUpdated()`).
public Module	Returns: The module with the given URI, null if none. getModule(final String the URI of the ModuleImpl. uri) Overrides com.rometools.rome.feed.WireFeed.getModule. Implements 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 feed modules, an empty list if none. getModules() Overrides com.rometools.rome.feed.WireFeed.getModules. Implements com.rometools.rome.feed.module.Extendable.getModules. Returns the feed modules.
public List<Link>	Returns: a list of Link elements with the feed other links (non-alternate ones), an empty list if none. getOtherLinks() Returns the feed other links (non-alternate ones).
public String	Returns: Returns the rights. getRights() Returns the rights
public Content	Returns: Returns the subtitle. getSubtitle() Returns the subtitle
public Content	Returns: the feed tag line, null if none. getTagline() Returns the feed tag line (Atom 0.3, maps to `getSubtitle()`).
public String	Returns: the feed title, null if none. getTitle() Returns the feed title.
public Content	Returns: the feed title, null if none. getTitleEx() Returns the feed title.
public Date	Returns: Returns the updated. getUpdated() Returns the updated
public String	Returns: Returns the xmlBase. getXmlBase() Returns the xmlBase
public void	setAlternateLinks(final List<Link> the list of Link elements with the feed alternate links to set, an empty list or null if none. alternateLinks) Sets the feed alternate links.
public void	setAuthors(final List<SyndPerson> the feed author to set, null if none. authors) Sets the feed author.
public void	setCategories(final List<Category> The categories to set. categories) Set the categories
public void	setContributors(final List<SyndPerson> the list of Person elements with the feed contributors to set, an empty list or null if none. contributors) Sets the feed contributors.
public void	setCopyright(final String the feed copyright to set, null if none. copyright) Sets the feed copyright (Atom 0.3, maps to `setRights(java.lang.String)`).
public void	setEntries(final List<Entry> the list of Entry elements with the feed entries to set, an empty list or null if none. entries) Sets the feed entries.
public void	setGenerator(final Generator the feed generator to set, null if none. generator) Sets the feed generator.
public void	setIcon(final String The icon to set. icon) Set the icon
public void	setId(final String the feed ID to set, null if none. id) Sets the feed ID.
public void	setInfo(final Content the feed info to set, null if none. info) Sets the feed info (Atom 0.3 only)
public void	setLanguage(final String the feed language to set, null if none. language) Sets the feed language (Atom 0.3 only)
public void	setLogo(final String The logo to set. logo) Set the logo
public void	setModified(final Date the feed modified date to set, null if none. modified) Sets the feed modified date (Atom 0.3, maps to `setUpdated(java.util.Date)`).
public void	setModules(final List<Module> the list of ModuleImpl elements with the feed moduless to set, an empty list or null if none. modules) Overrides com.rometools.rome.feed.WireFeed.setModules. Implements com.rometools.rome.feed.module.Extendable.setModules. Sets the feed moduless.
public void	setOtherLinks(final List<Link> the list of Link elements with the feed other links (non-alternate ones) to set, an empty list or null if none. otherLinks) Sets the feed other links (non-alternate ones).
public void	setRights(final String The rights to set. rights) Set the rights
public void	setSubtitle(final Content The subtitle to set. subtitle) Set the subtitle
public void	setTagline(final Content the feed tagline to set, null if none. tagline) Sets the feed tagline (Atom 0.3, maps to `setSubtitle(com.rometools.rome.feed.atom.Content)`).
public void	setTitle(final String the feed title to set, null if none. title) Sets the feed title.
public void	setTitleEx(final Content the feed title to set, null if none. title) Sets the feed title.
public void	setUpdated(final Date The updated to set. updated) Set the updated
public void	setXmlBase(final String The xmlBase to set. xmlBase) Set the xmlBase

Inherited from com.rometools.rome.feed.WireFeed:: clone equals getEncoding getFeedType getForeignMarkup getStyleSheet hashCode setEncoding setFeedType setForeignMarkup setStyleSheet toString

alternateLinks	back to summary
private List<Link> alternateLinks

authors	back to summary
private List<SyndPerson> authors

categories	back to summary
private List<Category> categories

contributors	back to summary
private List<SyndPerson> contributors

entries	back to summary
private List<Entry> entries

generator	back to summary
private Generator generator

icon	back to summary
private String icon

id	back to summary
private String id

info	back to summary
private Content info

language	back to summary
private String language

logo	back to summary
private String logo

modules	back to summary
private List<Module> modules Hides com.rometools.rome.feed.WireFeed.modules.

otherLinks	back to summary
private List<Link> otherLinks

rights	back to summary
private String rights

serialVersionUID	back to summary
private static final long serialVersionUID Hides com.rometools.rome.feed.WireFeed.serialVersionUID.

subtitle	back to summary
private Content subtitle

title	back to summary
private Content title

updated	back to summary
private Date updated

xmlBase	back to summary
private String xmlBase

Feed	back to summary
public Feed() Default constructor, for bean cloning purposes only.

Feed	back to summary
public Feed(final String type) Feed Constructor. All properties, except the type, are set to null. Parameters type:String the type of the Atom feed.

Method Detail

getAlternateLinks	back to summary
public List<Link> getAlternateLinks() Returns the feed alternate links. Returns:List<Link> a list of Link elements with the feed alternate links, an empty list if none.

getAlternateLinks

back to summary

public List<Link> getAlternateLinks()

Returns the feed alternate links.

Returns:List<Link>: a list of Link elements with the feed alternate links, an empty list if none.

getAuthors	back to summary
public List<SyndPerson> getAuthors() Returns the feed author. Returns:List<SyndPerson> the feed author, null if none.

getAuthors

back to summary

public List<SyndPerson> getAuthors()

Returns the feed author.

Returns:List<SyndPerson>: the feed author, null if none.

getCategories	back to summary
public List<Category> getCategories() Returns the categories Returns:List<Category> Returns the categories. Since Atom 1.0

getCategories

back to summary

public List<Category> getCategories()

Returns the categories

Returns:List<Category>: Returns the categories.
Since: Atom 1.0

getContributors	back to summary
public List<SyndPerson> getContributors() Returns the feed contributors. Returns:List<SyndPerson> a list of Person elements with the feed contributors, an empty list if none.

getContributors

back to summary

public List<SyndPerson> getContributors()

Returns the feed contributors.

Returns:List<SyndPerson>: a list of Person elements with the feed contributors, an empty list if none.

getCopyright back to summary

getCopyright	back to summary
public String getCopyright() Returns the feed copyright (Atom 0.3, maps to `getRights()`). Returns:String the feed copyright, null if none.

public String getCopyright()

Returns the feed copyright (Atom 0.3, maps to getRights()).

Returns:String: the feed copyright, null if none.

getEntries	back to summary
public List<Entry> getEntries() Returns the feed entries. Returns:List<Entry> a list of Entry elements with the feed entries, an empty list if none.

getEntries

back to summary

public List<Entry> getEntries()

Returns the feed entries.

Returns:List<Entry>: a list of Entry elements with the feed entries, an empty list if none.

getGenerator	back to summary
public Generator getGenerator() Returns the feed generator. Returns:Generator the feed generator, null if none.

getGenerator

back to summary

public Generator getGenerator()

Returns the feed generator.

Returns:Generator: the feed generator, null if none.

getIcon	back to summary
public String getIcon() Returns the icon Returns:String Returns the icon. Since Atom 1.0

getIcon

back to summary

public String getIcon()

Returns the icon

Returns:String: Returns the icon.
Since: Atom 1.0

getId	back to summary
public String getId() Returns the feed ID. Returns:String the feed ID, null if none.

getId

back to summary

public String getId()

Returns the feed ID.

Returns:String: the feed ID, null if none.

getInfo	back to summary
public Content getInfo() Returns the feed info (Atom 0.3 only) Returns:Content the feed info, null if none.

getInfo

back to summary

public Content getInfo()

Returns the feed info (Atom 0.3 only)

Returns:Content: the feed info, null if none.

getLanguage	back to summary
public String getLanguage() Returns the feed language (Atom 0.3 only) Returns:String the feed language, null if none.

getLanguage

back to summary

public String getLanguage()

Returns the feed language (Atom 0.3 only)

Returns:String: the feed language, null if none.

getLogo	back to summary
public String getLogo() Returns the logo Returns:String Returns the logo. Since Atom 1.0

getLogo

back to summary

public String getLogo()

Returns the logo

Returns:String: Returns the logo.
Since: Atom 1.0

getModified back to summary

getModified	back to summary
public Date getModified() Returns the feed modified date (Atom 0.3, maps to `getUpdated()`). Returns:Date the feed modified date, null if none.

public Date getModified()

Returns the feed modified date (Atom 0.3, maps to getUpdated()).

Returns:Date: the feed modified date, null if none.

getModule	back to summary
public Module getModule(final String uri) Overrides com.rometools.rome.feed.WireFeed.getModule. Implements 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

getModule

back to summary

public Module getModule(final String uri)

Overrides com.rometools.rome.feed.WireFeed.getModule.

Implements 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

getModules	back to summary
public List<Module> getModules() Overrides com.rometools.rome.feed.WireFeed.getModules. Implements com.rometools.rome.feed.module.Extendable.getModules. Returns the feed modules. Returns:List<Module> a list of ModuleImpl elements with the feed modules, an empty list if none. Annotations @Override

getModules

back to summary

public List<Module> getModules()

Overrides com.rometools.rome.feed.WireFeed.getModules.

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

Returns the feed modules.

Returns:List<Module>

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

Annotations

@Override

getOtherLinks	back to summary
public List<Link> getOtherLinks() Returns the feed other links (non-alternate ones). Returns:List<Link> a list of Link elements with the feed other links (non-alternate ones), an empty list if none.

getOtherLinks

back to summary

public List<Link> getOtherLinks()

Returns the feed other links (non-alternate ones).

Returns:List<Link>: a list of Link elements with the feed other links (non-alternate ones), an empty list if none.

getRights	back to summary
public String getRights() Returns the rights Returns:String Returns the rights. Since Atom 1.0

getRights

back to summary

public String getRights()

Returns the rights

Returns:String: Returns the rights.
Since: Atom 1.0

getSubtitle	back to summary
public Content getSubtitle() Returns the subtitle Returns:Content Returns the subtitle. Since Atom 1.0

getSubtitle

back to summary

public Content getSubtitle()

Returns the subtitle

Returns:Content: Returns the subtitle.
Since: Atom 1.0

getTagline back to summary

getTagline	back to summary
public Content getTagline() Returns the feed tag line (Atom 0.3, maps to `getSubtitle()`). Returns:Content the feed tag line, null if none.

public Content getTagline()

Returns the feed tag line (Atom 0.3, maps to getSubtitle()).

Returns:Content: the feed tag line, null if none.

getTitle	back to summary
public String getTitle() Returns the feed title. Returns:String the feed title, null if none.

getTitle

back to summary

public String getTitle()

Returns the feed title.

Returns:String: the feed title, null if none.

getTitleEx	back to summary
public Content getTitleEx() Returns the feed title. Returns:Content the feed title, null if none.

getTitleEx

back to summary

public Content getTitleEx()

Returns the feed title.

Returns:Content: the feed title, null if none.

getUpdated	back to summary
public Date getUpdated() Returns the updated Returns:Date Returns the updated. Since Atom 1.0

getUpdated

back to summary

public Date getUpdated()

Returns the updated

Returns:Date: Returns the updated.
Since: Atom 1.0

getXmlBase	back to summary
public String getXmlBase() Returns the xmlBase Returns:String Returns the xmlBase. Since Atom 1.0

getXmlBase

back to summary

public String getXmlBase()

Returns the xmlBase

Returns:String: Returns the xmlBase.
Since: Atom 1.0

setAlternateLinks	back to summary
public void setAlternateLinks(final List<Link> alternateLinks) Sets the feed alternate links. Parameters alternateLinks:List<Link> the list of Link elements with the feed alternate links to set, an empty list or null if none.

setAlternateLinks

back to summary

public void setAlternateLinks(final List<Link> alternateLinks)

Sets the feed alternate links.

Parameters

alternateLinks:List<Link>: the list of Link elements with the feed alternate links to set, an empty list or null if none.

setAuthors	back to summary
public void setAuthors(final List<SyndPerson> authors) Sets the feed author. Parameters authors:List<SyndPerson> the feed author to set, null if none.

setAuthors

back to summary

public void setAuthors(final List<SyndPerson> authors)

Sets the feed author.

Parameters

authors:List<SyndPerson>: the feed author to set, null if none.

setCategories	back to summary
public void setCategories(final List<Category> categories) Set the categories Parameters categories:List<Category> The categories to set. Since Atom 1.0

setCategories

back to summary

public void setCategories(final List<Category> categories)

Set the categories

Parameters

categories:List<Category>: The categories to set.

Since

Atom 1.0

setContributors

back to summary

public void setContributors(final List<SyndPerson> contributors)

Sets the feed contributors.

Parameters

contributors:List<SyndPerson>: the list of Person elements with the feed contributors to set, an empty list or null if none.

setCopyright back to summary

public void setCopyright(final String copyright)

Sets the feed copyright (Atom 0.3, maps to setRights(java.lang.String)).

Parameters

copyright:String: the feed copyright to set, null if none.

setEntries

back to summary

public void setEntries(final List<Entry> entries)

Sets the feed entries.

Parameters

entries:List<Entry>: the list of Entry elements with the feed entries to set, an empty list or null if none.

setGenerator

back to summary

public void setGenerator(final Generator generator)

Sets the feed generator.

Parameters

generator:Generator: the feed generator to set, null if none.

setIcon

back to summary

public void setIcon(final String icon)

Set the icon

Parameters

icon:String: The icon to set.

Since

Atom 1.0

setId

back to summary

public void setId(final String id)

Sets the feed ID.

Parameters

id:String: the feed ID to set, null if none.

setInfo

back to summary

public void setInfo(final Content info)

Sets the feed info (Atom 0.3 only)

Parameters

info:Content: the feed info to set, null if none.

setLanguage

back to summary

public void setLanguage(final String language)

Sets the feed language (Atom 0.3 only)

Parameters

language:String: the feed language to set, null if none.

setLogo

back to summary

public void setLogo(final String logo)

Set the logo

Parameters

logo:String: The logo to set.

Since

Atom 1.0

setModified back to summary

public void setModified(final Date modified)

Sets the feed modified date (Atom 0.3, maps to setUpdated(java.util.Date)).

Parameters

modified:Date: the feed modified date to set, null if none.

setModules

back to summary

public void setModules(final List<Module> modules)

Overrides com.rometools.rome.feed.WireFeed.setModules.

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

Sets the feed moduless.

Parameters

modules:List<Module>: the list of ModuleImpl elements with the feed moduless to set, an empty list or null if none.

Annotations

@Override

setOtherLinks

back to summary

public void setOtherLinks(final List<Link> otherLinks)

Sets the feed other links (non-alternate ones).

Parameters

otherLinks:List<Link>: the list of Link elements with the feed other links (non-alternate ones) to set, an empty list or null if none.

setRights

back to summary

public void setRights(final String rights)

Set the rights

Parameters

rights:String: The rights to set.

Since

Atom 1.0

setSubtitle

back to summary

public void setSubtitle(final Content subtitle)

Set the subtitle

Parameters

subtitle:Content: The subtitle to set.

Since

Atom 1.0

setTagline back to summary

public void setTagline(final Content tagline)

Sets the feed tagline (Atom 0.3, maps to setSubtitle(com.rometools.rome.feed.atom.Content)).

Parameters

tagline:Content: the feed tagline to set, null if none.

setTitle

back to summary

public void setTitle(final String title)

Sets the feed title.

Parameters

title:String: the feed title to set, null if none.

setTitleEx

back to summary

public void setTitleEx(final Content title)

Sets the feed title.

Parameters

title:Content: the feed title to set, null if none.

setUpdated

back to summary

public void setUpdated(final Date updated)

Set the updated

Parameters

updated:Date: The updated to set.

Since

Atom 1.0

setXmlBase

back to summary

public void setXmlBase(final String xmlBase)

Set the xmlBase

Parameters

xmlBase:String: The xmlBase to set.

Since

Atom 1.0

public Class Feed

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail