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

public Class SyndFeedImpl

extends Object
implements Serializable, SyndFeed
Class Inheritance
All Implemented Interfaces
com.rometools.rome.feed.synd.SyndFeed, com.rometools.rome.feed.module.Extendable, com.rometools.rome.feed.CopyFrom, java.lang.Cloneable, java.io.Serializable
Imports
java.io.Serializable, java.util.Collections, .Date, .HashMap, .HashSet, .List, .Map, .Set, org.jdom2.Element, com.rometools.rome.feed.CopyFrom, .WireFeed, com.rometools.rome.feed.impl.CloneableBean, .CopyFromHelper, .EqualsBean, .ToStringBean, com.rometools.rome.feed.module.DCModule, .DCModuleImpl, .Module, .SyModule, .SyModuleImpl, com.rometools.rome.feed.module.impl.ModuleUtils, com.rometools.rome.feed.synd.impl.Converters, .URINormalizer, com.rometools.utils.Lists

Bean for all types of feeds.

It handles all RSS versions, Atom 0.3 and Atom 1.0, it normalizes all info, it may lose information.

Field Summary

Modifier and TypeField and Description
private List<SyndPerson>
private final Class<?>
private List<SyndPerson>
public static final Set<String>
CONVENIENCE_PROPERTIES

Unmodifiable Set containing the convenience properties of this class.

private final Set<String>
private static final Converters
private static final CopyFromHelper
private SyndContent
private String
private String
private List<SyndEntry>
private String
private List<Element>
private String
private SyndImage
private static final Set<String>
private SyndImage
private String
private List<SyndLink>
private String
private List<Module>
private boolean
private static final long
private String
private SyndContent
private String
private String
private WireFeed

Constructor Summary

AccessConstructor and Description
protected
SyndFeedImpl(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 SyndFeedImpl to be able to use the ObjectBean functionality with extended interfaces.

public
public
SyndFeedImpl(final WireFeed
the RSS Channel or the Atom Feed to populate the properties from.
feed
)

Creates a SyndFeedImpl and populates all its properties out of the given RSS Channel or Atom Feed properties.

public
SyndFeedImpl(final WireFeed feed, final boolean preserveWireFeed)

Creates a SyndFeedImpl and populates all its properties out of the given RSS Channel or Atom Feed properties, while optionally preserving the WireFeed for access via the orignalWireFeed() method.

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

a clone of the object.
clone
()

Overrides java.lang.Object.clone.

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

Returns:

the real feed.
createWireFeed
()

Implements com.rometools.rome.feed.synd.SyndFeed.createWireFeed.

Creates a real feed containing the information of the SyndFeedImpl.
public WireFeed

Returns:

the real feed.
createWireFeed
(final String
the feed type for the WireFeed to be created.
feedType
)

Implements com.rometools.rome.feed.synd.SyndFeed.createWireFeed.

Creates a real feed containing the information of the SyndFeedImpl.
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 String

Returns:

the feed author, null if none.
getAuthor
()

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

Returns the feed author.
public List<SyndPerson>
getAuthors()

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

Returns the feed authors.
public List<SyndCategory>

Returns:

a list of SyndCategoryImpl elements with the feed categories, an empty list if none.
getCategories
()

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

Returns the feed categories.
public List<SyndPerson>
public String

Returns:

the feed copyright, null if none.
getCopyright
()

Implements com.rometools.rome.feed.synd.SyndFeed.getCopyright.

Returns the feed copyright.
private DCModule

Returns:

the DC module, it's never null
getDCModule
()

Returns the Dublin Core module of the feed.

public String

Returns:

the feed description, null if none.
getDescription
()

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

Returns the feed description.
public SyndContent

Returns:

the feed description, null if none.
getDescriptionEx
()

Implements com.rometools.rome.feed.synd.SyndFeed.getDescriptionEx.

Returns the feed description as a text construct.
public String
getDocs()

Implements com.rometools.rome.feed.synd.SyndFeed.getDocs.

This tag should contain a URL that references a description of the channel.
public String

Returns:

the charset encoding of the feed.
getEncoding
()

Implements com.rometools.rome.feed.synd.SyndFeed.getEncoding.

Returns the charset encoding of a the feed.
public List<SyndEntry>

Returns:

a list of SyndEntryImpl elements with the feed entries, an empty list if none.
getEntries
()

Implements com.rometools.rome.feed.synd.SyndFeed.getEntries.

Returns the feed entries.
public String

Returns:

the feed type, null if none.
getFeedType
()

Implements com.rometools.rome.feed.synd.SyndFeed.getFeedType.

Returns the wire feed type the feed had/will-have when coverted from/to a WireFeed.
public List<Element>

Returns:

Opaque object to discourage use
getForeignMarkup
()

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

Returns foreign markup found at channel level.
public String
getGenerator()

Implements com.rometools.rome.feed.synd.SyndFeed.getGenerator.

A string indicating the program used to generate the channel.
public SyndImage

Returns:

the feed icon, null if none.
getIcon
()

Implements com.rometools.rome.feed.synd.SyndFeed.getIcon.

Returns the feed icon.
public SyndImage

Returns:

the feed image, null if none.
getImage
()

Implements com.rometools.rome.feed.synd.SyndFeed.getImage.

Returns the feed image.
public Class<SyndFeed>
getInterface()

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

Returns the interface the copyFrom works on.
public String

Returns:

the feed language, null if none.
getLanguage
()

Implements com.rometools.rome.feed.synd.SyndFeed.getLanguage.

Returns the feed language.
public String
getManagingEditor()

Implements com.rometools.rome.feed.synd.SyndFeed.getManagingEditor.

The email address of the managing editor of the site, the person to contact for editorial inquiries.
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.SyndFeed.getModule.

Returns the module identified by a given URI.
public List<Module>

Returns:

a list of ModuleImpl elements with the feed modules, an empty list if none.
getModules
()

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

Returns the feed modules.
public Date

Returns:

the feed published date, null if none.
getPublishedDate
()

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

Returns the feed published date.
public String
public List<String>

Returns:

the real feed type supported.
getSupportedFeedTypes
()

Implements com.rometools.rome.feed.synd.SyndFeed.getSupportedFeedTypes.

Returns the real feed types the SyndFeedImpl supports when converting from and to.
public String

Returns:

the feed title, null if none.
getTitle
()

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

Returns the feed title.
public SyndContent

Returns:

the feed title, null if none.
getTitleEx
()

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

Returns the feed title as a text construct.
public String

Returns:

the feed URI, null if none.
getUri
()

Implements com.rometools.rome.feed.synd.SyndFeed.getUri.

Returns the feed URI.
public String
getWebMaster()

Implements com.rometools.rome.feed.synd.SyndFeed.getWebMaster.

The email address of the webmaster for the site, the person to contact if there are technical problems with the channel.
public int

Returns:

the hashcode of the bean object.
hashCode
()

Overrides java.lang.Object.hashCode.

Returns a hashcode value for the object.
public boolean
public WireFeed

Returns:

The WireFeed this was created from, or null
originalWireFeed
()

Implements com.rometools.rome.feed.synd.SyndFeed.originalWireFeed.

Returns the WireFeed this SyndFeed was created from.
public void
setAuthor(final String
the feed author to set, null if none.
author
)

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

Sets the feed author.
public void
setAuthors(final List<SyndPerson>
the feed authors to set, null if none.
authors
)

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

Sets the feed authors.
public void
setCategories(final List<SyndCategory>
the list of SyndCategoryImpl elements with the feed categories to set, an empty list or null if none.
categories
)

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

Sets the feed categories.
public void
setContributors(final List<SyndPerson>
the feed contributors to set, null if none.
contributors
)

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

Sets the feed author.
public void
setCopyright(final String
the feed copyright to set, null if none.
copyright
)

Implements com.rometools.rome.feed.synd.SyndFeed.setCopyright.

Sets the feed copyright.
public void
setDescription(final String
the feed description to set, null if none.
description
)

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

Sets the feed description.
public void
setDescriptionEx(final SyndContent
the feed description to set, null if none.
description
)

Implements com.rometools.rome.feed.synd.SyndFeed.setDescriptionEx.

Sets the feed description as a text construct.
public void
setDocs(final String
description URL
docs
)

Implements com.rometools.rome.feed.synd.SyndFeed.setDocs.

This tag should contain a URL that references a description of the channel.
public void
setEncoding(final String
the charset encoding of the feed.
encoding
)

Implements com.rometools.rome.feed.synd.SyndFeed.setEncoding.

Sets the charset encoding of a the feed.
public void
setEntries(final List<SyndEntry>
the list of SyndEntryImpl elements with the feed entries to set, an empty list or null if none.
entries
)

Implements com.rometools.rome.feed.synd.SyndFeed.setEntries.

Sets the feed entries.
public void
setFeedType(final String
the feed type to set, null if none.
feedType
)

Implements com.rometools.rome.feed.synd.SyndFeed.setFeedType.

Sets the wire feed type the feed will-have when coverted to a WireFeed.
public void
setForeignMarkup(final List<Element>
Opaque object to discourage use
foreignMarkup
)

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

Sets foreign markup found at channel level.
public void
setGenerator(final String
indicating the program
generator
)

Implements com.rometools.rome.feed.synd.SyndFeed.setGenerator.

A string indicating the program used to generate the channel.
public void
setIcon(final SyndImage
the feed icon to set, null if none.
icon
)

Implements com.rometools.rome.feed.synd.SyndFeed.setIcon.

Sets the feed icon.
public void
setImage(final SyndImage
the feed image to set, null if none.
image
)

Implements com.rometools.rome.feed.synd.SyndFeed.setImage.

Sets the feed image.
public void
setLanguage(final String
the feed language to set, null if none.
language
)

Implements com.rometools.rome.feed.synd.SyndFeed.setLanguage.

Sets the feed language.
public void
setManagingEditor(final String
email address of the managing editor
managingEditor
)

Implements com.rometools.rome.feed.synd.SyndFeed.setManagingEditor.

The email address of the managing editor of the site, the person to contact for editorial inquiries.
public void
setModules(final List<Module>
the list of ModuleImpl elements with the feed modules to set, an empty list or null if none.
modules
)

Implements com.rometools.rome.feed.synd.SyndFeed.setModules.

Sets the feed modules.
public void
setPublishedDate(final Date
the feed published date to set, null if none.
publishedDate
)

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

Sets the feed published date.
public void
setStyleSheet(final String
URL or null
styleSheet
)

Implements com.rometools.rome.feed.synd.SyndFeed.setStyleSheet.

URL of XSL-Stylesheet.
public void
setTitle(final String
the feed title to set, null if none.
title
)

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

Sets the feed title.
public void
setTitleEx(final SyndContent
the feed title to set, null if none.
title
)

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

Sets the feed title as a text construct.
public void
setUri(final String
the feed URI to set, null if none.
uri
)

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

Sets the feed URI.
public void
setWebMaster(final String
email address of the webmaster
webMaster
)

Implements com.rometools.rome.feed.synd.SyndFeed.setWebMaster.

The email address of the webmaster for the site, the person to contact if there are technical problems with the channel.
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