com.sun.syndication.feed.synd
Interface SyndEntry

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

public interface SyndEntry
extends ToString, java.lang.Cloneable, CopyFrom

Bean interface for entries of SyndFeedImpl feeds.

Author:
Alejandro Abdelnur

Method Summary
 java.lang.Object clone()
          Creates a deep clone of the object.
 java.lang.String getAuthor()
          Returns the entry author.
 java.util.List getCategories()
          Returns the entry categories.
 java.util.List getContents()
          Returns the entry contents.
 SyndContent getDescription()
          Returns the entry description.
 java.lang.String getLink()
          Returns the entry link.
 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.
 java.lang.String getTitle()
          Returns the entry title.
 java.lang.String getUri()
          Returns the entry URI.
 void setAuthor(java.lang.String author)
          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 setDescription(SyndContent description)
          Sets the entry description.
 void setLink(java.lang.String link)
          Sets the entry link.
 void setModules(java.util.List modules)
          Sets the entry modules.
 void setPublishedDate(java.util.Date publishedDate)
          Sets the entry published date.
 void setTitle(java.lang.String title)
          Sets the entry title.
 void setUri(java.lang.String uri)
          Sets the entry URI.
 
Methods inherited from interface com.sun.syndication.common.ToString
toString
 
Methods inherited from interface com.sun.syndication.common.CopyFrom
copyFrom, getInterface
 

Method Detail

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.

Returns:
the entry URI, null if none.

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.

Parameters:
uri - the entry URI to set, null if none.

getTitle

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

Returns:
the entry title, null if none.

setTitle

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

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

getLink

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

Returns:
the entry link, null if none.

setLink

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

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

getDescription

public SyndContent getDescription()
Returns the entry description.

Returns:
the entry description, null if none.

setDescription

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

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

getContents

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

Returns:
a list of SyndContentImpl elements with the entry contents, an empty list if none.

setContents

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

Parameters:
contents - the list of SyndContentImpl elements with the entry contents to set, an empty list or null if none.

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.

Returns:
the entry published date, null if none.

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.

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

getAuthor

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

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

Returns:
the entry author, null if none.

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.

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

getCategories

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

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

Returns:
a list of SyndCategoryImpl elements with the entry categories, an empty list if none.

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.

Parameters:
categories - the list of SyndCategoryImpl elements with the entry categories 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.

Parameters:
uri - the URI of the ModuleImpl.
Returns:
The module with the given URI, null if none.

getModules

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

Returns:
a list of ModuleImpl elements with the entry modules, an empty list if none.

setModules

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

Parameters:
modules - the list of ModuleImpl elements with the entry 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.