com.sun.syndication.feed
Class WireFeed

java.lang.Object
  extended bycom.sun.syndication.feed.WireFeed
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable
Direct Known Subclasses:
Channel, Feed

public abstract class WireFeed
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable

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
See Also:
Serialized Form

Constructor Summary
protected WireFeed()
          Default constructor, for bean cloning purposes only.
protected WireFeed(java.lang.String type)
          Creates a feed for a given type.
 
Method Summary
 java.lang.Object clone()
          Creates a deep 'bean' clone of the object.
 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 getEncoding()
          Returns the charset encoding of a the feed.
 java.lang.String getFeedType()
          Returns the type of the feed.
 Module getModule(java.lang.String uri)
          Returns the module identified by a given URI.
 java.util.List getModules()
          Returns the channel modules.
 int hashCode()
          Returns a hashcode value for the object.
 void setEncoding(java.lang.String encoding)
          Sets the charset encoding of a the feed.
 void setFeedType(java.lang.String feedType)
          Sets the feedType of a the feed.
 void setModules(java.util.List modules)
          Sets the channel modules.
 java.lang.String toString()
          Returns the String representation for the object.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WireFeed

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


WireFeed

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

Parameters:
type - of the feed to create.
Method Detail

clone

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

Returns:
a clone of the object.
Throws:
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.

Parameters:
other - he reference object with which to compare.
Returns:
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.

Returns:
the hashcode of the bean object.

toString

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

Returns:
String representation for the object.

setFeedType

public void setFeedType(java.lang.String feedType)
Sets the feedType of a the feed. Do not use, for bean cloning purposes only.

Parameters:
feedType - the feedType of the feed.

getFeedType

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

Returns:
the type of the feed.

getEncoding

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

Returns:
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.

Parameters:
encoding - the charset encoding of the feed.

getModules

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

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

setModules

public void setModules(java.util.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.

getModule

public Module getModule(java.lang.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.


Copyright © 2004-2005 Sun Microsystems. All Rights Reserved.