概要  パッケージ   クラス  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド

com.sun.syndication.feed.synd
クラス SyndFeedImpl

java.lang.Object
  上位を拡張 com.sun.syndication.feed.synd.SyndFeedImpl
すべての実装されたインタフェース:
CopyFrom, Extendable, SyndFeed, java.io.Serializable, java.lang.Cloneable
public class SyndFeedImpl
extends java.lang.Object
implements java.io.Serializable, SyndFeed

Bean for all types of feeds.

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

関連項目:
直列化された形式

フィールドの概要
static java.util.Set CONVENIENCE_PROPERTIES
          Unmodifiable Set containing the convenience properties of this class.
 
コンストラクタの概要
  SyndFeedImpl()
          Default constructor.
protected SyndFeedImpl(java.lang.Class beanClass, java.util.Set convenienceProperties)
          For implementations extending SyndFeedImpl to be able to use the ObjectBean functionality with extended interfaces.
  SyndFeedImpl(WireFeed feed)
          Creates a SyndFeedImpl and populates all its properties out of the given RSS Channel or Atom Feed properties.
 
メソッドの概要
 java.lang.Object clone()
          Creates a deep 'bean' clone of the object.
 void copyFrom(java.lang.Object obj)
          Copies all the properties of the given bean into this one.
 WireFeed createWireFeed()
          Creates a real feed containing the information of the SyndFeedImpl.
 WireFeed createWireFeed(java.lang.String feedType)
          Creates a real feed containing the information of the SyndFeedImpl.
 boolean equals(java.lang.Object other)
          Indicates whether some other object is "equal to" this one as defined by the Object equals() method.
 java.lang.String getAuthor()
          Returns the feed author.
 java.util.List getAuthors()
          Returns the feed authors.
 java.util.List getCategories()
          Returns the feed categories.
 java.util.List getContributors()
          Returns the feed author.
 java.lang.String getCopyright()
          Returns the feed copyright.
 java.lang.String getDescription()
          Returns the feed description.
 SyndContent getDescriptionEx()
          Returns the feed description as a text construct.
 java.lang.String getEncoding()
          Returns the charset encoding of a the feed.
 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.
 java.lang.Object getForeignMarkup()
          Returns foreign markup found at channel level.
 SyndImage getImage()
          Returns the feed image.
 java.lang.Class getInterface()
          Returns the interface the copyFrom works on.
 java.lang.String getLanguage()
          Returns the feed language.
 java.lang.String getLink()
          Returns the feed link.
 java.util.List getLinks()
          Returns the links
 Module getModule(java.lang.String uri)
          Returns the module identified by a given URI.
 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 SyndFeedImpl supports when converting from and to.
 java.lang.String getTitle()
          Returns the feed title.
 SyndContent getTitleEx()
          Returns the feed title as a text construct.
 java.lang.String getUri()
          Returns the feed URI.
 int hashCode()
          Returns a hashcode value for the object.
 void setAuthor(java.lang.String author)
          Sets the feed author.
 void setAuthors(java.util.List authors)
          Sets the feed author.
 void setCategories(java.util.List categories)
          Sets the feed categories.
 void setContributors(java.util.List contributors)
          Sets the feed author.
 void setCopyright(java.lang.String copyright)
          Sets the feed copyright.
 void setDescription(java.lang.String description)
          Sets the feed description.
 void setDescriptionEx(SyndContent description)
          Sets the feed description as a text construct.
 void setEncoding(java.lang.String encoding)
          Sets the charset encoding of a the feed.
 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 setForeignMarkup(java.lang.Object foreignMarkup)
          Sets foreign markup found at channel level.
 void setImage(SyndImage 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 setLinks(java.util.List links)
          Set the links
 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.
 void setTitleEx(SyndContent title)
          Sets the feed title as a text construct.
 void setUri(java.lang.String uri)
          Sets the feed URI.
 java.lang.String toString()
          Returns the String representation for the object.
 
クラス java.lang.Object から継承されたメソッド
finalize, getClass, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

CONVENIENCE_PROPERTIES

public static final java.util.Set CONVENIENCE_PROPERTIES
Unmodifiable Set containing the convenience properties of this class.

Convenience properties are mapped to Modules, for cloning the convenience properties can be ignored as the will be copied as part of the module cloning.

コンストラクタの詳細

SyndFeedImpl

protected SyndFeedImpl(java.lang.Class beanClass,
                       java.util.Set convenienceProperties)
For implementations extending SyndFeedImpl to be able to use the ObjectBean functionality with extended interfaces.

パラメータ:
beanClass -
convenienceProperties - set containing the convenience properties of the SyndEntryImpl (the are ignored during cloning, check CloneableBean for details).

SyndFeedImpl

public SyndFeedImpl()
Default constructor. All properties are set to null.

SyndFeedImpl

public SyndFeedImpl(WireFeed feed)
Creates a SyndFeedImpl and populates all its properties out of the given RSS Channel or Atom Feed properties.

パラメータ:
feed - the RSS Channel or the Atom Feed to populate the properties from.
メソッドの詳細

getSupportedFeedTypes

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

定義:
インタフェース SyndFeed 内の getSupportedFeedTypes
戻り値:
the real feed type supported.

clone

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

定義:
インタフェース SyndFeed 内の clone
オーバーライド:
クラス java.lang.Object 内の clone
戻り値:
a clone of the object.
例外:
java.lang.CloneNotSupportedException - thrown if an element of the object cannot be cloned.

equals

public boolean equals(java.lang.Object other)
Indicates whether some other object is "equal to" this one as defined by the Object equals() method.

オーバーライド:
クラス java.lang.Object 内の equals
パラメータ:
other - he reference object with which to compare.
戻り値:
true if 'this' object is equal to the 'other' object.

hashCode

public int hashCode()
Returns a hashcode value for the object.

It follows the contract defined by the Object hashCode() method.

オーバーライド:
クラス java.lang.Object 内の hashCode
戻り値:
the hashcode of the bean object.

toString

public java.lang.String toString()
Returns the String representation for the object.

オーバーライド:
クラス java.lang.Object 内の toString
戻り値:
String representation for the object.

createWireFeed

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

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

定義:
インタフェース SyndFeed 内の createWireFeed
戻り値:
the real feed.

createWireFeed

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

定義:
インタフェース SyndFeed 内の createWireFeed
パラメータ:
feedType - the feed type for the WireFeed to be created.
戻り値:
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.

定義:
インタフェース SyndFeed 内の getFeedType
戻り値:
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.

定義:
インタフェース SyndFeed 内の setFeedType
パラメータ:
feedType - the feed type to set, null if none.

getEncoding

public java.lang.String getEncoding()
Returns the charset encoding of a the feed. This is not set by Rome parsers.

定義:
インタフェース SyndFeed 内の getEncoding
戻り値:
the charset encoding of the feed.

setEncoding

public void setEncoding(java.lang.String encoding)
Sets the charset encoding of a the feed. This is not set by Rome parsers.

定義:
インタフェース SyndFeed 内の setEncoding
パラメータ:
encoding - the charset encoding of the feed.

getUri

public java.lang.String getUri()
Returns the feed URI.

How the feed 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.

Note: The URI is the unique identifier, in the RSS 2.0/atom case this is the GUID, for RSS 1.0 this is the URI attribute of the item. The Link is the URL that the item is accessible under, the URI is the permanent identifier which the aggregator should use to reference this item. Often the URI will use some standardized identifier scheme such as DOI's so that items can be identified even if they appear in multiple feeds with different "links" (they might be on different hosting platforms but be the same item). Also, though rare, there could be multiple items with the same link but a different URI and associated metadata which need to be treated as distinct entities. In the RSS 1.0 case the URI must be a valid RDF URI reference.

定義:
インタフェース SyndFeed 内の getUri
戻り値:
the feed URI, null if none.

setUri

public void setUri(java.lang.String uri)
Sets the feed URI.

How the feed 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.

Note: The URI is the unique identifier, in the RSS 2.0/atom case this is the GUID, for RSS 1.0 this is the URI attribute of the item. The Link is the URL that the item is accessible under, the URI is the permanent identifier which the aggregator should use to reference this item. Often the URI will use some standardized identifier scheme such as DOI's so that items can be identified even if they appear in multiple feeds with different "links" (they might be on different hosting platforms but be the same item). Also, though rare, there could be multiple items with the same link but a different URI and associated metadata which need to be treated as distinct entities. In the RSS 1.0 case the URI must be a valid RDF URI reference.

定義:
インタフェース SyndFeed 内の setUri
パラメータ:
uri - the feed URI to set, null if none.

getTitle

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

定義:
インタフェース SyndFeed 内の getTitle
戻り値:
the feed title, null if none.

setTitle

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

定義:
インタフェース SyndFeed 内の setTitle
パラメータ:
title - the feed title to set, null if none.

getTitleEx

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

定義:
インタフェース SyndFeed 内の getTitleEx
戻り値:
the feed title, null if none.

setTitleEx

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

定義:
インタフェース SyndFeed 内の setTitleEx
パラメータ:
title - the feed title to set, null if none.

getLink

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

Note: The URI is the unique identifier, in the RSS 2.0/atom case this is the GUID, for RSS 1.0 this is the URI attribute of the item. The Link is the URL that the item is accessible under, the URI is the permanent identifier which the aggregator should use to reference this item. Often the URI will use some standardized identifier scheme such as DOI's so that items can be identified even if they appear in multiple feeds with different "links" (they might be on different hosting platforms but be the same item). Also, though rare, there could be multiple items with the same link but a different URI and associated metadata which need to be treated as distinct entities. In the RSS 1.0 case the URI must be a valid RDF URI reference.

定義:
インタフェース SyndFeed 内の getLink
戻り値:
the feed link, null if none.

setLink

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

Note: The URI is the unique identifier, in the RSS 2.0/atom case this is the GUID, for RSS 1.0 this is the URI attribute of the item. The Link is the URL that the item is accessible under, the URI is the permanent identifier which the aggregator should use to reference this item. Often the URI will use some standardized identifier scheme such as DOI's so that items can be identified even if they appear in multiple feeds with different "links" (they might be on different hosting platforms but be the same item). Also, though rare, there could be multiple items with the same link but a different URI and associated metadata which need to be treated as distinct entities. In the RSS 1.0 case the URI must be a valid RDF URI reference.

定義:
インタフェース SyndFeed 内の setLink
パラメータ:
link - the feed link to set, null if none.

getDescription

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

定義:
インタフェース SyndFeed 内の getDescription
戻り値:
the feed description, null if none.

setDescription

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

定義:
インタフェース SyndFeed 内の setDescription
パラメータ:
description - the feed description to set, null if none.

getDescriptionEx

public SyndContent getDescriptionEx()
Returns the feed description as a text construct.

定義:
インタフェース SyndFeed 内の getDescriptionEx
戻り値:
the feed description, null if none.

setDescriptionEx

public void setDescriptionEx(SyndContent description)
Sets the feed description as a text construct.

定義:
インタフェース SyndFeed 内の setDescriptionEx
パラメータ:
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.

定義:
インタフェース SyndFeed 内の getPublishedDate
戻り値:
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.

定義:
インタフェース SyndFeed 内の setPublishedDate
パラメータ:
publishedDate - the feed published date 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.

定義:
インタフェース SyndFeed 内の getCopyright
戻り値:
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.

定義:
インタフェース SyndFeed 内の setCopyright
パラメータ:
copyright - the feed copyright to set, null if none.

getImage

public SyndImage getImage()
Returns the feed image.

定義:
インタフェース SyndFeed 内の getImage
戻り値:
the feed image, null if none.

setImage

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

定義:
インタフェース SyndFeed 内の setImage
パラメータ:
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.

定義:
インタフェース SyndFeed 内の getCategories
戻り値:
a list of SyndCategoryImpl 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.

定義:
インタフェース SyndFeed 内の setCategories
パラメータ:
categories - the list of SyndCategoryImpl elements with the feed categories to set, an empty list or null if none.

getEntries

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

定義:
インタフェース SyndFeed 内の getEntries
戻り値:
a list of SyndEntryImpl elements with the feed entries, an empty list if none.

setEntries

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

定義:
インタフェース SyndFeed 内の setEntries
パラメータ:
entries - the list of SyndEntryImpl 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.

定義:
インタフェース SyndFeed 内の getLanguage
戻り値:
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.

定義:
インタフェース SyndFeed 内の setLanguage
パラメータ:
language - the feed language to set, null if none.

getModules

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

定義:
インタフェース Extendable 内の getModules
定義:
インタフェース SyndFeed 内の getModules
戻り値:
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 modules.

定義:
インタフェース Extendable 内の setModules
定義:
インタフェース SyndFeed 内の setModules
パラメータ:
modules - the list of ModuleImpl elements with the feed modules 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.

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

getInterface

public java.lang.Class getInterface()
インタフェース CopyFrom の記述:
Returns the interface the copyFrom works on.

This is useful when dealing with properties that may have multiple implementations. For example, Module.

定義:
インタフェース CopyFrom 内の getInterface
戻り値:
the interface the copyFrom works on.

copyFrom

public void copyFrom(java.lang.Object obj)
インタフェース CopyFrom の記述:
Copies all the properties of the given bean into this one.

Any existing properties in this bean are lost.

This method is useful for moving from one implementation of a bean interface to another. For example from the default SyndFeed bean implementation to a Hibernate ready implementation.

定義:
インタフェース CopyFrom 内の copyFrom
パラメータ:
obj - the instance to copy properties from.

getLinks

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

定義:
インタフェース SyndFeed 内の getLinks
戻り値:
Returns the links.

setLinks

public void setLinks(java.util.List links)
Set the links

定義:
インタフェース SyndFeed 内の setLinks
パラメータ:
links - The links to set.

getAuthors

public java.util.List getAuthors()
インタフェース SyndFeed の記述:
Returns the feed 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.

定義:
インタフェース SyndFeed 内の getAuthors
戻り値:
the feed author, null if none.

setAuthors

public void setAuthors(java.util.List authors)
インタフェース SyndFeed の記述:
Sets the feed 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.

定義:
インタフェース SyndFeed 内の setAuthors

getAuthor

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

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

定義:
インタフェース SyndFeed 内の getAuthor
戻り値:
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.

定義:
インタフェース SyndFeed 内の setAuthor
パラメータ:
author - the feed author to set, null if none.

getContributors

public java.util.List getContributors()
インタフェース SyndFeed の記述:
Returns the feed author.

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

定義:
インタフェース SyndFeed 内の getContributors
戻り値:
the feed author, null if none.

setContributors

public void setContributors(java.util.List contributors)
インタフェース SyndFeed の記述:
Sets the feed author.

Returns contributors as a list of SyndPerson objects.

定義:
インタフェース SyndFeed 内の setContributors

getForeignMarkup

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

定義:
インタフェース SyndFeed 内の getForeignMarkup
戻り値:
Opaque object to discourage use

setForeignMarkup

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

定義:
インタフェース SyndFeed 内の setForeignMarkup
パラメータ:
foreignMarkup - Opaque object to discourage use
概要  パッケージ   クラス  階層ツリー  非推奨 API  索引  ヘルプ 
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド