Groovy Documentation

org.jdesktop.swingx.ws.yahoo.rss
[Java] Class YahooRSS

java.lang.Object
  org.jdesktop.beans.AbstractBean
      org.jdesktop.swingx.ws.yahoo.rss.YahooRSS

public abstract class YahooRSS
extends org.jdesktop.beans.AbstractBean

Base class from which YahooRSS feeds extend. Implements common functionality, such as constructing the URL and actually reading the RSS feeds.

Authors:
rbair


Constructor Summary
YahooRSS()

Creates a new instance of YahooRSS

 
Method Summary
protected URL constructUrl()

Constructs the URL to return

protected Map getParameters()

Returns:
a Map of parameters used in constructing the URL.

protected String getUrlPrefix()

This method is called while YahooRSS constructs the URL.

com.sun.syndication.feed.synd.SyndFeed readFeed()

Reads a feed and returns the ROME SyndFeed object that was created by reading the feed.

 
Methods inherited from class org.jdesktop.beans.AbstractBean
org.jdesktop.beans.AbstractBean#clone(), org.jdesktop.beans.AbstractBean#addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), org.jdesktop.beans.AbstractBean#addPropertyChangeListener(java.beans.PropertyChangeListener), org.jdesktop.beans.AbstractBean#removePropertyChangeListener(java.beans.PropertyChangeListener), org.jdesktop.beans.AbstractBean#removePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), org.jdesktop.beans.AbstractBean#getPropertyChangeListeners(java.lang.String), org.jdesktop.beans.AbstractBean#getPropertyChangeListeners(), org.jdesktop.beans.AbstractBean#addVetoableChangeListener(java.lang.String, java.beans.VetoableChangeListener), org.jdesktop.beans.AbstractBean#addVetoableChangeListener(java.beans.VetoableChangeListener), org.jdesktop.beans.AbstractBean#removeVetoableChangeListener(java.lang.String, java.beans.VetoableChangeListener), org.jdesktop.beans.AbstractBean#removeVetoableChangeListener(java.beans.VetoableChangeListener), org.jdesktop.beans.AbstractBean#getVetoableChangeListeners(java.lang.String), org.jdesktop.beans.AbstractBean#getVetoableChangeListeners(), org.jdesktop.beans.AbstractBean#wait(), org.jdesktop.beans.AbstractBean#wait(long), org.jdesktop.beans.AbstractBean#wait(long, int), org.jdesktop.beans.AbstractBean#equals(java.lang.Object), org.jdesktop.beans.AbstractBean#toString(), org.jdesktop.beans.AbstractBean#hashCode(), org.jdesktop.beans.AbstractBean#getClass(), org.jdesktop.beans.AbstractBean#notify(), org.jdesktop.beans.AbstractBean#notifyAll()
 
Methods inherited from class Object
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll
 

Constructor Detail

YahooRSS

public YahooRSS()
Creates a new instance of YahooRSS


 
Method Detail

constructUrl

protected final URL constructUrl()
Constructs the URL to return


getParameters

protected Map getParameters()
Returns:
a Map of parameters used in constructing the URL. The toString() method will be called on each key and value in order to construct the param list. They will be URL encoded by YahooRSS, so you need not worry about url encoding the param ahead of time


getUrlPrefix

protected String getUrlPrefix()
This method is called while YahooRSS constructs the URL. This prefix MUST NOT contain the trailing "?" or any parameters. YahooRSS will query for those separately and do the work of combining them into a final URL. Hence, the url prefix is everything up to but not including the params
Returns:
a String representing the first part of the URL (including the http://)


readFeed

public com.sun.syndication.feed.synd.SyndFeed readFeed()
Reads a feed and returns the ROME SyndFeed object that was created by reading the feed. Note that this method blocks, and should be called on a background thread.
throws:
RSSException if something goes wrong while accessing the RSS feed
Returns:
the feed


 

Groovy Documentation