Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.sun.syndication.feed
Class WireFeed  view WireFeed download WireFeed.java

java.lang.Object
  extended bycom.sun.syndication.feed.WireFeed
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

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


Field Summary
private  java.lang.String _encoding
           
private  java.lang.String _feedType
           
private  java.util.List _modules
           
private  com.sun.syndication.feed.impl.ObjectBean _objBean
           
 
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.
 com.sun.syndication.feed.module.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
 

Field Detail

_objBean

private com.sun.syndication.feed.impl.ObjectBean _objBean

_feedType

private java.lang.String _feedType

_encoding

private java.lang.String _encoding

_modules

private java.util.List _modules
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.

Method Detail

clone

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


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.


hashCode

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

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


toString

public java.lang.String toString()
Returns the 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.


getFeedType

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


getEncoding

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


setEncoding

public void setEncoding(java.lang.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.


getModules

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


setModules

public void setModules(java.util.List modules)
Sets the channel modules.


getModule

public com.sun.syndication.feed.module.Module getModule(java.lang.String uri)
Returns the module identified by a given URI.