com.sun.syndication.feed.synd
インタフェース SyndEntry

すべてのスーパーインタフェース:
java.lang.Cloneable, CopyFrom, Extendable
既知の実装クラスの一覧:
SyndEntryImpl

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

Bean interface for entries of SyndFeedImpl feeds.


メソッドの概要
 java.lang.Object clone()
          Creates a deep clone of the object.
 java.lang.String getAuthor()
          Returns the name of the first entry author in the collection of authors.
 java.util.List getAuthors()
          Returns the entry authors.
 java.util.List getCategories()
          Returns the entry categories.
 java.util.List getContents()
          Returns the entry contents.
 java.util.List getContributors()
          Returns the feed author.
 SyndContent getDescription()
          Returns the entry description.
 java.util.List getEnclosures()
          Returns the entry enclosures.
 java.lang.Object getForeignMarkup()
          Returns foreign markup found at channel level.
 java.lang.String getLink()
          Returns the entry link.
 java.util.List getLinks()
          Returns the entry links
 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.
 SyndFeed getSource()
          Returns the entry source.
 java.lang.String getTitle()
          Returns the entry title.
 SyndContent getTitleEx()
          Returns the entry title as a text construct.
 java.util.Date getUpdatedDate()
          Returns the entry updated date.
 java.lang.String getUri()
          Returns the entry URI.
 void setAuthor(java.lang.String author)
          Sets the entry author.
 void setAuthors(java.util.List authors)
          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 setContributors(java.util.List contributors)
          Sets the feed contributors.
 void setDescription(SyndContent description)
          Sets the entry description.
 void setEnclosures(java.util.List enclosures)
          Sets the entry enclosures.
 void setForeignMarkup(java.lang.Object foreignMarkup)
          Sets foreign markup found at channel level.
 void setLink(java.lang.String link)
          Sets the entry link.
 void setLinks(java.util.List links)
          Sets the entry links.
 void setModules(java.util.List modules)
          Sets the entry modules.
 void setPublishedDate(java.util.Date publishedDate)
          Sets the entry published date.
 void setSource(SyndFeed source)
          Sets the entry source feed (for use if different from containing feed)
 void setTitle(java.lang.String title)
          Sets the entry title.
 void setTitleEx(SyndContent title)
          Sets the entry title as a text construct.
 void setUpdatedDate(java.util.Date updatedDate)
          Sets the entry updated date.
 void setUri(java.lang.String uri)
          Sets the entry URI.
 
インタフェース com.sun.syndication.feed.CopyFrom から継承されたメソッド
copyFrom, getInterface
 

メソッドの詳細

getUri

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.

戻り値:
the entry URI, null if none.

setUri

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.

パラメータ:
uri - the entry URI to set, null if none.

getTitle

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

戻り値:
the entry title, null if none.

setTitle

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

パラメータ:
title - the entry title to set, null if none.

getTitleEx

SyndContent getTitleEx()
Returns the entry title as a text construct.

戻り値:
the entry title, null if none.

setTitleEx

void setTitleEx(SyndContent title)
Sets the entry title as a text construct.

パラメータ:
title - the entry title to set, null if none.

getLink

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

戻り値:
the entry link, null if none.

setLink

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

パラメータ:
link - the entry link to set, null if none.

getLinks

java.util.List getLinks()
Returns the entry links

戻り値:
the entry links, null if none.

setLinks

void setLinks(java.util.List links)
Sets the entry links.

パラメータ:
links - the entry links to set, null if none.

getDescription

SyndContent getDescription()
Returns the entry description.

戻り値:
the entry description, null if none.

setDescription

void setDescription(SyndContent description)
Sets the entry description.

パラメータ:
description - the entry description to set, null if none.

getContents

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

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

setContents

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

パラメータ:
contents - the list of SyndContentImpl elements with the entry contents to set, an empty list or null if none.

getEnclosures

java.util.List getEnclosures()
Returns the entry enclosures.

戻り値:
a list of SyndEnclosure elements with the entry enclosures, an empty list if none.

setEnclosures

void setEnclosures(java.util.List enclosures)
Sets the entry enclosures.

パラメータ:
enclosures - the list of SyndEnclosure elements with the entry enclosures to set, an empty list or null if none.

getPublishedDate

java.util.Date getPublishedDate()
Returns the entry published date.

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

戻り値:
the entry published date, null if none.

setPublishedDate

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.

パラメータ:
publishedDate - the entry published date to set, null if none.

getUpdatedDate

java.util.Date getUpdatedDate()
Returns the entry updated date.

戻り値:
the entry updated date, null if none.

setUpdatedDate

void setUpdatedDate(java.util.Date updatedDate)
Sets the entry updated date.

パラメータ:
updatedDate - the entry updated date to set, null if none.

getAuthors

java.util.List getAuthors()
Returns the entry authors.

For Atom feeds, this returns the authors as a list of SyndPerson objects, for RSS feeds this method is a convenience method, it maps to the Dublin Core module creator.

戻り値:
the feed author, null if none.

setAuthors

void setAuthors(java.util.List authors)
Sets the entry author.

For Atom feeds, this sets the authors as a list of SyndPerson objects, for RSS feeds this method is a convenience method, it maps to the Dublin Core module creator.

パラメータ:
authors - the feed author to set, null if none.

getAuthor

java.lang.String getAuthor()
Returns the name of the first entry author in the collection of authors.

For Atom feeds, this returns the authors as a list of SyndPerson objects, for RSS feeds this method is a convenience method, it maps to the Dublin Core module creator.

戻り値:
the feed author, null if none.

setAuthor

void setAuthor(java.lang.String author)
Sets the entry author.

For Atom feeds, this sets the feed author's name, for RSS feeds this method is a convenience method, it maps to the Dublin Core module creator.

パラメータ:
author - the feed author to set, null if none.

getContributors

java.util.List getContributors()
Returns the feed author.

For Atom feeds, this returns the contributors as a list of SyndPerson objects

戻り値:
the feed author, null if none.

setContributors

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

Returns contributors as a list of SyndPerson objects.

パラメータ:
contributors - the feed contributors to set, null if none.

getCategories

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

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

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

setCategories

void setCategories(java.util.List categories)
Sets the entry categories.

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

パラメータ:
categories - the list of SyndCategoryImpl elements with the entry categories to set, an empty list or null if none.

getSource

SyndFeed getSource()
Returns the entry source.

This returns the entry source as a SyndFeed

戻り値:
the SyndFeed to which this entry is attributed

setSource

void setSource(SyndFeed source)
Sets the entry source feed (for use if different from containing feed)

パラメータ:
source - the original SyndFeed that contained this article

getModule

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

定義:
インタフェース Extendable 内の getModule
パラメータ:
uri - the URI of the ModuleImpl.
戻り値:
The module with the given URI, null if none.

getModules

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

定義:
インタフェース Extendable 内の getModules
戻り値:
a list of ModuleImpl elements with the entry modules, an empty list if none.

setModules

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

定義:
インタフェース Extendable 内の setModules
パラメータ:
modules - the list of ModuleImpl elements with the entry modules to set, an empty list or null if none.

getForeignMarkup

java.lang.Object getForeignMarkup()
Returns foreign markup found at channel level.

戻り値:
Opaque object to discourage use

setForeignMarkup

void setForeignMarkup(java.lang.Object foreignMarkup)
Sets foreign markup found at channel level.

パラメータ:
foreignMarkup - Opaque object to discourage use

clone

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

戻り値:
a clone of the object.
例外:
java.lang.CloneNotSupportedException - thrown if an element of the object cannot be cloned.