Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.sun.syndication.feed.synd
Class SyndEntryImpl  view SyndEntryImpl download SyndEntryImpl.java

java.lang.Object
  extended bycom.sun.syndication.feed.synd.SyndEntryImpl
All Implemented Interfaces:
java.lang.Cloneable, com.sun.syndication.feed.CopyFrom, java.io.Serializable, SyndEntry

public class SyndEntryImpl
extends java.lang.Object
implements java.io.Serializable, SyndEntry

Bean for entries of SyndFeedImpl feeds.


Field Summary
private  java.util.List _authors
           
private  java.util.List _categories
           
private  java.util.List _contents
           
private  java.util.List _contributors
           
private  SyndContent _description
           
private  java.util.List _enclosures
           
private  java.lang.String _link
           
private  java.util.List _links
           
private  java.util.List _modules
           
private  com.sun.syndication.feed.impl.ObjectBean _objBean
           
private  SyndContent _summary
           
private  java.lang.String _title
           
private  java.util.Date _updatedDate
           
private  java.lang.String _uri
           
static java.util.Set CONVENIENCE_PROPERTIES
          Unmodifiable Set containing the convenience properties of this class.
private static com.sun.syndication.feed.impl.CopyFromHelper COPY_FROM_HELPER
           
private static java.util.Set IGNORE_PROPERTIES
           
 
Constructor Summary
  SyndEntryImpl()
          Default constructor.
protected SyndEntryImpl(java.lang.Class beanClass, java.util.Set convenienceProperties)
          For implementations extending SyndEntryImpl to be able to use the ObjectBean functionality with extended interfaces.
 
Method Summary
 java.lang.Object clone()
          Creates a deep 'bean' clone of the object.
 void copyFrom(java.lang.Object obj)
          Copies all the properties of the given bean into this one.
 boolean equals(java.lang.Object other)
          Indicates whether some other object is "equal to" this one as defined by the Object equals() method.
 java.lang.String getAuthor()
          Returns the entry author.
 java.util.List getAuthors()
          Returns the entry authors.
 java.util.List getCategories()
          Returns the entry categories.
 java.util.List getContents()
          Returns the entry contents.
 java.util.List getContributors()
          Returns the feed author.
private  com.sun.syndication.feed.module.DCModule getDCModule()
          Returns the Dublin Core module of the feed.
 SyndContent getDescription()
          Returns the entry description.
 java.util.List getEnclosures()
          Returns the entry enclosures.
 java.lang.Class getInterface()
          Returns the interface the copyFrom works on.
 java.lang.String getLink()
          Returns the entry link.
 java.util.List getLinks()
          Returns the links
 com.sun.syndication.feed.module.Module getModule(java.lang.String uri)
          Returns the module identified by a given URI.
 java.util.List getModules()
          Returns the entry modules.
 java.util.Date getPublishedDate()
          Returns the entry published date.
 SyndContent getSummary()
          Returns the summary
 java.lang.String getTitle()
          Returns the entry title.
 java.util.Date getUpdatedDate()
          Returns the updatedDate
 java.lang.String getUri()
          Returns the entry URI.
 int hashCode()
          Returns a hashcode value for the object.
 void setAuthor(java.lang.String author)
          Sets the entry author.
 void setAuthors(java.util.List authors)
          Sets the entry author.
 void setCategories(java.util.List categories)
          Sets the entry categories.
 void setContents(java.util.List contents)
          Sets the entry contents.
 void setContributors(java.util.List contributors)
          Sets the feed author.
 void setDescription(SyndContent description)
          Sets the entry description.
 void setEnclosures(java.util.List enclosures)
          Sets the entry enclosures.
 void setLink(java.lang.String link)
          Sets the entry link.
 void setLinks(java.util.List links)
          Set the links
 void setModules(java.util.List modules)
          Sets the entry modules.
 void setPublishedDate(java.util.Date publishedDate)
          Sets the entry published date.
 void setSummary(SyndContent summary)
          Set the summary
 void setTitle(java.lang.String title)
          Sets the entry title.
 void setUpdatedDate(java.util.Date updatedDate)
          Set the updatedDate
 void setUri(java.lang.String uri)
          Sets the entry URI.
 java.lang.String toString()
          Returns the String representation for the object.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

_objBean

private com.sun.syndication.feed.impl.ObjectBean _objBean

_uri

private java.lang.String _uri

_title

private java.lang.String _title

_link

private java.lang.String _link

_updatedDate

private java.util.Date _updatedDate

_summary

private SyndContent _summary

_description

private SyndContent _description

_links

private java.util.List _links

_contents

private java.util.List _contents

_modules

private java.util.List _modules

_enclosures

private java.util.List _enclosures

_authors

private java.util.List _authors

_contributors

private java.util.List _contributors

_categories

private java.util.List _categories

IGNORE_PROPERTIES

private static final java.util.Set IGNORE_PROPERTIES

CONVENIENCE_PROPERTIES

public static final java.util.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 com.sun.syndication.feed.impl.CopyFromHelper COPY_FROM_HELPER
Constructor Detail

SyndEntryImpl

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


SyndEntryImpl

public SyndEntryImpl()
Default constructor. All properties are set to null.

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Creates a deep 'bean' clone of the object.

Specified by:
clone in interface SyndEntry

equals

public boolean equals(java.lang.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 java.lang.String toString()
Returns the String representation for the object.


getUri

public java.lang.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.

Specified by:
getUri in interface SyndEntry

setUri

public void setUri(java.lang.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.

Specified by:
setUri in interface SyndEntry

getTitle

public java.lang.String getTitle()
Returns the entry title.

Specified by:
getTitle in interface SyndEntry

setTitle

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

Specified by:
setTitle in interface SyndEntry

getLink

public java.lang.String getLink()
Returns the entry link.

Specified by:
getLink in interface SyndEntry

setLink

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

Specified by:
setLink in interface SyndEntry

getDescription

public SyndContent getDescription()
Returns the entry description.

Specified by:
getDescription in interface SyndEntry

setDescription

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

Specified by:
setDescription in interface SyndEntry

getContents

public java.util.List getContents()
Returns the entry contents.

Specified by:
getContents in interface SyndEntry

setContents

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

Specified by:
setContents in interface SyndEntry

getEnclosures

public java.util.List getEnclosures()
Returns the entry enclosures.

Specified by:
getEnclosures in interface SyndEntry

setEnclosures

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

Specified by:
setEnclosures in interface SyndEntry

getPublishedDate

public java.util.Date getPublishedDate()
Returns the entry published date.

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

Specified by:
getPublishedDate in interface SyndEntry

setPublishedDate

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

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

Specified by:
setPublishedDate in interface SyndEntry

getCategories

public java.util.List getCategories()
Returns the entry categories.

Specified by:
getCategories in interface SyndEntry

setCategories

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

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

Specified by:
setCategories in interface SyndEntry

getModules

public java.util.List getModules()
Returns the entry modules.

Specified by:
getModules in interface SyndEntry

setModules

public void setModules(java.util.List modules)
Sets the entry modules.

Specified by:
setModules in interface SyndEntry

getModule

public com.sun.syndication.feed.module.Module getModule(java.lang.String uri)
Returns the module identified by a given URI.

Specified by:
getModule in interface SyndEntry

getDCModule

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


getInterface

public java.lang.Class getInterface()
Description copied from interface: com.sun.syndication.feed.CopyFrom
Returns the interface the copyFrom works on.

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

Specified by:
getInterface in interface com.sun.syndication.feed.CopyFrom

copyFrom

public void copyFrom(java.lang.Object obj)
Description copied from interface: com.sun.syndication.feed.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.

Specified by:
copyFrom in interface com.sun.syndication.feed.CopyFrom

getLinks

public java.util.List getLinks()
Returns the links

Specified by:
getLinks in interface SyndEntry

setLinks

public void setLinks(java.util.List links)
Set the links

Specified by:
setLinks in interface SyndEntry

getSummary

public SyndContent getSummary()
Returns the summary


setSummary

public void setSummary(SyndContent summary)
Set the summary


getUpdatedDate

public java.util.Date getUpdatedDate()
Returns the updatedDate

Specified by:
getUpdatedDate in interface SyndEntry

setUpdatedDate

public void setUpdatedDate(java.util.Date updatedDate)
Set the updatedDate

Specified by:
setUpdatedDate in interface SyndEntry

getAuthors

public java.util.List getAuthors()
Description copied from interface: SyndEntry
Returns the entry 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.

Specified by:
getAuthors in interface SyndEntry

setAuthors

public void setAuthors(java.util.List authors)
Description copied from interface: SyndEntry
Sets the entry author.

For Atom feeds, this sets 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.

Specified by:
setAuthors in interface SyndEntry

getAuthor

public java.lang.String getAuthor()
Returns the entry author.

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

Specified by:
getAuthor in interface SyndEntry

setAuthor

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

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

Specified by:
setAuthor in interface SyndEntry

getContributors

public java.util.List getContributors()
Description copied from interface: SyndEntry
Returns the feed author.

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

Specified by:
getContributors in interface SyndEntry

setContributors

public void setContributors(java.util.List contributors)
Description copied from interface: SyndEntry
Sets the feed author.

Returns contributors as a list of SyndPerson objects.

Specified by:
setContributors in interface SyndEntry