Top Description Fields Constructors Methods
com.rometools.rome.feed.atom

public Class Entry

extends Object
implements Cloneable, Serializable, Extendable
Class Inheritance
All Implemented Interfaces
com.rometools.rome.feed.module.Extendable, java.io.Serializable, java.lang.Cloneable
Imports
java.io.Serializable, java.util.Collections, .Date, .List, org.jdom2.Element, com.rometools.rome.feed.impl.CloneableBean, .EqualsBean, .ToStringBean, com.rometools.rome.feed.module.Extendable, .Module, com.rometools.rome.feed.module.impl.ModuleUtils, com.rometools.rome.feed.synd.SyndPerson, com.rometools.utils.Dates, .Lists
Bean for entry elements of Atom feeds.

Field Summary

Modifier and TypeField and Description
private List<Link>
alternateLinks

private List<SyndPerson>
authors

private List<Category>
categories

private List<Content>
contents

private List<SyndPerson>
contributors

private Date
created

private List<Element>
foreignMarkup

private String
id

private List<Module>
modules

private List<Link>
otherLinks

private Date
published

private String
rights

private static final long
serialVersionUID

private Feed
source

private Content
summary

private Content
title

private Date
updated

private String
xmlBase

Constructor Summary

AccessConstructor and Description
public
Entry()

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

a clone of the object.
clone()

Overrides java.lang.Object.clone.

Creates a deep 'bean' clone of the object.
public boolean

Returns:

true if 'this' object is equal to the 'other' object.
equals(final Object
he reference object with which to compare.
other)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one as defined by the Object equals() method.
public List<SyndPerson>

Returns:

the entry author, null if none.
getAuthors()

Returns the entry author.

public List<Category>

Returns:

Returns the categories.
getCategories()

Returns the categories

public List<Content>

Returns:

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

Returns the entry contents.

public List<SyndPerson>

Returns:

a list of Person elements with the entry contributors, an empty list if none.
getContributors()

Returns the entry contributors.

public Date

Returns:

the entry created date, null if none.
getCreated()

Returns the entry created date (Atom 0.3 only)

public List<Element>

Returns:

list of Opaque object to discourage use
getForeignMarkup()

Returns foreign markup found at entry level.

public String

Returns:

the entry ID, null if none.
getId()

Returns the entry ID.

public Date

Returns:

the entry issued date, null if none.
getIssued()

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

public Date

Returns:

the entry modified date, null if none.
getModified()

Returns the entry 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)

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 entry modules, an emtpy list if none.
getModules()

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

Returns the entry modules.
public Date

Returns:

Returns the published.
getPublished()

Returns the published

public String

Returns:

Returns the rights.
getRights()

Returns the rights

public Feed

Returns:

Returns the source.
getSource()

Returns the source

public Content

Returns:

the entry summary, null if none.
getSummary()

Returns the entry summary.

public String

Returns:

the entry title, null if none.
getTitle()

Returns the entry title.

public Content

Returns:

the entry title, null if none.
getTitleEx()

Returns the entry title as a text construct.

public Date

Returns:

Returns the updated.
getUpdated()

Returns the updated

public String

Returns:

Returns the xmlBase.
getXmlBase()

Returns the xmlBase

public int

Returns:

the hashcode of the bean object.
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hashcode value for the object.
public boolean

Returns:

true if entry is a media entry
isMediaEntry()

Returns true if entry is a media entry, i.e. has rel="edit-media".

public void
setAuthors(final List<SyndPerson>
the author of the entry, null if none.
authors)

Sets the author of the entry.

public void
setCategories(final List<Category>
The categories to set.
categories)

Set the categories

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

Sets the entry contents.

public void
setContributors(final List<SyndPerson>
the list of Person elements with the entry contributors to set, an empty list or null if none.
contributors)

Sets the entry contributors.

public void
setCreated(final Date
the entry created date, null if none.
created)

Sets the entry created date (Atom 0.3 only)

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

Sets foreign markup found at entry level.

public void
setId(final String
the entry ID, null if none.
id)

Sets the entry ID.

public void
setIssued(final Date
the entry issued date, null if none.
issued)

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

public void
setModified(final Date
the entry modified date, null if none.
modified)

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

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

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

Sets the entry modules.
public void
setPublished(final Date
The published to set.
published)

Set the published

public void
setRights(final String
The rights to set.
rights)

Set the rights

public void
setSource(final Feed
The source to set.
source)

Set the source

public void
setSummary(final Content
the entry summary, null if none.
summary)

Sets the entry summary.

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

Sets the entry title.

public void
setTitleEx(final Content
the entry title, null if none.
title)

Sets the entry title as a text construct.

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

public String

Returns:

String representation for the object.
toString()

Overrides java.lang.Object.toString.

Returns the String representation for the object.
Inherited from java.lang.Object:
finalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

authorsback to summary
private List<SyndPerson> authors
categoriesback to summary
private List<Category> categories
contentsback to summary
private List<Content> contents
contributorsback to summary
private List<SyndPerson> contributors
createdback to summary
private Date created
foreignMarkupback to summary
private List<Element> foreignMarkup
idback to summary
private String id
modulesback to summary
private List<Module> modules
publishedback to summary
private Date published
rightsback to summary
private String rights
serialVersionUIDback to summary
private static final long serialVersionUID
sourceback to summary
private Feed source
summaryback to summary
private Content summary
titleback to summary
private Content title
updatedback to summary
private Date updated
xmlBaseback to summary
private String xmlBase

Constructor Detail

Entryback to summary
public Entry()

Method Detail

cloneback to summary
public Object clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Creates a deep 'bean' clone of the object.

Returns:Object

a clone of the object.

Annotations
@Override
Exceptions
CloneNotSupportedException:
thrown if an element of the object cannot be cloned.
equalsback to summary
public boolean equals(final Object other)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one as defined by the Object equals() method.

Parameters
other:Object

he reference object with which to compare.

Returns:boolean

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

Annotations
@Override
findRelatedLinkback to summary
public Link findRelatedLink(final String relation)
getAlternateLinksback to summary
public List<Link> getAlternateLinks()

Returns the entry alternate links.

Returns:List<Link>

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

getAuthorsback to summary
public List<SyndPerson> getAuthors()

Returns the entry author.

Returns:List<SyndPerson>

the entry author, null if none.

getCategoriesback to summary
public List<Category> getCategories()

Returns the categories

Returns:List<Category>

Returns the categories.

Since
Atom 1.0
getContentsback to summary
public List<Content> getContents()

Returns the entry contents.

Returns:List<Content>

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

getContributorsback to summary
public List<SyndPerson> getContributors()

Returns the entry contributors.

Returns:List<SyndPerson>

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

getCreatedback to summary
public Date getCreated()

Returns the entry created date (Atom 0.3 only)

Returns:Date

the entry created date, null if none.

getForeignMarkupback to summary
public List<Element> getForeignMarkup()

Returns foreign markup found at entry level.

Returns:List<Element>

list of Opaque object to discourage use

getIdback to summary
public String getId()

Returns the entry ID.

Returns:String

the entry ID, null if none.

getIssuedback to summary
public Date getIssued()

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

Returns:Date

the entry issued date, null if none.

getModifiedback to summary
public Date getModified()

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

Returns:Date

the entry modified date, null if none.

getModuleback to summary
public Module getModule(final String uri)

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
getModulesback to summary
public List<Module> getModules()

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

Returns the entry modules.

Returns:List<Module>

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

Annotations
@Override
getOtherLinksback to summary
public List<Link> getOtherLinks()

Returns the entry non-alternate links.

Returns:List<Link>

the list of Link elements with the entry non-alternate links to set, an empty list if none.

getPublishedback to summary
public Date getPublished()

Returns the published

Returns:Date

Returns the published.

Since
Atom 1.0
getRightsback to summary
public String getRights()

Returns the rights

Returns:String

Returns the rights.

Since
Atom 1.0
getSourceback to summary
public Feed getSource()

Returns the source

Returns:Feed

Returns the source.

getSummaryback to summary
public Content getSummary()

Returns the entry summary.

Returns:Content

the entry summary, null if none.

getTitleback to summary
public String getTitle()

Returns the entry title.

Returns:String

the entry title, null if none.

getTitleExback to summary
public Content getTitleEx()

Returns the entry title as a text construct.

Returns:Content

the entry title, null if none.

getUpdatedback to summary
public Date getUpdated()

Returns the updated

Returns:Date

Returns the updated.

Since
Atom 1.0
getXmlBaseback to summary
public String getXmlBase()

Returns the xmlBase

Returns:String

Returns the xmlBase.

Since
Atom 1.0
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Returns a hashcode value for the object.

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

Returns:int

the hashcode of the bean object.

Annotations
@Override
isMediaEntryback to summary
public boolean isMediaEntry()

Returns true if entry is a media entry, i.e. has rel="edit-media".

Returns:boolean

true if entry is a media entry

setAlternateLinksback to summary
public void setAlternateLinks(final List<Link> alternateLinks)

Sets the entry alternate links.

Parameters
alternateLinks:List<Link>

the list of Link elements with the entry alternate links to set, an empty list or null if none.

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

Sets the author of the entry.

Parameters
authors:List<SyndPerson>

the author of the entry, null if none.

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

Set the categories

Parameters
categories:List<Category>

The categories to set.

Since
Atom 1.0
setContentsback to summary
public void setContents(final List<Content> contents)

Sets the entry contents.

Parameters
contents:List<Content>

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

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

Sets the entry contributors.

Parameters
contributors:List<SyndPerson>

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

setCreatedback to summary
public void setCreated(final Date created)

Sets the entry created date (Atom 0.3 only)

Parameters
created:Date

the entry created date, null if none.

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

Sets foreign markup found at entry level.

Parameters
foreignMarkup:List<Element>

Opaque object to discourage use

setIdback to summary
public void setId(final String id)

Sets the entry ID.

Parameters
id:String

the entry ID, null if none.

setIssuedback to summary
public void setIssued(final Date issued)

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

Parameters
issued:Date

the entry issued date, null if none.

setModifiedback to summary
public void setModified(final Date modified)

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

Parameters
modified:Date

the entry modified date, null if none.

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

Implements 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
setOtherLinksback to summary
public void setOtherLinks(final List<Link> otherLinks)

Sets the entry non-alternate links.

Parameters
otherLinks:List<Link>

the list Link elements with the entry non-alternate links to set, an empty list or null if none.

setPublishedback to summary
public void setPublished(final Date published)

Set the published

Parameters
published:Date

The published to set.

Since
Atom 1.0
setRightsback to summary
public void setRights(final String rights)

Set the rights

Parameters
rights:String

The rights to set.

Since
Atom 1.0
setSourceback to summary
public void setSource(final Feed source)

Set the source

Parameters
source:Feed

The source to set.

setSummaryback to summary
public void setSummary(final Content summary)

Sets the entry summary.

Parameters
summary:Content

the entry summary, null if none.

setTitleback to summary
public void setTitle(final String title)

Sets the entry title.

Parameters
title:String

the entry title, null if none.

setTitleExback to summary
public void setTitleEx(final Content title)

Sets the entry title as a text construct.

Parameters
title:Content

the entry title, null if none.

setUpdatedback to summary
public void setUpdated(final Date updated)

Set the updated

Parameters
updated:Date

The updated to set.

Since
Atom 1.0
setXmlBaseback to summary
public void setXmlBase(final String xmlBase)

Set the xmlBase

Parameters
xmlBase:String

The xmlBase to set.

Since
Atom 1.0
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Returns the String representation for the object.

Returns:String

String representation for the object.

Annotations
@Override