com.sun.syndication.feed.atom
Class Feed

java.lang.Object
  extended bycom.sun.syndication.common.ObjectBean
      extended bycom.sun.syndication.feed.WireFeed
          extended bycom.sun.syndication.feed.atom.Feed
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable, ToString

public class Feed
extends WireFeed

Bean for Atom feeds.

It handles Atom feeds version 0.3 without loosing any feed information.

Author:
Alejandro Abdelnur
See Also:
Serialized Form

Constructor Summary
Feed()
          Default constructor, for bean cloning purposes only.
Feed(java.lang.String type)
          Feed Constructor.
 
Method Summary
 java.util.List getAlternateLinks()
          Returns the feed alternate links.
 Person getAuthor()
          Returns the feed author.
 java.util.List getContributors()
          Returns the feed contributors.
 java.lang.String getCopyright()
          Returns the feed copyright.
 java.util.List getEntries()
          Returns the feed entries.
 Generator getGenerator()
          Returns the feed generator.
 java.lang.String getId()
          Returns the feed ID.
 Content getInfo()
          Returns the feed info.
 java.lang.String getLanguage()
          Returns the feed language.
 java.util.Date getModified()
          Returns the feed modified date.
 Module getModule(java.lang.String uri)
          Returns the module identified by a given URI.
 java.util.List getModules()
          Returns the feed modules.
 java.util.List getOtherLinks()
          Returns the feed other links (non-alternate ones).
 Content getTagline()
          Returns the feed tag line.
 java.lang.String getTitle()
          Returns the feed title.
 void setAlternateLinks(java.util.List alternateLinks)
          Sets the feed alternate links.
 void setAuthor(Person author)
          Sets the feed author.
 void setContributors(java.util.List contributors)
          Sets the feed contributors.
 void setCopyright(java.lang.String copyright)
          Sets the feed copyright.
 void setEntries(java.util.List entries)
          Sets the feed entries.
 void setGenerator(Generator generator)
          Sets the feed generator.
 void setId(java.lang.String id)
          Sets the feed ID.
 void setInfo(Content info)
          Sets the feed info.
 void setLanguage(java.lang.String language)
          Sets the feed language.
 void setModified(java.util.Date modified)
          Sets the feed modified date.
 void setModules(java.util.List modules)
          Sets the feed moduless.
 void setOtherLinks(java.util.List otherLinks)
          Sets the feed other links (non-alternate ones).
 void setTagline(Content tagline)
          Sets the feed tagline.
 void setTitle(java.lang.String title)
          Sets the feed title.
 
Methods inherited from class com.sun.syndication.feed.WireFeed
getEncoding, getFeedType, setEncoding, setFeedType
 
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
 

Constructor Detail

Feed

public Feed()
Default constructor, for bean cloning purposes only.


Feed

public Feed(java.lang.String type)
Feed Constructor. All properties, except the type, are set to null.

Parameters:
type - the type of the Atom feed.
Method Detail

getLanguage

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

Returns:
the feed language, null if none.

setLanguage

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

Parameters:
language - the feed language 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.

getAlternateLinks

public java.util.List getAlternateLinks()
Returns the feed alternate links.

Returns:
a list of Link elements with the feed alternate links, an empty list if none.

setAlternateLinks

public void setAlternateLinks(java.util.List alternateLinks)
Sets the feed alternate links.

Parameters:
alternateLinks - the list of Link elements with the feed alternate links to set, an empty list or null if none.

getOtherLinks

public java.util.List getOtherLinks()
Returns the feed other links (non-alternate ones).

Returns:
a list of Link elements with the feed other links (non-alternate ones), an empty list if none.

setOtherLinks

public void setOtherLinks(java.util.List otherLinks)
Sets the feed other links (non-alternate ones).

Parameters:
otherLinks - the list of Link elements with the feed other links (non-alternate ones) to set, an empty list or null if none.

getAuthor

public Person getAuthor()
Returns the feed author.

Returns:
the feed author, null if none.

setAuthor

public void setAuthor(Person author)
Sets the feed author.

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

getContributors

public java.util.List getContributors()
Returns the feed contributors.

Returns:
a list of Person elements with the feed contributors, an empty list if none.

setContributors

public void setContributors(java.util.List contributors)
Sets the feed contributors.

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

getTagline

public Content getTagline()
Returns the feed tag line.

Returns:
the feed tag line, null if none.

setTagline

public void setTagline(Content tagline)
Sets the feed tagline.

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

getId

public java.lang.String getId()
Returns the feed ID.

Returns:
the feed ID, null if none.

setId

public void setId(java.lang.String id)
Sets the feed ID.

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

getGenerator

public Generator getGenerator()
Returns the feed generator.

Returns:
the feed generator, null if none.

setGenerator

public void setGenerator(Generator generator)
Sets the feed generator.

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

getCopyright

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

Returns:
the feed copyright, null if none.

setCopyright

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

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

getInfo

public Content getInfo()
Returns the feed info.

Returns:
the feed info, null if none.

setInfo

public void setInfo(Content info)
Sets the feed info.

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

getModified

public java.util.Date getModified()
Returns the feed modified date.

Returns:
the feed modified date, null if none.

setModified

public void setModified(java.util.Date modified)
Sets the feed modified date.

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

getEntries

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

Returns:
a list of Entry 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 Entry elements with the feed entries to set, an empty list or null if none.

getModules

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

Overrides:
getModules in class WireFeed
Returns:
a list of ModuleImpl elements with the feed modules, an empty list if none.

setModules

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

Overrides:
setModules in class WireFeed
Parameters:
modules - the list of ModuleImpl elements with the feed moduless to set, an empty list or null if none.

getModule

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

Overrides:
getModule in class WireFeed
Parameters:
uri - the URI of the ModuleImpl.
Returns:
The module with the given URI, null if none.


Copyright © 2004 Sun Microsystems. All Rights Reserved.