Package com.rometools.rome.feed.atom
Class Entry
- java.lang.Object
-
- com.rometools.rome.feed.atom.Entry
-
- All Implemented Interfaces:
Extendable,Serializable,Cloneable
public class Entry extends Object implements Cloneable, Serializable, Extendable
Bean for entry elements of Atom feeds.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Entry()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Objectclone()Creates a deep 'bean' clone of the object.booleanequals(Object other)Indicates whether some other object is "equal to" this one as defined by the Object equals() method.LinkfindRelatedLink(String relation)List<Link>getAlternateLinks()Returns the entry alternate links.List<SyndPerson>getAuthors()Returns the entry author.List<Category>getCategories()Returns the categoriesList<Content>getContents()Returns the entry contents.List<SyndPerson>getContributors()Returns the entry contributors.DategetCreated()Returns the entry created date (Atom 0.3 only)List<org.jdom2.Element>getForeignMarkup()Returns foreign markup found at entry level.StringgetId()Returns the entry ID.DategetIssued()Returns the entry issued date (Atom 0.3, maps togetPublished()).DategetModified()Returns the entry modified date (Atom 0.3, maps togetUpdated()).ModulegetModule(String uri)Returns the module identified by a given URI.List<Module>getModules()Returns the entry modules.List<Link>getOtherLinks()Returns the entry non-alternate links.DategetPublished()Returns the publishedStringgetRights()Returns the rightsFeedgetSource()Returns the sourceContentgetSummary()Returns the entry summary.StringgetTitle()Returns the entry title.ContentgetTitleEx()Returns the entry title as a text construct.DategetUpdated()Returns the updatedStringgetXmlBase()Returns the xmlBaseinthashCode()Returns a hashcode value for the object.booleanisMediaEntry()Returns true if entry is a media entry, i.e. has rel="edit-media".voidsetAlternateLinks(List<Link> alternateLinks)Sets the entry alternate links.voidsetAuthors(List<SyndPerson> authors)Sets the author of the entry.voidsetCategories(List<Category> categories)Set the categoriesvoidsetContents(List<Content> contents)Sets the entry contents.voidsetContributors(List<SyndPerson> contributors)Sets the entry contributors.voidsetCreated(Date created)Sets the entry created date (Atom 0.3 only)voidsetForeignMarkup(List<org.jdom2.Element> foreignMarkup)Sets foreign markup found at entry level.voidsetId(String id)Sets the entry ID.voidsetIssued(Date issued)Sets the entry issued date (Atom 0.3, maps tosetPublished(java.util.Date)).voidsetModified(Date modified)Sets the entry modified date (Atom 0.3, maps tosetUpdated(java.util.Date)).voidsetModules(List<Module> modules)Sets the entry modules.voidsetOtherLinks(List<Link> otherLinks)Sets the entry non-alternate links.voidsetPublished(Date published)Set the publishedvoidsetRights(String rights)Set the rightsvoidsetSource(Feed source)Set the sourcevoidsetSummary(Content summary)Sets the entry summary.voidsetTitle(String title)Sets the entry title.voidsetTitleEx(Content title)Sets the entry title as a text construct.voidsetUpdated(Date updated)Set the updatedvoidsetXmlBase(String xmlBase)Set the xmlBaseStringtoString()Returns the String representation for the object.
-
-
-
Method Detail
-
setAlternateLinks
public void setAlternateLinks(List<Link> alternateLinks)
Sets the entry alternate links.- Parameters:
alternateLinks- the list of Link elements with the entry alternate links to set, an empty list or null if none.
-
getAlternateLinks
public List<Link> getAlternateLinks()
Returns the entry alternate links.- Returns:
- a list of Link elements with the entry alternate links, an empty list if none.
-
setAuthors
public void setAuthors(List<SyndPerson> authors)
Sets the author of the entry.- Parameters:
authors- the author of the entry, null if none.
-
getAuthors
public List<SyndPerson> getAuthors()
Returns the entry author.- Returns:
- the entry author, null if none.
-
setCategories
public void setCategories(List<Category> categories)
Set the categories- Parameters:
categories- The categories to set.- Since:
- Atom 1.0
-
getCategories
public List<Category> getCategories()
Returns the categories- Returns:
- Returns the categories.
- Since:
- Atom 1.0
-
setContents
public void setContents(List<Content> contents)
Sets the entry contents.- Parameters:
contents- the list of Content elements with the entry contents to set, an empty list or null if none.
-
getContents
public List<Content> getContents()
Returns the entry contents.- Returns:
- a list of Content elements with the entry contents, an empty list if none.
-
setContributors
public void setContributors(List<SyndPerson> contributors)
Sets the entry contributors.- Parameters:
contributors- the list of Person elements with the entry contributors to set, an empty list or null if none.
-
getContributors
public List<SyndPerson> getContributors()
Returns the entry contributors.- Returns:
- a list of Person elements with the entry contributors, an empty list if none.
-
setCreated
public void setCreated(Date created)
Sets the entry created date (Atom 0.3 only)- Parameters:
created- the entry created date, null if none.
-
getCreated
public Date getCreated()
Returns the entry created date (Atom 0.3 only)- Returns:
- the entry created date, null if none.
-
setForeignMarkup
public void setForeignMarkup(List<org.jdom2.Element> foreignMarkup)
Sets foreign markup found at entry level.- Parameters:
foreignMarkup- Opaque object to discourage use
-
getForeignMarkup
public List<org.jdom2.Element> getForeignMarkup()
Returns foreign markup found at entry level.- Returns:
- list of Opaque object to discourage use
-
setId
public void setId(String id)
Sets the entry ID.- Parameters:
id- the entry ID, null if none.
-
getId
public String getId()
Returns the entry ID.- Returns:
- the entry ID, null if none.
-
setIssued
public void setIssued(Date issued)
Sets the entry issued date (Atom 0.3, maps tosetPublished(java.util.Date)).- Parameters:
issued- the entry issued date, null if none.
-
getIssued
public Date getIssued()
Returns the entry issued date (Atom 0.3, maps togetPublished()).- Returns:
- the entry issued date, null if none.
-
isMediaEntry
public boolean isMediaEntry()
Returns true if entry is a media entry, i.e. has rel="edit-media".- Returns:
- true if entry is a media entry
-
setModified
public void setModified(Date modified)
Sets the entry modified date (Atom 0.3, maps tosetUpdated(java.util.Date)).- Parameters:
modified- the entry modified date, null if none.
-
getModified
public Date getModified()
Returns the entry modified date (Atom 0.3, maps togetUpdated()).- Returns:
- the entry modified date, null if none.
-
getModule
public Module getModule(String uri)
Returns the module identified by a given URI.- Specified by:
getModulein interfaceExtendable- Parameters:
uri- the URI of the ModuleImpl.- Returns:
- The module with the given URI, null if none.
-
setModules
public void setModules(List<Module> modules)
Sets the entry modules.- Specified by:
setModulesin interfaceExtendable- Parameters:
modules- the list of ModuleImpl elements with the entry modules to set, an empty list or null if none.
-
getModules
public List<Module> getModules()
Returns the entry modules.- Specified by:
getModulesin interfaceExtendable- Returns:
- a list of ModuleImpl elements with the entry modules, an emtpy list if none.
-
setOtherLinks
public void setOtherLinks(List<Link> otherLinks)
Sets the entry non-alternate links.- Parameters:
otherLinks- the list Link elements with the entry non-alternate links to set, an empty list or null if none.
-
getOtherLinks
public List<Link> getOtherLinks()
Returns the entry non-alternate links.- Returns:
- the list of Link elements with the entry non-alternate links to set, an empty list if none.
-
setPublished
public void setPublished(Date published)
Set the published- Parameters:
published- The published to set.- Since:
- Atom 1.0
-
getPublished
public Date getPublished()
Returns the published- Returns:
- Returns the published.
- Since:
- Atom 1.0
-
setRights
public void setRights(String rights)
Set the rights- Parameters:
rights- The rights to set.- Since:
- Atom 1.0
-
getRights
public String getRights()
Returns the rights- Returns:
- Returns the rights.
- Since:
- Atom 1.0
-
setSource
public void setSource(Feed source)
Set the source- Parameters:
source- The source to set.
-
getSource
public Feed getSource()
Returns the source- Returns:
- Returns the source.
-
setSummary
public void setSummary(Content summary)
Sets the entry summary.- Parameters:
summary- the entry summary, null if none.
-
getSummary
public Content getSummary()
Returns the entry summary.- Returns:
- the entry summary, null if none.
-
setTitle
public void setTitle(String title)
Sets the entry title.- Parameters:
title- the entry title, null if none.
-
getTitle
public String getTitle()
Returns the entry title.- Returns:
- the entry title, null if none.
-
setTitleEx
public void setTitleEx(Content title)
Sets the entry title as a text construct.- Parameters:
title- the entry title, null if none.
-
getTitleEx
public Content getTitleEx()
Returns the entry title as a text construct.- Returns:
- the entry title, null if none.
-
setUpdated
public void setUpdated(Date updated)
Set the updated- Parameters:
updated- The updated to set.- Since:
- Atom 1.0
-
getUpdated
public Date getUpdated()
Returns the updated- Returns:
- Returns the updated.
- Since:
- Atom 1.0
-
setXmlBase
public void setXmlBase(String xmlBase)
Set the xmlBase- Parameters:
xmlBase- The xmlBase to set.- Since:
- Atom 1.0
-
getXmlBase
public String getXmlBase()
Returns the xmlBase- Returns:
- Returns the xmlBase.
- Since:
- Atom 1.0
-
clone
public Object clone() throws CloneNotSupportedException
Creates a deep 'bean' clone of the object.- Overrides:
clonein classObject- Returns:
- a clone of the object.
- Throws:
CloneNotSupportedException- thrown if an element of the object cannot be cloned.
-
equals
public boolean equals(Object other)
Indicates whether some other object is "equal to" this one as defined by the Object equals() method.
-
hashCode
public int hashCode()
Returns a hashcode value for the object.It follows the contract defined by the Object hashCode() method.
-
toString
public String toString()
Returns the String representation for the object.
-
-