com.sun.syndication.feed
public abstract class WireFeed extends Object implements Cloneable, Serializable, Extendable
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
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 | |
---|---|
Object | clone()
Creates a deep 'bean' clone of the object.
|
boolean | equals(Object other)
Indicates whether some other object is "equal to" this one as defined by the Object equals() method.
|
String | getEncoding()
Returns the charset encoding of a the feed.
|
String | getFeedType()
Returns the type of the feed.
|
Object | getForeignMarkup()
Returns foreign markup found at channel level.
|
Module | getModule(String uri)
Returns the module identified by a given URI.
|
List | getModules()
Returns the channel modules.
|
int | hashCode()
Returns a hashcode value for the object.
|
void | setEncoding(String encoding)
Sets the charset encoding of a the feed.
|
void | setFeedType(String feedType)
Sets the feedType of a the feed. |
void | setForeignMarkup(Object foreignMarkup)
Sets foreign markup found at channel level.
|
void | setModules(List modules)
Sets the channel modules.
|
String | toString()
Returns the String representation for the object.
|
Parameters: type of the feed to create.
Returns: a clone of the object.
Throws: CloneNotSupportedException thrown if an element of the object cannot be cloned.
Parameters: other he reference object with which to compare.
Returns: true if 'this' object is equal to the 'other' object.
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.
Returns: the type of the feed.
Returns: Opaque object to discourage use
Parameters: uri the URI of the ModuleImpl.
Returns: The module with the given URI, null if none.
Returns: a list of ModuleImpl elements with the channel modules, an empty list if none.
It follows the contract defined by the Object hashCode() method.
Returns: the hashcode of the bean object.
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.
Parameters: feedType the feedType of the feed.
Parameters: foreignMarkup Opaque object to discourage use
Parameters: modules the list of ModuleImpl elements with the channel modules to set, an empty list or null if none.
Returns: String representation for the object.