|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.syndication.common.ObjectBean
com.sun.syndication.feed.synd.SyndFeedImpl
Bean for all types of feeds.
It handles all RSS versions and Atom 0.3, it normalizes all info, it may lose information.
Field Summary | |
static java.util.Set |
CONVENIENCE_PROPERTIES
Unmodifiable Set containing the convenience properties of this class. |
Constructor Summary | |
|
SyndFeedImpl()
Default constructor. |
protected |
SyndFeedImpl(java.lang.Class beanClass,
java.util.Set convenienceProperties)
For implementations extending SyndFeedImpl to be able to use the ObjectBean functionality with extended interfaces. |
|
SyndFeedImpl(WireFeed feed)
Creates a SyndFeedImpl and populates all its properties out of the given RSS Channel or Atom Feed properties. |
Method Summary | |
void |
copyFrom(java.lang.Object obj)
Copies all the properties of the given bean into this one. |
WireFeed |
createWireFeed()
Creates a real feed containing the information of the SyndFeedImpl. |
WireFeed |
createWireFeed(java.lang.String feedType)
Creates a real feed containing the information of the SyndFeedImpl. |
java.lang.String |
getAuthor()
Returns the feed author. |
java.util.List |
getCategories()
Returns the feed categories. |
java.lang.String |
getCopyright()
Returns the feed copyright. |
java.lang.String |
getDescription()
Returns the feed description. |
java.lang.String |
getEncoding()
Returns the charset encoding of a the feed. |
java.util.List |
getEntries()
Returns the feed entries. |
java.lang.String |
getFeedType()
Returns the wire feed type the feed had/will-have when coverted from/to a WireFeed. |
SyndImage |
getImage()
Returns the feed image. |
java.lang.Class |
getInterface()
Returns the interface the copyFrom works on. |
java.lang.String |
getLanguage()
Returns the feed language. |
java.lang.String |
getLink()
Returns the feed link. |
Module |
getModule(java.lang.String uri)
Returns the module identified by a given URI. |
java.util.List |
getModules()
Returns the feed modules. |
java.util.Date |
getPublishedDate()
Returns the feed published date. |
java.util.List |
getSupportedFeedTypes()
Returns the real feed types the SyndFeedImpl supports when converting from and to. |
java.lang.String |
getTitle()
Returns the feed title. |
java.lang.String |
getUri()
Returns the feed URI. |
void |
setAuthor(java.lang.String author)
Sets the feed author. |
void |
setCategories(java.util.List categories)
Sets the feed categories. |
void |
setCopyright(java.lang.String copyright)
Sets the feed copyright. |
void |
setDescription(java.lang.String description)
Sets the feed description. |
void |
setEncoding(java.lang.String encoding)
Sets the charset encoding of a the feed. |
void |
setEntries(java.util.List entries)
Sets the feed entries. |
void |
setFeedType(java.lang.String feedType)
Sets the wire feed type the feed will-have when coverted to a WireFeed. |
void |
setImage(SyndImage image)
Sets the feed image. |
void |
setLanguage(java.lang.String language)
Sets the feed language. |
void |
setLink(java.lang.String link)
Sets the feed link. |
void |
setModules(java.util.List modules)
Sets the feed modules. |
void |
setPublishedDate(java.util.Date publishedDate)
Sets the feed published date. |
void |
setTitle(java.lang.String title)
Sets the feed title. |
void |
setUri(java.lang.String uri)
Sets the feed URI. |
Methods inherited from class com.sun.syndication.common.ObjectBean |
clone, equals, hashCode, toString, toString |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.sun.syndication.feed.synd.SyndFeed |
clone |
Methods inherited from interface com.sun.syndication.common.ToString |
toString |
Field Detail |
public static final java.util.Set CONVENIENCE_PROPERTIES
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.
Constructor Detail |
protected SyndFeedImpl(java.lang.Class beanClass, java.util.Set convenienceProperties)
beanClass
- convenienceProperties
- set containing the convenience properties of the SyndEntryImpl
(the are ignored during cloning, check CloneableBean for details).public SyndFeedImpl()
public SyndFeedImpl(WireFeed feed)
feed
- the RSS Channel or the Atom Feed to populate the properties from.Method Detail |
public java.util.List getSupportedFeedTypes()
getSupportedFeedTypes
in interface SyndFeed
public WireFeed createWireFeed()
The feed type of the created WireFeed is taken from the SyndFeedImpl feedType property.
createWireFeed
in interface SyndFeed
public WireFeed createWireFeed(java.lang.String feedType)
createWireFeed
in interface SyndFeed
feedType
- the feed type for the WireFeed to be created.
public java.lang.String getFeedType()
getFeedType
in interface SyndFeed
public void setFeedType(java.lang.String feedType)
setFeedType
in interface SyndFeed
feedType
- the feed type to set, null if none.public java.lang.String getEncoding()
getEncoding
in interface SyndFeed
public void setEncoding(java.lang.String encoding)
setEncoding
in interface SyndFeed
encoding
- the charset encoding of the feed.public java.lang.String getUri()
How the feed 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.
getUri
in interface SyndFeed
public void setUri(java.lang.String uri)
How the feed 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.
setUri
in interface SyndFeed
uri
- the feed URI to set, null if none.public java.lang.String getTitle()
getTitle
in interface SyndFeed
public void setTitle(java.lang.String title)
setTitle
in interface SyndFeed
title
- the feed title to set, null if none.public java.lang.String getLink()
getLink
in interface SyndFeed
public void setLink(java.lang.String link)
setLink
in interface SyndFeed
link
- the feed link to set, null if none.public java.lang.String getDescription()
getDescription
in interface SyndFeed
public void setDescription(java.lang.String description)
setDescription
in interface SyndFeed
description
- the feed description to set, null if none.public java.util.Date getPublishedDate()
This method is a convenience method, it maps to the Dublin Core module date.
getPublishedDate
in interface SyndFeed
public void setPublishedDate(java.util.Date publishedDate)
This method is a convenience method, it maps to the Dublin Core module date.
setPublishedDate
in interface SyndFeed
publishedDate
- the feed published date to set, null if none.public java.lang.String getAuthor()
This method is a convenience method, it maps to the Dublin Core module creator.
getAuthor
in interface SyndFeed
public void setAuthor(java.lang.String author)
This method is a convenience method, it maps to the Dublin Core module creator.
setAuthor
in interface SyndFeed
author
- the feed author to set, null if none.public java.lang.String getCopyright()
This method is a convenience method, it maps to the Dublin Core module rights.
getCopyright
in interface SyndFeed
public void setCopyright(java.lang.String copyright)
This method is a convenience method, it maps to the Dublin Core module rights.
setCopyright
in interface SyndFeed
copyright
- the feed copyright to set, null if none.public SyndImage getImage()
getImage
in interface SyndFeed
public void setImage(SyndImage image)
setImage
in interface SyndFeed
image
- the feed image to set, null if none.public java.util.List getCategories()
This method is a convenience method, it maps to the Dublin Core module subjects.
getCategories
in interface SyndFeed
public void setCategories(java.util.List categories)
This method is a convenience method, it maps to the Dublin Core module subjects.
setCategories
in interface SyndFeed
categories
- the list of SyndCategoryImpl elements with the feed categories to set,
an empty list or null if none.public java.util.List getEntries()
getEntries
in interface SyndFeed
public void setEntries(java.util.List entries)
setEntries
in interface SyndFeed
entries
- the list of SyndEntryImpl elements with the feed entries to set,
an empty list or null if none.public java.lang.String getLanguage()
This method is a convenience method, it maps to the Dublin Core module language.
getLanguage
in interface SyndFeed
public void setLanguage(java.lang.String language)
This method is a convenience method, it maps to the Dublin Core module language.
setLanguage
in interface SyndFeed
language
- the feed language to set, null if none.public java.util.List getModules()
getModules
in interface SyndFeed
public void setModules(java.util.List modules)
setModules
in interface SyndFeed
modules
- the list of ModuleImpl elements with the feed modules to set,
an empty list or null if none.public Module getModule(java.lang.String uri)
getModule
in interface SyndFeed
uri
- the URI of the ModuleImpl.
public java.lang.Class getInterface()
CopyFrom
This is useful when dealing with properties that may have multiple implementations. For example, Module.
getInterface
in interface CopyFrom
public void copyFrom(java.lang.Object obj)
CopyFrom
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.
copyFrom
in interface CopyFrom
obj
- the instance to copy properties from.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |