com.sun.syndication.feed.atom

Class Entry

public class Entry extends Object implements Cloneable, Serializable, Extendable

Bean for entry elements of Atom feeds.

Author: Alejandro Abdelnur Dave Johnson (updated for Atom 1.0)

Field Summary
List	_alternateLinks
List	_authors
List	_categories
List	_contents
List	_contributors
Date	_created
List	_foreignMarkup
String	_id
List	_modules
ObjectBean	_objBean
List	_otherLinks
Date	_published
String	_rights
Feed	_source
Content	_summary
Content	_title
Date	_updated
String	_xmlBase

Constructor Summary
	Entry() Default constructor.

Method Summary
Object	clone() Creates a deep 'bean' clone of the object.
boolean	equals(Object other) Indicates whether some other object is "equal to" this one as defined by the Object equals() method.
List	getAlternateLinks() Returns the entry alternate links.
List	getAuthors() Returns the entry author.
List	getCategories() Returns the categories
List	getContents() Returns the entry contents.
List	getContributors() Returns the entry contributors.
Date	getCreated() Returns the entry created date (Atom 0.3 only)
Object	getForeignMarkup() Returns foreign markup found at entry level.
String	getId() Returns the entry ID.
Date	getIssued() Returns the entry issued date (Atom 0.3, maps to `getPublished()`).
Date	getModified() Returns the entry modified date (Atom 0.3, maps to `getUpdated()`).
Module	getModule(String uri) Returns the module identified by a given URI.
List	getModules() Returns the entry modules.
List	getOtherLinks() Returns the entry non-alternate links.
Date	getPublished() Returns the published
String	getRights() Returns the rights
Feed	getSource() Returns the source
Content	getSummary() Returns the entry summary.
String	getTitle() Returns the entry title.
Content	getTitleEx() Returns the entry title as a text construct.
Date	getUpdated() Returns the updated
String	getXmlBase() Returns the xmlBase
int	hashCode() Returns a hashcode value for the object.
void	setAlternateLinks(List alternateLinks) Sets the entry alternate links.
void	setAuthors(List authors) Sets the author of the entry.
void	setCategories(List categories) Set the categories
void	setContents(List contents) Sets the entry contents.
void	setContributors(List contributors) Sets the entry contributors.
void	setCreated(Date created) Sets the entry created date (Atom 0.3 only)
void	setForeignMarkup(Object foreignMarkup) Sets foreign markup found at entry level.
void	setId(String id) Sets the entry ID.
void	setIssued(Date issued) Sets the entry issued date (Atom 0.3, maps to `setPublished()`).
void	setModified(Date modified) Sets the entry modified date (Atom 0.3, maps to `setUpdated()`).
void	setModules(List modules) Sets the entry modules.
void	setOtherLinks(List otherLinks) Sets the entry non-alternate links.
void	setPublished(Date published) Set the published
void	setRights(String rights) Set the rights
void	setSource(Feed source) Set the source
void	setSummary(Content summary) Sets the entry summary.
void	setTitle(String title) Sets the entry title.
void	setTitleEx(Content title) Sets the entry title as a text construct.
void	setUpdated(Date updated) Set the updated
void	setXmlBase(String xmlBase) Set the xmlBase
String	toString() Returns the String representation for the object.

Field Detail

_alternateLinks

private List _alternateLinks

_authors

private List _authors

_categories

private List _categories

_contents

private List _contents

_contributors

private List _contributors

_created

private Date _created

_foreignMarkup

private List _foreignMarkup

_id

private String _id

_modules

private List _modules

_objBean

private ObjectBean _objBean

_otherLinks

private List _otherLinks

_published

private Date _published

_rights

private String _rights

_source

private Feed _source

_summary

private Content _summary

_title

private Content _title

_updated

private Date _updated

_xmlBase

private String _xmlBase

Constructor Detail

Entry

public Entry()

Default constructor. All properties are set to null.

Method Detail

clone

public Object clone()

Creates a deep 'bean' clone of the object.

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.

Parameters: other he reference object with which to compare.

Returns: true if 'this' object is equal to the 'other' object.

getAlternateLinks

public List getAlternateLinks()

Returns the entry alternate links.

Returns: a list of Link elements with the entry alternate links, an empty list if none.

getAuthors

public List getAuthors()

Returns the entry author.

Returns: the entry author, null if none.

getCategories

public List getCategories()

Returns the categories

Returns: Returns the categories.

Since: Atom 1.0

getContents

public List getContents()

Returns the entry contents.

Returns: a list of Content elements with the entry contents, an empty list if none.

getContributors

public List getContributors()

Returns the entry contributors.

Returns: a list of Person elements with the entry contributors, an empty list if none.

getCreated

public Date getCreated()

Returns the entry created date (Atom 0.3 only)

Returns: the entry created date, null if none.

getForeignMarkup

public Object getForeignMarkup()

Returns foreign markup found at entry level.

Returns: list of Opaque object to discourage use

getId

public String getId()

Returns the entry ID.

Returns: the entry ID, null if none.

getIssued

public Date getIssued()

Returns the entry issued date (Atom 0.3, maps to getPublished()).

Returns: the entry issued date, null if none.

getModified

public Date getModified()

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

Returns: the entry modified date, null if none.

getModule

public Module getModule(String uri)

Returns the module identified by a given URI.

Parameters: uri the URI of the ModuleImpl.

Returns: The module with the given URI, null if none.

getModules

public List getModules()

Returns the entry modules.

Returns: a list of ModuleImpl elements with the entry modules, an emtpy list if none.

getOtherLinks

public List 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.

getPublished

public Date getPublished()

Returns the published

Returns: Returns the published.

Since: Atom 1.0

getRights

public String getRights()

Returns the rights

Returns: Returns the rights.

Since: Atom 1.0

getSource

public Feed getSource()

Returns the source

Returns: Returns the source.

getSummary

public Content getSummary()

Returns the entry summary.

Returns: the entry summary, null if none.

getTitle

public String getTitle()

Returns the entry title.

Returns: 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.

getUpdated

public Date getUpdated()

Returns the updated

Returns: Returns the updated.

Since: Atom 1.0

getXmlBase

public String getXmlBase()

Returns the xmlBase

Returns: Returns the xmlBase.

Since: Atom 1.0

hashCode

public int hashCode()

Returns a hashcode value for the object.

It follows the contract defined by the Object hashCode() method.

Returns: the hashcode of the bean object.

setAlternateLinks

public void setAlternateLinks(List 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.

setAuthors

public void setAuthors(List authors)

Sets the author of the entry.

Parameters: author the author of the entry, null if none.

setCategories

public void setCategories(List categories)

Set the categories

Parameters: categories The categories to set.

Since: Atom 1.0

setContents

public void setContents(List 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.

setContributors

public void setContributors(List 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.

setCreated

public void setCreated(Date created)

Sets the entry created date (Atom 0.3 only)

Parameters: created the entry created date, null if none.

setForeignMarkup

public void setForeignMarkup(Object foreignMarkup)

Sets foreign markup found at entry level.

Parameters: foreignMarkup Opaque object to discourage use

setId

public void setId(String id)

Sets the entry ID.

Parameters: id the entry ID, null if none.

setIssued

public void setIssued(Date issued)

Sets the entry issued date (Atom 0.3, maps to setPublished()).

Parameters: issued the entry issued date, null if none.

setModified

public void setModified(Date modified)

Sets the entry modified date (Atom 0.3, maps to setUpdated()).

Parameters: modified the entry modified date, null if none.

setModules

public void setModules(List modules)

Sets the entry modules.

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

setOtherLinks

public void setOtherLinks(List 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.

setPublished

public void setPublished(Date published)

Set the published

Parameters: published The published to set.

Since: Atom 1.0

setRights

public void setRights(String rights)

Set the rights

Parameters: rights The rights to set.

Since: Atom 1.0

setSource

public void setSource(Feed source)

Set the source

Parameters: source The source to set.

setSummary

public void setSummary(Content summary)

Sets the entry summary.

Parameters: summary the entry summary, null if none.

setTitle

public void setTitle(String title)

Sets the entry title.

Parameters: title 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.

setUpdated

public void setUpdated(Date updated)

Set the updated

Parameters: updated The updated to set.

Since: Atom 1.0

setXmlBase

public void setXmlBase(String xmlBase)

Set the xmlBase

Parameters: xmlBase The xmlBase to set.

Since: Atom 1.0

toString

public String toString()

Returns the String representation for the object.

Returns: String representation for the object.