com.sun.syndication.feed

Class WireFeed

public abstract class WireFeed extends Object implements Cloneable, Serializable, Extendable

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

Field Summary
String_encoding
String_feedType
List_foreignMarkup
List_modules
ObjectBean_objBean
Constructor Summary
protected WireFeed()
Default constructor, for bean cloning purposes only.
protected WireFeed(String type)
Creates a feed for a given type.
Method Summary
Objectclone()
Creates a deep 'bean' clone of the object.
booleanequals(Object other)
Indicates whether some other object is "equal to" this one as defined by the Object equals() method.
StringgetEncoding()
Returns the charset encoding of a the feed.
StringgetFeedType()
Returns the type of the feed.
ObjectgetForeignMarkup()
Returns foreign markup found at channel level.
ModulegetModule(String uri)
Returns the module identified by a given URI.
ListgetModules()
Returns the channel modules.
inthashCode()
Returns a hashcode value for the object.
voidsetEncoding(String encoding)
Sets the charset encoding of a the feed.
voidsetFeedType(String feedType)
Sets the feedType of a the feed.
voidsetForeignMarkup(Object foreignMarkup)
Sets foreign markup found at channel level.
voidsetModules(List modules)
Sets the channel modules.
StringtoString()
Returns the String representation for the object.

Field Detail

_encoding

private String _encoding

_feedType

private String _feedType

_foreignMarkup

private List _foreignMarkup

_modules

private List _modules

_objBean

private ObjectBean _objBean

Constructor Detail

WireFeed

protected WireFeed()
Default constructor, for bean cloning purposes only.

WireFeed

protected WireFeed(String type)
Creates a feed for a given type.

Parameters: type of the feed to create.

Method Detail

clone

public Object clone()
Creates a deep 'bean' clone of the object.

Returns: a clone of the object.

Throws: CloneNotSupportedException thrown if an element of the object cannot be cloned.

equals

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.

Returns: true if 'this' object is equal to the 'other' object.

getEncoding

public String getEncoding()
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.

Returns: the charset encoding of the feed.

getFeedType

public String getFeedType()
Returns the type of the feed.

Returns: the type of the feed.

getForeignMarkup

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

Returns: Opaque object to discourage use

getModule

public Module getModule(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 List getModules()
Returns the channel modules.

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

hashCode

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

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

Returns: the hashcode of the bean object.

setEncoding

public void setEncoding(String encoding)
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)
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)
Sets foreign markup found at channel level.

Parameters: foreignMarkup Opaque object to discourage use

setModules

public void setModules(List modules)
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()
Returns the String representation for the object.

Returns: String representation for the object.

Copyright © Sun Microsystems. All Rights Reserved.