Package com.rometools.rome.feed.atom
Class Feed
- java.lang.Object
-
- com.rometools.rome.feed.WireFeed
-
- com.rometools.rome.feed.atom.Feed
-
- All Implemented Interfaces:
Extendable,Serializable,Cloneable
public class Feed extends WireFeed
Bean for Atom feeds.- See Also:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<Link>getAlternateLinks()Returns the feed alternate links.List<SyndPerson>getAuthors()Returns the feed author.List<Category>getCategories()Returns the categoriesList<SyndPerson>getContributors()Returns the feed contributors.StringgetCopyright()Returns the feed copyright (Atom 0.3, maps togetRights()).List<Entry>getEntries()Returns the feed entries.GeneratorgetGenerator()Returns the feed generator.StringgetIcon()Returns the iconStringgetId()Returns the feed ID.ContentgetInfo()Returns the feed info (Atom 0.3 only)StringgetLanguage()Returns the feed language (Atom 0.3 only)StringgetLogo()Returns the logoDategetModified()Returns the feed modified date (Atom 0.3, maps togetUpdated()).ModulegetModule(String uri)Returns the module identified by a given URI.List<Module>getModules()Returns the feed modules.List<Link>getOtherLinks()Returns the feed other links (non-alternate ones).StringgetRights()Returns the rightsContentgetSubtitle()Returns the subtitleContentgetTagline()Returns the feed tag line (Atom 0.3, maps togetSubtitle()).StringgetTitle()Returns the feed title.ContentgetTitleEx()Returns the feed title.DategetUpdated()Returns the updatedStringgetXmlBase()Returns the xmlBasevoidsetAlternateLinks(List<Link> alternateLinks)Sets the feed alternate links.voidsetAuthors(List<SyndPerson> authors)Sets the feed author.voidsetCategories(List<Category> categories)Set the categoriesvoidsetContributors(List<SyndPerson> contributors)Sets the feed contributors.voidsetCopyright(String copyright)Sets the feed copyright (Atom 0.3, maps tosetRights(java.lang.String)).voidsetEntries(List<Entry> entries)Sets the feed entries.voidsetGenerator(Generator generator)Sets the feed generator.voidsetIcon(String icon)Set the iconvoidsetId(String id)Sets the feed ID.voidsetInfo(Content info)Sets the feed info (Atom 0.3 only)voidsetLanguage(String language)Sets the feed language (Atom 0.3 only)voidsetLogo(String logo)Set the logovoidsetModified(Date modified)Sets the feed modified date (Atom 0.3, maps tosetUpdated(java.util.Date)).voidsetModules(List<Module> modules)Sets the feed moduless.voidsetOtherLinks(List<Link> otherLinks)Sets the feed other links (non-alternate ones).voidsetRights(String rights)Set the rightsvoidsetSubtitle(Content subtitle)Set the subtitlevoidsetTagline(Content tagline)Sets the feed tagline (Atom 0.3, maps tosetSubtitle(com.rometools.rome.feed.atom.Content)).voidsetTitle(String title)Sets the feed title.voidsetTitleEx(Content title)Sets the feed title.voidsetUpdated(Date updated)Set the updatedvoidsetXmlBase(String xmlBase)Set the xmlBase-
Methods inherited from class com.rometools.rome.feed.WireFeed
clone, equals, getEncoding, getFeedType, getForeignMarkup, getStyleSheet, hashCode, setEncoding, setFeedType, setForeignMarkup, setStyleSheet, toString
-
-
-
-
Constructor Detail
-
Feed
public Feed()
Default constructor, for bean cloning purposes only.
-
Feed
public Feed(String type)
Feed Constructor. All properties, except the type, are set to null.- Parameters:
type- the type of the Atom feed.
-
-
Method Detail
-
getLanguage
public String getLanguage()
Returns the feed language (Atom 0.3 only)- Returns:
- the feed language, null if none.
-
setLanguage
public void setLanguage(String language)
Sets the feed language (Atom 0.3 only)- Parameters:
language- the feed language to set, null if none.
-
getTitle
public String getTitle()
Returns the feed title.- Returns:
- the feed title, null if none.
-
setTitle
public void setTitle(String title)
Sets the feed title.- Parameters:
title- the feed title to set, null if none.
-
getTitleEx
public Content getTitleEx()
Returns the feed title.- Returns:
- the feed title, null if none.
-
setTitleEx
public void setTitleEx(Content title)
Sets the feed title.- Parameters:
title- the feed title to set, null if none.
-
getAlternateLinks
public List<Link> getAlternateLinks()
Returns the feed alternate links.- Returns:
- a list of Link elements with the feed alternate links, an empty list if none.
-
setAlternateLinks
public void setAlternateLinks(List<Link> alternateLinks)
Sets the feed alternate links.- Parameters:
alternateLinks- the list of Link elements with the feed alternate links to set, an empty list or null if none.
-
getOtherLinks
public List<Link> getOtherLinks()
Returns the feed other links (non-alternate ones).- Returns:
- a list of Link elements with the feed other links (non-alternate ones), an empty list if none.
-
setOtherLinks
public void setOtherLinks(List<Link> otherLinks)
Sets the feed other links (non-alternate ones).- Parameters:
otherLinks- the list of Link elements with the feed other links (non-alternate ones) to set, an empty list or null if none.
-
getAuthors
public List<SyndPerson> getAuthors()
Returns the feed author.- Returns:
- the feed author, null if none.
-
setAuthors
public void setAuthors(List<SyndPerson> authors)
Sets the feed author.- Parameters:
authors- the feed author to set, null if none.
-
getContributors
public List<SyndPerson> getContributors()
Returns the feed contributors.- Returns:
- a list of Person elements with the feed contributors, an empty list if none.
-
setContributors
public void setContributors(List<SyndPerson> contributors)
Sets the feed contributors.- Parameters:
contributors- the list of Person elements with the feed contributors to set, an empty list or null if none.
-
getTagline
public Content getTagline()
Returns the feed tag line (Atom 0.3, maps togetSubtitle()).- Returns:
- the feed tag line, null if none.
-
setTagline
public void setTagline(Content tagline)
Sets the feed tagline (Atom 0.3, maps tosetSubtitle(com.rometools.rome.feed.atom.Content)).- Parameters:
tagline- the feed tagline to set, null if none.
-
getId
public String getId()
Returns the feed ID.- Returns:
- the feed ID, null if none.
-
setId
public void setId(String id)
Sets the feed ID.- Parameters:
id- the feed ID to set, null if none.
-
getGenerator
public Generator getGenerator()
Returns the feed generator.- Returns:
- the feed generator, null if none.
-
setGenerator
public void setGenerator(Generator generator)
Sets the feed generator.- Parameters:
generator- the feed generator to set, null if none.
-
getCopyright
public String getCopyright()
Returns the feed copyright (Atom 0.3, maps togetRights()).- Returns:
- the feed copyright, null if none.
-
setCopyright
public void setCopyright(String copyright)
Sets the feed copyright (Atom 0.3, maps tosetRights(java.lang.String)).- Parameters:
copyright- the feed copyright to set, null if none.
-
getInfo
public Content getInfo()
Returns the feed info (Atom 0.3 only)- Returns:
- the feed info, null if none.
-
setInfo
public void setInfo(Content info)
Sets the feed info (Atom 0.3 only)- Parameters:
info- the feed info to set, null if none.
-
getModified
public Date getModified()
Returns the feed modified date (Atom 0.3, maps togetUpdated()).- Returns:
- the feed modified date, null if none.
-
setModified
public void setModified(Date modified)
Sets the feed modified date (Atom 0.3, maps tosetUpdated(java.util.Date)).- Parameters:
modified- the feed modified date to set, null if none.
-
getEntries
public List<Entry> getEntries()
Returns the feed entries.- Returns:
- a list of Entry elements with the feed entries, an empty list if none.
-
setEntries
public void setEntries(List<Entry> entries)
Sets the feed entries.- Parameters:
entries- the list of Entry elements with the feed entries to set, an empty list or null if none.
-
getModules
public List<Module> getModules()
Returns the feed modules.- Specified by:
getModulesin interfaceExtendable- Overrides:
getModulesin classWireFeed- Returns:
- a list of ModuleImpl elements with the feed modules, an empty list if none.
-
setModules
public void setModules(List<Module> modules)
Sets the feed moduless.- Specified by:
setModulesin interfaceExtendable- Overrides:
setModulesin classWireFeed- Parameters:
modules- the list of ModuleImpl elements with the feed moduless to set, an empty list or null if none.
-
getModule
public Module getModule(String uri)
Returns the module identified by a given URI.- Specified by:
getModulein interfaceExtendable- Overrides:
getModulein classWireFeed- Parameters:
uri- the URI of the ModuleImpl.- Returns:
- The module with the given URI, null if none.
-
getCategories
public List<Category> getCategories()
Returns the categories- Returns:
- Returns the categories.
- Since:
- Atom 1.0
-
setCategories
public void setCategories(List<Category> categories)
Set the categories- Parameters:
categories- The categories to set.- Since:
- Atom 1.0
-
getIcon
public String getIcon()
Returns the icon- Returns:
- Returns the icon.
- Since:
- Atom 1.0
-
setIcon
public void setIcon(String icon)
Set the icon- Parameters:
icon- The icon to set.- Since:
- Atom 1.0
-
getLogo
public String getLogo()
Returns the logo- Returns:
- Returns the logo.
- Since:
- Atom 1.0
-
setLogo
public void setLogo(String logo)
Set the logo- Parameters:
logo- The logo to set.- Since:
- Atom 1.0
-
getRights
public String getRights()
Returns the rights- Returns:
- Returns the rights.
- Since:
- Atom 1.0
-
setRights
public void setRights(String rights)
Set the rights- Parameters:
rights- The rights to set.- Since:
- Atom 1.0
-
getSubtitle
public Content getSubtitle()
Returns the subtitle- Returns:
- Returns the subtitle.
- Since:
- Atom 1.0
-
setSubtitle
public void setSubtitle(Content subtitle)
Set the subtitle- Parameters:
subtitle- The subtitle to set.- Since:
- Atom 1.0
-
getUpdated
public Date getUpdated()
Returns the updated- Returns:
- Returns the updated.
- Since:
- Atom 1.0
-
setUpdated
public void setUpdated(Date updated)
Set the updated- Parameters:
updated- The updated to set.- Since:
- Atom 1.0
-
getXmlBase
public String getXmlBase()
Returns the xmlBase- Returns:
- Returns the xmlBase.
- Since:
- Atom 1.0
-
setXmlBase
public void setXmlBase(String xmlBase)
Set the xmlBase- Parameters:
xmlBase- The xmlBase to set.- Since:
- Atom 1.0
-
-