rome 2.1.0 · com.rometools.rome.feed.synd.SyndEntryImpl

Modifier and Type	Field and Description
private List<SyndPerson>	authors
private final Class<?>	beanClass
private List<SyndCategory>	categories
private String	comments
private List<SyndContent>	contents
private List<SyndPerson>	contributors
public static final Set<String>	CONVENIENCE_PROPERTIES Unmodifiable Set containing the convenience properties of this class.
private final Set<String>	convenienceProperties
private static final CopyFromHelper	COPY_FROM_HELPER
private SyndContent	description
private List<SyndEnclosure>	enclosures
private List<Element>	foreignMarkup
private static final Set<String>	IGNORE_PROPERTIES
private String	link
private List<SyndLink>	links
private List<Module>	modules
private static final long	serialVersionUID
private SyndFeed	source
private SyndContent	title
private Date	updatedDate
private String	uri
private Object	wireEntry

Access	Constructor and Description
protected	SyndEntryImpl(final Class<?> beanClass, final Set<String> set containing the convenience properties of the SyndEntryImpl (the are ignored during cloning, check CloneableBean for details). convenienceProperties) For implementations extending SyndEntryImpl to be able to use the ObjectBean functionality with extended interfaces.
public	SyndEntryImpl()

Method Summary

Modifier and Type	Method and Description
public Object	Returns: a clone of the object. clone() Overrides java.lang.Object.clone. Implements com.rometools.rome.feed.synd.SyndEntry.clone. Creates a deep 'bean' clone of the object.
public void	copyFrom(final CopyFrom the instance to copy properties from. obj) Implements com.rometools.rome.feed.CopyFrom.copyFrom. Copies all the properties of the given bean into this one.
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 SyndLink	findRelatedLink(final String relation) Implements com.rometools.rome.feed.synd.SyndEntry.findRelatedLink. Returns the first instance of a SyndLink with the specified relation, or null
public String	getAuthor() Implements com.rometools.rome.feed.synd.SyndEntry.getAuthor. Returns the name of the first entry author in the collection of authors.
public List<SyndPerson>	getAuthors() Implements com.rometools.rome.feed.synd.SyndEntry.getAuthors. Returns the entry authors.
public List<SyndCategory>	Returns: a list of SyndCategoryImpl elements with the entry categories, an empty list if none. getCategories() Implements com.rometools.rome.feed.synd.SyndEntry.getCategories. Returns the entry categories.
public String	getComments() Implements com.rometools.rome.feed.synd.SyndEntry.getComments. URL of a page for comments relating to the item.
public List<SyndContent>	Returns: a list of SyndContentImpl elements with the entry contents, an empty list if none. getContents() Implements com.rometools.rome.feed.synd.SyndEntry.getContents. Returns the entry contents.
public List<SyndPerson>	getContributors() Implements com.rometools.rome.feed.synd.SyndEntry.getContributors. Returns the feed author.
private DCModule	Returns: the DC module, it's never null getDCModule() Returns the Dublin Core module of the feed.
public SyndContent	Returns: the entry description, null if none. getDescription() Implements com.rometools.rome.feed.synd.SyndEntry.getDescription. Returns the entry description.
public List<SyndEnclosure>	Returns: a list of SyndEnclosure elements with the entry enclosures, an empty list if none. getEnclosures() Implements com.rometools.rome.feed.synd.SyndEntry.getEnclosures. Returns the entry enclosures.
public List<Element>	Returns: list of JDOM nodes containing channel-level foreign markup, an empty list if none. getForeignMarkup() Implements com.rometools.rome.feed.synd.SyndEntry.getForeignMarkup. Returns foreign markup found at channel level.
public Class<SyndEntry>	getInterface() Implements com.rometools.rome.feed.CopyFrom.getInterface. Returns the interface the copyFrom works on.
public String	Returns: the entry link, null if none. getLink() Implements com.rometools.rome.feed.synd.SyndEntry.getLink. Returns the entry link.
public List<SyndLink>	Returns: Returns the links. getLinks() Implements com.rometools.rome.feed.synd.SyndEntry.getLinks. Returns the links
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.synd.SyndEntry.getModule. Returns the module identified by a given URI.
public List<Module>	Returns: a list of ModuleImpl elements with the entry modules, an empty list if none. getModules() Implements com.rometools.rome.feed.synd.SyndEntry.getModules. Returns the entry modules.
public Date	Returns: the entry published date, null if none. getPublishedDate() Implements com.rometools.rome.feed.synd.SyndEntry.getPublishedDate. Returns the entry published date.
public SyndFeed	getSource() Implements com.rometools.rome.feed.synd.SyndEntry.getSource. Returns the entry source.
public String	Returns: the entry title, null if none. getTitle() Implements com.rometools.rome.feed.synd.SyndEntry.getTitle. Returns the entry title.
public SyndContent	Returns: the entry title, null if none. getTitleEx() Implements com.rometools.rome.feed.synd.SyndEntry.getTitleEx. Returns the entry title as a text construct.
public Date	Returns: Returns the updatedDate. getUpdatedDate() Implements com.rometools.rome.feed.synd.SyndEntry.getUpdatedDate. Returns the updatedDate
public String	Returns: the entry URI, null if none. getUri() Implements com.rometools.rome.feed.synd.SyndEntry.getUri. Returns the entry URI.
public Object	getWireEntry() Implements com.rometools.rome.feed.synd.SyndEntry.getWireEntry. Return the original item this SyndEntry is generated from.
public int	Returns: the hashcode of the bean object. hashCode() Overrides java.lang.Object.hashCode. Returns a hashcode value for the object.
public void	setAuthor(final String the entry author to set, null if none. author) Implements com.rometools.rome.feed.synd.SyndEntry.setAuthor. Sets the entry author.
public void	setAuthors(final List<SyndPerson> the feed authors to set, null if none. authors) Implements com.rometools.rome.feed.synd.SyndEntry.setAuthors. Sets the entry authors.
public void	setCategories(final List<SyndCategory> the list of SyndCategoryImpl elements with the entry categories to set, an empty list or null if none. categories) Implements com.rometools.rome.feed.synd.SyndEntry.setCategories. Sets the entry categories.
public void	setComments(final String URL comments) Implements com.rometools.rome.feed.synd.SyndEntry.setComments. URL of a page for comments relating to the item.
public void	setContents(final List<SyndContent> the list of SyndContentImpl elements with the entry contents to set, an empty list or null if none. contents) Implements com.rometools.rome.feed.synd.SyndEntry.setContents. Sets the entry contents.
public void	setContributors(final List<SyndPerson> the feed contributors to set, null if none. contributors) Implements com.rometools.rome.feed.synd.SyndEntry.setContributors. Sets the feed contributors.
public void	setDescription(final SyndContent the entry description to set, null if none. description) Implements com.rometools.rome.feed.synd.SyndEntry.setDescription. Sets the entry description.
public void	setEnclosures(final List<SyndEnclosure> the list of SyndEnclosure elements with the entry enclosures to set, an empty list or null if none. enclosures) Implements com.rometools.rome.feed.synd.SyndEntry.setEnclosures. Sets the entry enclosures.
public void	setForeignMarkup(final List<Element> list of JDOM nodes containing channel-level foreign markup, an empty list if none. foreignMarkup) Implements com.rometools.rome.feed.synd.SyndEntry.setForeignMarkup. Sets foreign markup found at channel level.
public void	setLink(final String the entry link to set, null if none. link) Implements com.rometools.rome.feed.synd.SyndEntry.setLink. Sets the entry link.
public void	setLinks(final List<SyndLink> The links to set. links) Implements com.rometools.rome.feed.synd.SyndEntry.setLinks. Set the links
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.synd.SyndEntry.setModules. Sets the entry modules.
public void	setPublishedDate(final Date the entry published date to set, null if none. publishedDate) Implements com.rometools.rome.feed.synd.SyndEntry.setPublishedDate. Sets the entry published date.
public void	setSource(final SyndFeed the original SyndFeed that contained this article source) Implements com.rometools.rome.feed.synd.SyndEntry.setSource. Sets the entry source feed (for use if different from containing feed)
public void	setTitle(final String the entry title to set, null if none. title) Implements com.rometools.rome.feed.synd.SyndEntry.setTitle. Sets the entry title.
public void	setTitleEx(final SyndContent the entry title to set, null if none. title) Implements com.rometools.rome.feed.synd.SyndEntry.setTitleEx. Sets the entry title as a text construct.
public void	setUpdatedDate(final Date The updatedDate to set. updatedDate) Implements com.rometools.rome.feed.synd.SyndEntry.setUpdatedDate. Set the updatedDate
public void	setUri(final String the entry URI to set, null if none. uri) Implements com.rometools.rome.feed.synd.SyndEntry.setUri. Sets the entry URI.
public void	setWireEntry(final Object wireEntry)
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:: finalize getClass notify notifyAll wait wait wait

authors	back to summary
private List<SyndPerson> authors

beanClass	back to summary
private final Class<?> beanClass

categories	back to summary
private List<SyndCategory> categories

comments	back to summary
private String comments

contents	back to summary
private List<SyndContent> contents

contributors	back to summary
private List<SyndPerson> contributors

CONVENIENCE_PROPERTIES	back to summary
public static final Set<String> 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.

convenienceProperties	back to summary
private final Set<String> convenienceProperties

COPY_FROM_HELPER	back to summary
private static final CopyFromHelper COPY_FROM_HELPER

description	back to summary
private SyndContent description

enclosures	back to summary
private List<SyndEnclosure> enclosures

foreignMarkup	back to summary
private List<Element> foreignMarkup

IGNORE_PROPERTIES	back to summary
private static final Set<String> IGNORE_PROPERTIES

link	back to summary
private String link

links	back to summary
private List<SyndLink> links

modules	back to summary
private List<Module> modules

serialVersionUID	back to summary
private static final long serialVersionUID

source	back to summary
private SyndFeed source

title	back to summary
private SyndContent title

updatedDate	back to summary
private Date updatedDate

uri	back to summary
private String uri

wireEntry	back to summary
private Object wireEntry

SyndEntryImpl	back to summary
protected SyndEntryImpl(final Class<?> beanClass, final Set<String> convenienceProperties) For implementations extending SyndEntryImpl to be able to use the ObjectBean functionality with extended interfaces. Parameters convenienceProperties:Set<String> set containing the convenience properties of the SyndEntryImpl (the are ignored during cloning, check CloneableBean for details).

SyndEntryImpl	back to summary
public SyndEntryImpl()

Method Detail

clone	back to summary
public Object clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Implements com.rometools.rome.feed.synd.SyndEntry.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.

clone

back to summary

public Object clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Implements com.rometools.rome.feed.synd.SyndEntry.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.

copyFrom	back to summary
public void copyFrom(final CopyFrom obj) Implements com.rometools.rome.feed.CopyFrom.copyFrom. Doc from com.rometools.rome.feed.CopyFrom.copyFrom. Copies all the properties of the given bean into this one. Any existing properties in this bean are lost. This method is useful for moving from one implementation of a bean interface to another. For example from the default SyndFeed bean implementation to a Hibernate ready implementation. Parameters obj:CopyFrom the instance to copy properties from. Annotations @Override

copyFrom

back to summary

public void copyFrom(final CopyFrom obj)

Implements com.rometools.rome.feed.CopyFrom.copyFrom.

Doc from com.rometools.rome.feed.CopyFrom.copyFrom.

Copies all the properties of the given bean into this one.

Any existing properties in this bean are lost.

This method is useful for moving from one implementation of a bean interface to another. For example from the default SyndFeed bean implementation to a Hibernate ready implementation.

Parameters

obj:CopyFrom: the instance to copy properties from.

Annotations

@Override

equals	back 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

equals

back 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

findRelatedLink	back to summary
public SyndLink findRelatedLink(final String relation) Implements com.rometools.rome.feed.synd.SyndEntry.findRelatedLink. Doc from com.rometools.rome.feed.synd.SyndEntry.findRelatedLink. Returns the first instance of a SyndLink with the specified relation, or null Annotations @Override

findRelatedLink

back to summary

public SyndLink findRelatedLink(final String relation)

Implements com.rometools.rome.feed.synd.SyndEntry.findRelatedLink.

Doc from com.rometools.rome.feed.synd.SyndEntry.findRelatedLink.

Returns the first instance of a SyndLink with the specified relation, or null

Annotations

@Override

getAuthor	back to summary
public String getAuthor() Implements com.rometools.rome.feed.synd.SyndEntry.getAuthor. Doc from com.rometools.rome.feed.synd.SyndEntry.getAuthor. Returns the name of the first entry author in the collection of authors. For Atom feeds, this returns the authors as a list of SyndPerson objects, for RSS feeds this method is a convenience method, it maps to the Dublin Core module creator. Returns:String the feed author, empty string if none. Annotations @Override

getAuthor

back to summary

public String getAuthor()

Implements com.rometools.rome.feed.synd.SyndEntry.getAuthor.

Doc from com.rometools.rome.feed.synd.SyndEntry.getAuthor.

Returns the name of the first entry author in the collection of authors.

For Atom feeds, this returns the authors as a list of SyndPerson objects, for RSS feeds this method is a convenience method, it maps to the Dublin Core module creator.

Returns:String

the feed author, empty string if none.

Annotations

@Override

getAuthors	back to summary
public List<SyndPerson> getAuthors() Implements com.rometools.rome.feed.synd.SyndEntry.getAuthors. Doc from com.rometools.rome.feed.synd.SyndEntry.getAuthors. Returns the entry authors. For Atom feeds, this returns the authors as a list of SyndPerson objects. Returns:List<SyndPerson> the feed authors, empty list if none. Annotations @Override

getAuthors

back to summary

public List<SyndPerson> getAuthors()

Implements com.rometools.rome.feed.synd.SyndEntry.getAuthors.

Doc from com.rometools.rome.feed.synd.SyndEntry.getAuthors.

Returns the entry authors.

For Atom feeds, this returns the authors as a list of SyndPerson objects.

Returns:List<SyndPerson>

the feed authors, empty list if none.

Annotations

@Override

getCategories	back to summary
public List<SyndCategory> getCategories() Implements com.rometools.rome.feed.synd.SyndEntry.getCategories. Returns the entry categories. Returns:List<SyndCategory> a list of SyndCategoryImpl elements with the entry categories, an empty list if none. Annotations @Override

getCategories

back to summary

public List<SyndCategory> getCategories()

Implements com.rometools.rome.feed.synd.SyndEntry.getCategories.

Returns the entry categories.

Returns:List<SyndCategory>

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

Annotations

@Override

getComments back to summary

getComments	back to summary
public String getComments() Implements com.rometools.rome.feed.synd.SyndEntry.getComments. Doc from com.rometools.rome.feed.synd.SyndEntry.getComments. URL of a page for comments relating to the item. Returns:String comments URL or `null`. Annotations @Override

public String getComments()

Implements com.rometools.rome.feed.synd.SyndEntry.getComments.

Doc from com.rometools.rome.feed.synd.SyndEntry.getComments.

URL of a page for comments relating to the item.

Returns:String

comments URL or null.

Annotations

@Override

getContents	back to summary
public List<SyndContent> getContents() Implements com.rometools.rome.feed.synd.SyndEntry.getContents. Returns the entry contents. Returns:List<SyndContent> a list of SyndContentImpl elements with the entry contents, an empty list if none. Annotations @Override

getContents

back to summary

public List<SyndContent> getContents()

Implements com.rometools.rome.feed.synd.SyndEntry.getContents.

Returns the entry contents.

Returns:List<SyndContent>

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

Annotations

@Override

getContributors	back to summary
public List<SyndPerson> getContributors() Implements com.rometools.rome.feed.synd.SyndEntry.getContributors. Doc from com.rometools.rome.feed.synd.SyndEntry.getContributors. Returns the feed author. For Atom feeds, this returns the contributors as a list of SyndPerson objects Returns:List<SyndPerson> the feed author, null if none. Annotations @Override

getContributors

back to summary

public List<SyndPerson> getContributors()

Implements com.rometools.rome.feed.synd.SyndEntry.getContributors.

Doc from com.rometools.rome.feed.synd.SyndEntry.getContributors.

Returns the feed author.

For Atom feeds, this returns the contributors as a list of SyndPerson objects

Returns:List<SyndPerson>

the feed author, null if none.

Annotations

@Override

getDCModule	back to summary
private DCModule getDCModule() Returns the Dublin Core module of the feed. Returns:DCModule the DC module, it's never null

getDCModule

back to summary

private DCModule getDCModule()

Returns the Dublin Core module of the feed.

Returns:DCModule: the DC module, it's never null

getDescription	back to summary
public SyndContent getDescription() Implements com.rometools.rome.feed.synd.SyndEntry.getDescription. Returns the entry description. Returns:SyndContent the entry description, null if none. Annotations @Override

getDescription

back to summary

public SyndContent getDescription()

Implements com.rometools.rome.feed.synd.SyndEntry.getDescription.

Returns the entry description.

Returns:SyndContent

the entry description, null if none.

Annotations

@Override

getEnclosures	back to summary
public List<SyndEnclosure> getEnclosures() Implements com.rometools.rome.feed.synd.SyndEntry.getEnclosures. Returns the entry enclosures. Returns:List<SyndEnclosure> a list of SyndEnclosure elements with the entry enclosures, an empty list if none. Annotations @Override

getEnclosures

back to summary

public List<SyndEnclosure> getEnclosures()

Implements com.rometools.rome.feed.synd.SyndEntry.getEnclosures.

Returns the entry enclosures.

Returns:List<SyndEnclosure>

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

Annotations

@Override

getForeignMarkup	back to summary
public List<Element> getForeignMarkup() Implements com.rometools.rome.feed.synd.SyndEntry.getForeignMarkup. Returns foreign markup found at channel level. Returns:List<Element> list of JDOM nodes containing channel-level foreign markup, an empty list if none. Annotations @Override

getForeignMarkup

back to summary

public List<Element> getForeignMarkup()

Implements com.rometools.rome.feed.synd.SyndEntry.getForeignMarkup.

Returns foreign markup found at channel level.

Returns:List<Element>

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

Annotations

@Override

getInterface	back to summary
public Class<SyndEntry> getInterface() Implements com.rometools.rome.feed.CopyFrom.getInterface. Doc from com.rometools.rome.feed.CopyFrom.getInterface. Returns the interface the copyFrom works on. This is useful when dealing with properties that may have multiple implementations. For example, Module. Returns:Class<SyndEntry> the interface the copyFrom works on. Annotations @Override

getInterface

back to summary

public Class<SyndEntry> getInterface()

Implements com.rometools.rome.feed.CopyFrom.getInterface.

Doc from com.rometools.rome.feed.CopyFrom.getInterface.

Returns the interface the copyFrom works on.

This is useful when dealing with properties that may have multiple implementations. For example, Module.

Returns:Class<SyndEntry>

the interface the copyFrom works on.

Annotations

@Override

getLink	back to summary
public String getLink() Implements com.rometools.rome.feed.synd.SyndEntry.getLink. Returns the entry link. Returns:String the entry link, null if none. Annotations @Override

getLink

back to summary

public String getLink()

Implements com.rometools.rome.feed.synd.SyndEntry.getLink.

Returns the entry link.

Returns:String

the entry link, null if none.

Annotations

@Override

getLinks	back to summary
public List<SyndLink> getLinks() Implements com.rometools.rome.feed.synd.SyndEntry.getLinks. Returns the links Returns:List<SyndLink> Returns the links. Annotations @Override

getLinks

back to summary

public List<SyndLink> getLinks()

Implements com.rometools.rome.feed.synd.SyndEntry.getLinks.

Returns the links

Returns:List<SyndLink>

Returns the links.

Annotations

@Override

getModule	back to summary
public Module getModule(final String uri) Implements com.rometools.rome.feed.synd.SyndEntry.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

getModule

back to summary

public Module getModule(final String uri)

Implements com.rometools.rome.feed.synd.SyndEntry.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

getModules	back to summary
public List<Module> getModules() Implements com.rometools.rome.feed.synd.SyndEntry.getModules. Returns the entry modules. Returns:List<Module> a list of ModuleImpl elements with the entry modules, an empty list if none. Annotations @Override

getModules

back to summary

public List<Module> getModules()

Implements com.rometools.rome.feed.synd.SyndEntry.getModules.

Returns the entry modules.

Returns:List<Module>

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

Annotations

@Override

getPublishedDate	back to summary
public Date getPublishedDate() Implements com.rometools.rome.feed.synd.SyndEntry.getPublishedDate. Returns the entry published date. This method is a convenience method, it maps to the Dublin Core module date. Returns:Date the entry published date, null if none. Annotations @Override

getPublishedDate

back to summary

public Date getPublishedDate()

Implements com.rometools.rome.feed.synd.SyndEntry.getPublishedDate.

Returns the entry published date.

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

Returns:Date

the entry published date, null if none.

Annotations

@Override

getSource	back to summary
public SyndFeed getSource() Implements com.rometools.rome.feed.synd.SyndEntry.getSource. Doc from com.rometools.rome.feed.synd.SyndEntry.getSource. Returns the entry source. This returns the entry source as a SyndFeed Returns:SyndFeed the SyndFeed to which this entry is attributed Annotations @Override

getSource

back to summary

public SyndFeed getSource()

Implements com.rometools.rome.feed.synd.SyndEntry.getSource.

Doc from com.rometools.rome.feed.synd.SyndEntry.getSource.

Returns the entry source.

This returns the entry source as a SyndFeed

Returns:SyndFeed

the SyndFeed to which this entry is attributed

Annotations

@Override

getTitle	back to summary
public String getTitle() Implements com.rometools.rome.feed.synd.SyndEntry.getTitle. Returns the entry title. Returns:String the entry title, null if none. Annotations @Override

getTitle

back to summary

public String getTitle()

Implements com.rometools.rome.feed.synd.SyndEntry.getTitle.

Returns the entry title.

Returns:String

the entry title, null if none.

Annotations

@Override

getTitleEx	back to summary
public SyndContent getTitleEx() Implements com.rometools.rome.feed.synd.SyndEntry.getTitleEx. Returns the entry title as a text construct. Returns:SyndContent the entry title, null if none. Annotations @Override

getTitleEx

back to summary

public SyndContent getTitleEx()

Implements com.rometools.rome.feed.synd.SyndEntry.getTitleEx.

Returns the entry title as a text construct.

Returns:SyndContent

the entry title, null if none.

Annotations

@Override

getUpdatedDate

back to summary

public Date getUpdatedDate()

Implements com.rometools.rome.feed.synd.SyndEntry.getUpdatedDate.

Returns the updatedDate

Returns:Date

Returns the updatedDate.

Annotations

@Override

getUri

back to summary

public String getUri()

Implements com.rometools.rome.feed.synd.SyndEntry.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:String

the entry URI, null if none.

Annotations

@Override

getWireEntry

back to summary

public Object getWireEntry()

Implements com.rometools.rome.feed.synd.SyndEntry.getWireEntry.

Doc from com.rometools.rome.feed.synd.SyndEntry.getWireEntry.

Return the original item this SyndEntry is generated from. The type of the object returned depends on the original type of the feed. Atom 0.3/1.0 will return com.rometools.rome.feed.atom.Entry, while RSS will return com.rometools.rome.feed.rss.Item.java. If this entry was not generated from a WireFeed, or the SyndFeed was not set to preserve the WireFeed then it will return null

Returns:Object

the WireFeed Item or Entry this Entry is generated from, or null

Annotations

@Override

hashCode

back 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

setAuthor

back to summary

public void setAuthor(final String author)

Implements com.rometools.rome.feed.synd.SyndEntry.setAuthor.

Sets the entry author.

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

Parameters

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

Annotations

@Override

setAuthors

back to summary

public void setAuthors(final List<SyndPerson> authors)

Implements com.rometools.rome.feed.synd.SyndEntry.setAuthors.

Doc from com.rometools.rome.feed.synd.SyndEntry.setAuthors.

Sets the entry authors.

For Atom feeds, this sets the authors as a list of SyndPerson objects.

Parameters

authors:List<SyndPerson>: the feed authors to set, null if none.

Annotations

@Override

setCategories

back to summary

public void setCategories(final List<SyndCategory> categories)

Implements com.rometools.rome.feed.synd.SyndEntry.setCategories.

Sets the entry categories.

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

Parameters

categories:List<SyndCategory>: the list of SyndCategoryImpl elements with the entry categories to set, an empty list or null if none.

Annotations

@Override

setComments

back to summary

public void setComments(final String comments)

Implements com.rometools.rome.feed.synd.SyndEntry.setComments.

Doc from com.rometools.rome.feed.synd.SyndEntry.setComments.

URL of a page for comments relating to the item.

Parameters

comments:String: URL

Annotations

@Override

setContents

back to summary

public void setContents(final List<SyndContent> contents)

Implements com.rometools.rome.feed.synd.SyndEntry.setContents.

Sets the entry contents.

Parameters

contents:List<SyndContent>: the list of SyndContentImpl elements with the entry contents to set, an empty list or null if none.

Annotations

@Override

setContributors

back to summary

public void setContributors(final List<SyndPerson> contributors)

Implements com.rometools.rome.feed.synd.SyndEntry.setContributors.

Doc from com.rometools.rome.feed.synd.SyndEntry.setContributors.

Sets the feed contributors.

Returns contributors as a list of SyndPerson objects.

Parameters

contributors:List<SyndPerson>: the feed contributors to set, null if none.

Annotations

@Override

setDescription

back to summary

public void setDescription(final SyndContent description)

Implements com.rometools.rome.feed.synd.SyndEntry.setDescription.

Sets the entry description.

Parameters

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

Annotations

@Override

setEnclosures

back to summary

public void setEnclosures(final List<SyndEnclosure> enclosures)

Implements com.rometools.rome.feed.synd.SyndEntry.setEnclosures.

Sets the entry enclosures.

Parameters

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

Annotations

@Override

setForeignMarkup

back to summary

public void setForeignMarkup(final List<Element> foreignMarkup)

Implements com.rometools.rome.feed.synd.SyndEntry.setForeignMarkup.

Sets foreign markup found at channel level.

Parameters

foreignMarkup:List<Element>: list of JDOM nodes containing channel-level foreign markup, an empty list if none.

Annotations

@Override

setLink

back to summary

public void setLink(final String link)

Implements com.rometools.rome.feed.synd.SyndEntry.setLink.

Sets the entry link.

Parameters

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

Annotations

@Override

setLinks

back to summary

public void setLinks(final List<SyndLink> links)

Implements com.rometools.rome.feed.synd.SyndEntry.setLinks.

Set the links

Parameters

links:List<SyndLink>: The links to set.

Annotations

@Override

setModules

back to summary

public void setModules(final List<Module> modules)

Implements com.rometools.rome.feed.synd.SyndEntry.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

setPublishedDate

back to summary

public void setPublishedDate(final Date publishedDate)

Implements com.rometools.rome.feed.synd.SyndEntry.setPublishedDate.

Sets the entry published date.

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

Parameters

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

Annotations

@Override

setSource

back to summary

public void setSource(final SyndFeed source)

Implements com.rometools.rome.feed.synd.SyndEntry.setSource.

Doc from com.rometools.rome.feed.synd.SyndEntry.setSource.

Sets the entry source feed (for use if different from containing feed)

Parameters

source:SyndFeed: the original SyndFeed that contained this article

Annotations

@Override

setTitle

back to summary

public void setTitle(final String title)

Implements com.rometools.rome.feed.synd.SyndEntry.setTitle.

Sets the entry title.

Parameters

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

Annotations

@Override

setTitleEx

back to summary

public void setTitleEx(final SyndContent title)

Implements com.rometools.rome.feed.synd.SyndEntry.setTitleEx.

Sets the entry title as a text construct.

Parameters

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

Annotations

@Override

setUpdatedDate

back to summary

public void setUpdatedDate(final Date updatedDate)

Implements com.rometools.rome.feed.synd.SyndEntry.setUpdatedDate.

Set the updatedDate

Parameters

updatedDate:Date: The updatedDate to set.

Annotations

@Override

setUri

back to summary

public void setUri(final String uri)

Implements com.rometools.rome.feed.synd.SyndEntry.setUri.

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