com.sun.syndication.feed.synd
Interface SyndFeedI

All Superinterfaces:
java.lang.Cloneable, ToString
All Known Implementing Classes:
SyndFeed

public interface SyndFeedI
extends ToString, java.lang.Cloneable

Bean interface for all types of feeds.

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

Author:
Alejandro Abdelnur

Method Summary
 java.lang.Object clone()
          Creates a deep clone of the object.
 WireFeed createWireFeed()
          Creates a rea feed containing the information of the SyndFeed.
 WireFeed createWireFeed(java.lang.String feedType)
          Creates a real feed containing the information of the SyndFeed.
 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.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.
 SyndImageI getImage()
          Returns the feed image.
 java.lang.String getLanguage()
          Returns the feed language.
 java.lang.String getLink()
          Returns the feed link.
 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 SyndFeed supports when converting from and to.
 java.lang.String getTitle()
          Returns the feed title.
 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 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(SyndImageI 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.
 
Methods inherited from interface com.sun.syndication.common.ToString
toString
 

Method Detail

getSupportedFeedTypes

public java.util.List getSupportedFeedTypes()
Returns the real feed types the SyndFeed supports when converting from and to.

Returns:
the real feed type supported.

createWireFeed

public WireFeed createWireFeed()
Creates a rea feed containing the information of the SyndFeed.

The feed type of the created WireFeed is taken from the SyndFeed feedType property.

Returns:
the real feed.

createWireFeed

public WireFeed createWireFeed(java.lang.String feedType)
Creates a real feed containing the information of the SyndFeed.

Parameters:
feedType - the feed type for the WireFeed to be created.
Returns:
the real feed.

getFeedType

public java.lang.String getFeedType()
Returns the wire feed type the feed had/will-have when coverted from/to a WireFeed.

Returns:
the feed type, null if none.

setFeedType

public void setFeedType(java.lang.String feedType)
Sets the wire feed type the feed will-have when coverted to a WireFeed.

Parameters:
feedType - the feed type to set, null if none.

getTitle

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

Returns:
the feed title, null if none.

setTitle

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

Parameters:
title - the feed title to set, null if none.

getLink

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

Returns:
the feed link, null if none.

setLink

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

Parameters:
link - the feed link to set, null if none.

getDescription

public java.lang.String getDescription()
Returns the feed description.

Returns:
the feed description, null if none.

setDescription

public void setDescription(java.lang.String description)
Sets the feed description.

Parameters:
description - the feed description to set, null if none.

getPublishedDate

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

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

Returns:
the feed published date, null if none.

setPublishedDate

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

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

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

getAuthor

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

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

Returns:
the feed author, null if none.

setAuthor

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

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

Parameters:
author - the feed author to set, null if none.

getCopyright

public java.lang.String getCopyright()
Returns the feed copyright.

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

Returns:
the feed copyright, null if none.

setCopyright

public void setCopyright(java.lang.String copyright)
Sets the feed copyright.

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

Parameters:
copyright - the feed copyright to set, null if none.

getImage

public SyndImageI getImage()
Returns the feed image.

Returns:
the feed image, null if none.

setImage

public void setImage(SyndImageI image)
Sets the feed image.

Parameters:
image - the feed image to set, null if none.

getCategories

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

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

Returns:
a list of SyndCategory elements with the feed categories, an empty list if none.

setCategories

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

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

Parameters:
categories - the list of SyndCategory elements with the feed categories to set, an empty list or null if none.

getEntries

public java.util.List getEntries()
Returns the feed entries.

Returns:
a list of SyndEntry elements with the feed entries, an empty list if none.

setEntries

public void setEntries(java.util.List entries)
Sets the feed entries.

Parameters:
entries - the list of SyndEntry elements with the feed entries to set, an empty list or null if none.

getLanguage

public java.lang.String getLanguage()
Returns the feed language.

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

Returns:
the feed language, null if none.

setLanguage

public void setLanguage(java.lang.String language)
Sets the feed language.

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

Parameters:
language - the feed language to set, null if none.

getModules

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

Returns:
a list of Module elements with the feed modules, an empty list if none.

setModules

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

Parameters:
modules - the list of Module elements with the feed modules to set, an empty list or null if none.

clone

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

Returns:
a clone of the object.
Throws:
java.lang.CloneNotSupportedException - thrown if an element of the object cannot be cloned.


Copyright © 2004 Sun Microsystems. All Rights Reserved.