| java.lang.Object
 com.sun.syndication.feed.WireFeed
All known Subclasses: com.sun.syndication.feed.atom.Feed, com.sun.syndication.feed.rss.Channel,
| WireFeed | | abstract public class WireFeed implements Cloneable,Serializable,Extendable(Code) | | Parent class of the RSS (Channel) and Atom (Feed) feed beans.
NOTE: We don't like this class at this package level but the alternative would have
been a proliferation of packages (one more level to hold atom and rss package with
this class just in that package).
The format of the 'type' property must be [FEEDNAME]_[FEEDVERSION] with the FEEDNAME in lower case,
for example: rss_0.9, rss_0.93, atom_0.3
author:
Alejandro Abdelnur |
| Constructor Summary | |
| protected | WireFeed()
Default constructor, for bean cloning purposes only. | | protected | WireFeed(String type)
Creates a feed for a given type. |
| Method Summary | |
| public Object | clone()
Creates a deep 'bean' clone of the object. | | public boolean | equals(Object other)
Indicates whether some other object is "equal to" this one as defined by the Object equals() method.
Parameters:
other - he reference object with which to compare. | | public String | getEncoding()
Returns the charset encoding of a the feed.
This property is not set by feed parsers. | | public String | getFeedType()
Returns the type of the feed. | | public Object | getForeignMarkup()
Returns foreign markup found at channel level. | | public Module | getModule(String uri)
Returns the module identified by a given URI.
Parameters:
uri - the URI of the ModuleImpl. | | public List | getModules()
Returns the channel modules. | | public int | hashCode()
Returns a hashcode value for the object. | | public void | setEncoding(String encoding)
Sets the charset encoding of a the feed.
This property is not set by feed parsers. | | public void | setFeedType(String feedType)
Sets the feedType of a the feed. | | public void | setForeignMarkup(Object foreignMarkup)
Sets foreign markup found at channel level. | | public void | setModules(List modules)
Sets the channel modules. | | public String | toString()
Returns the String representation for the object. |
| WireFeed | | protected WireFeed()(Code) | | Default constructor, for bean cloning purposes only.
|
| WireFeed | | protected WireFeed(String type)(Code) | | Creates a feed for a given type.
Parameters:
type - of the feed to create. |
| equals | | public boolean equals(Object other)(Code) | | Indicates whether some other object is "equal to" this one as defined by the Object equals() method.
Parameters:
other - he reference object with which to compare. true if 'this' object is equal to the 'other' object. |
| getEncoding | | public String getEncoding()(Code) | | Returns the charset encoding of a the feed.
This property is not set by feed parsers. But it is used by feed generators
to set the encoding in the XML prolog.
the charset encoding of the feed. |
| getFeedType | | public String getFeedType()(Code) | | Returns the type of the feed.
the type of the feed. |
| getForeignMarkup | | public Object getForeignMarkup()(Code) | | Returns foreign markup found at channel level.
Opaque object to discourage use |
| getModule | | public Module getModule(String uri)(Code) | | Returns the module identified by a given URI.
Parameters:
uri - the URI of the ModuleImpl. The module with the given URI, null if none. |
| getModules | | public List getModules()(Code) | | Returns the channel modules.
a list of ModuleImpl elements with the channel modules,an empty list if none. |
| hashCode | | public int hashCode()(Code) | | Returns a hashcode value for the object.
It follows the contract defined by the Object hashCode() method.
the hashcode of the bean object. |
| setEncoding | | public void setEncoding(String encoding)(Code) | | Sets the charset encoding of a the feed.
This property is not set by feed parsers. But it is used by feed generators
to set the encoding in the XML prolog.
Parameters:
encoding - the charset encoding of the feed. |
| setFeedType | | public void setFeedType(String feedType)(Code) | | Sets the feedType of a the feed. Do not use, for bean cloning purposes only.
Parameters:
feedType - the feedType of the feed. |
| setForeignMarkup | | public void setForeignMarkup(Object foreignMarkup)(Code) | | Sets foreign markup found at channel level.
Parameters:
foreignMarkup - Opaque object to discourage use |
| setModules | | public void setModules(List modules)(Code) | | Sets the channel modules.
Parameters:
modules - the list of ModuleImpl elements with the channel modules to set,an empty list or null if none. |
| toString | | public String toString()(Code) | | Returns the String representation for the object.
String representation for the object. |
|
|