com.sun.syndication.feed.synd

Class SyndEntryImpl

public class SyndEntryImpl extends Object implements Serializable, SyndEntry

Bean for entries of SyndFeedImpl feeds.

Author: Alejandro Abdelnur

Field Summary
static SetCONVENIENCE_PROPERTIES
Unmodifiable Set containing the convenience properties of this class.
static CopyFromHelperCOPY_FROM_HELPER
static SetIGNORE_PROPERTIES
List_authors
List_categories
List_contents
List_contributors
SyndContent_description
List_enclosures
List_foreignMarkup
String_link
List_links
List_modules
ObjectBean_objBean
SyndContent_title
Date_updatedDate
String_uri
Constructor Summary
protected SyndEntryImpl(Class beanClass, Set convenienceProperties)
For implementations extending SyndEntryImpl to be able to use the ObjectBean functionality with extended interfaces.
SyndEntryImpl()
Default constructor.
Method Summary
Objectclone()
Creates a deep 'bean' clone of the object.
voidcopyFrom(Object obj)
booleanequals(Object other)
Indicates whether some other object is "equal to" this one as defined by the Object equals() method.
StringgetAuthor()
Returns the entry author.
ListgetAuthors()
ListgetCategories()
Returns the entry categories.
ListgetContents()
Returns the entry contents.
ListgetContributors()
DCModulegetDCModule()
Returns the Dublin Core module of the feed.
SyndContentgetDescription()
Returns the entry description.
ListgetEnclosures()
Returns the entry enclosures.
ObjectgetForeignMarkup()
Returns foreign markup found at channel level.
ClassgetInterface()
StringgetLink()
Returns the entry link.
ListgetLinks()
Returns the links

ModulegetModule(String uri)
Returns the module identified by a given URI.
ListgetModules()
Returns the entry modules.
DategetPublishedDate()
Returns the entry published date.
StringgetTitle()
Returns the entry title.
SyndContentgetTitleEx()
Returns the entry title as a text construct.
DategetUpdatedDate()
Returns the updatedDate

StringgetUri()
Returns the entry URI.
inthashCode()
Returns a hashcode value for the object.
voidsetAuthor(String author)
Sets the entry author.
voidsetAuthors(List authors)
voidsetCategories(List categories)
Sets the entry categories.
voidsetContents(List contents)
Sets the entry contents.
voidsetContributors(List contributors)
voidsetDescription(SyndContent description)
Sets the entry description.
voidsetEnclosures(List enclosures)
Sets the entry enclosures.
voidsetForeignMarkup(Object foreignMarkup)
Sets foreign markup found at channel level.
voidsetLink(String link)
Sets the entry link.
voidsetLinks(List links)
Set the links

voidsetModules(List modules)
Sets the entry modules.
voidsetPublishedDate(Date publishedDate)
Sets the entry published date.
voidsetTitle(String title)
Sets the entry title.
voidsetTitleEx(SyndContent title)
Sets the entry title as a text construct.
voidsetUpdatedDate(Date updatedDate)
Set the updatedDate

voidsetUri(String uri)
Sets the entry URI.
StringtoString()
Returns the String representation for the object.

Field Detail

CONVENIENCE_PROPERTIES

public static final Set CONVENIENCE_PROPERTIES
Unmodifiable Set containing the convenience properties of this class.

Convenience properties are mapped to Modules, for cloning the convenience properties can be ignored as the will be copied as part of the module cloning.

COPY_FROM_HELPER

private static final CopyFromHelper COPY_FROM_HELPER

IGNORE_PROPERTIES

private static final Set IGNORE_PROPERTIES

_authors

private List _authors

_categories

private List _categories

_contents

private List _contents

_contributors

private List _contributors

_description

private SyndContent _description

_enclosures

private List _enclosures

_foreignMarkup

private List _foreignMarkup

_link

private String _link

_links

private List _links

_modules

private List _modules

_objBean

private ObjectBean _objBean

_title

private SyndContent _title

_updatedDate

private Date _updatedDate

_uri

private String _uri

Constructor Detail

SyndEntryImpl

protected SyndEntryImpl(Class beanClass, Set convenienceProperties)
For implementations extending SyndEntryImpl to be able to use the ObjectBean functionality with extended interfaces.

Parameters: beanClass convenienceProperties set containing the convenience properties of the SyndEntryImpl (the are ignored during cloning, check CloneableBean for details).

SyndEntryImpl

public SyndEntryImpl()
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.

copyFrom

public void copyFrom(Object obj)

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.

getAuthor

public String getAuthor()
Returns the entry author.

This method is a convenience method, it maps to the Dublin Core module creator.

Returns: the entry author, null if none.

getAuthors

public List getAuthors()

getCategories

public List getCategories()
Returns the entry categories.

Returns: a list of SyndCategoryImpl elements with the entry categories, an empty list if none.

getContents

public List getContents()
Returns the entry contents.

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

getContributors

public List getContributors()

getDCModule

private DCModule getDCModule()
Returns the Dublin Core module of the feed.

Returns: the DC module, it's never null

getDescription

public SyndContent getDescription()
Returns the entry description.

Returns: the entry description, null if none.

getEnclosures

public List getEnclosures()
Returns the entry enclosures.

Returns: a list of SyndEnclosure elements with the entry enclosures, an empty list if none.

getForeignMarkup

public Object getForeignMarkup()
Returns foreign markup found at channel level.

Returns: list of JDOM nodes containing channel-level foreign markup, an empty list if none.

getInterface

public Class getInterface()

getLink

public String getLink()
Returns the entry link.

Returns: the entry link, null if none.

getLinks

public List getLinks()
Returns the links

Returns: Returns the links.

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 empty list if none.

getPublishedDate

public Date getPublishedDate()
Returns the entry published date.

This method is a convenience method, it maps to the Dublin Core module date.

Returns: the entry published date, null if none.

getTitle

public String getTitle()
Returns the entry title.

Returns: the entry title, null if none.

getTitleEx

public SyndContent getTitleEx()
Returns the entry title as a text construct.

Returns: the entry title, null if none.

getUpdatedDate

public Date getUpdatedDate()
Returns the updatedDate

Returns: Returns the updatedDate.

getUri

public String getUri()
Returns the entry URI.

How the entry URI maps to a concrete feed type (RSS or Atom) depends on the concrete feed type. This is explained in detail in Rome documentation, Feed and entry URI mapping.

The returned URI is a normalized URI as specified in RFC 2396bis.

Returns: the entry URI, null if none.

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.

setAuthor

public void setAuthor(String author)
Sets the entry author.

This method is a convenience method, it maps to the Dublin Core module creator.

Parameters: author the entry author to set, null if none.

setAuthors

public void setAuthors(List authors)

setCategories

public void setCategories(List categories)
Sets the entry categories.

This method is a convenience method, it maps to the Dublin Core module subjects.

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

setContents

public void setContents(List contents)
Sets the entry contents.

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

setContributors

public void setContributors(List contributors)

setDescription

public void setDescription(SyndContent description)
Sets the entry description.

Parameters: description the entry description to set, null if none.

setEnclosures

public void setEnclosures(List enclosures)
Sets the entry enclosures.

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

setForeignMarkup

public void setForeignMarkup(Object foreignMarkup)
Sets foreign markup found at channel level.

Parameters: foreignMarkup list of JDOM nodes containing channel-level foreign markup, an empty list if none.

setLink

public void setLink(String link)
Sets the entry link.

Parameters: link the entry link to set, null if none.

setLinks

public void setLinks(List links)
Set the links

Parameters: links The links to set.

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.

setPublishedDate

public void setPublishedDate(Date publishedDate)
Sets the entry published date.

This method is a convenience method, it maps to the Dublin Core module date.

Parameters: publishedDate the entry published date to set, null if none.

setTitle

public void setTitle(String title)
Sets the entry title.

Parameters: title the entry title to set, null if none.

setTitleEx

public void setTitleEx(SyndContent title)
Sets the entry title as a text construct.

Parameters: title the entry title to set, null if none.

setUpdatedDate

public void setUpdatedDate(Date updatedDate)
Set the updatedDate

Parameters: updatedDate The updatedDate to set.

setUri

public void setUri(String uri)
Sets the entry URI.

How the entry URI maps to a concrete feed type (RSS or Atom) depends on the concrete feed type. This is explained in detail in Rome documentation, Feed and entry URI mapping.

Parameters: uri the entry URI to set, null if none.

toString

public String toString()
Returns the String representation for the object.

Returns: String representation for the object.

Copyright © Sun Microsystems. All Rights Reserved.