Package io.toro.martini

Class RssMethods

java.lang.Object

io.toro.martini.RssMethods

public final class RssMethods
extends Object

Contains one-liners for RSS-related operations.

Constructor Summary

Constructors

Constructor	Description
RssMethods(SyndFeedClient syndFeedClient)

Method Summary

Modifier and Type	Method	Description
static GloopModel	readRss(String url)	Read and return an RSS feed from a URL.
static GloopModel	readRss(String url, boolean onlyNew)	Read and return an RSS feed from a URL.
static SyndFeed	rss(String url)	Read and return an RSS feed from a URL.
static SyndFeed	rss(String url, boolean onlyNew)	Read and return an RSS feed from a URL.
static String	rssToString(GloopModel feedModel)	Get the string representation of a feed.
static void	rssToWriter(GloopModel feedModel, Writer writer)	Writes a feed to a Writer the XML representation of the feed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RssMethods

@Autowired
public RssMethods(@Lazy
                  SyndFeedClient syndFeedClient)

Method Detail

rss

public static SyndFeed rss(String url)

Read and return an RSS feed from a URL. Loaded entries for any RSS URL will be cached at ${martini-home}/data/rss. Only new RSS feed items will be returned by this one-liner.

Example usage:

 def feed = 'http://news.google.com/?output=rss'.rss()
 def titles = feed.entries.collect {
     it.title
 }
 

Parameters:

url - the URL where the RSS feed will be read from

Returns:

the RSS feed from the provided URL

Since:

1.0

rss

public static SyndFeed rss(String url,
                           boolean onlyNew)

Read and return an RSS feed from a URL. Loaded entries for any RSS URL will be cached at ${martini-home}/data/rss.

Example usage:

 def feed = 'http://news.google.com/?output=rss'.rss( false )
 def titles = feed.entries.collect {
     it.title
 }
 

Parameters:

url - the URL where the RSS feed will be read from

onlyNew - flag determining whether or not only new RSS feed items will be included in the returned feed

Returns:

the RSS feed from the provided URL

Since:

1.0

readRss

@GloopObjectParameter("output{\n  RSSFeed#io.toro.martini.rss.Feed{\n  }\n}")
public static GloopModel readRss(@GloopParameter(allowNull=false)
                                 String url)

Read and return an RSS feed from a URL. Loaded entries for any RSS URL will be cached at ${martini-home}/data/rss. Only new RSS feed items will be returned by this one-liner.

Example usage:

 def feed = 'http://news.google.com/?output=rss'.rss()
 def titles = feed.entries.collect {
     it.title
 }
 

Parameters:

url - the URL where the RSS feed will be read from

Returns:

the RSS feed from the provided URL

Since:

1.0

readRss

@GloopObjectParameter("output{\n  RSSFeed#io.toro.martini.rss.Feed{\n  }\n}")
public static GloopModel readRss(@GloopParameter(allowNull=false)
                                 String url,
                                 boolean onlyNew)

Read and return an RSS feed from a URL. Loaded entries for any RSS URL will be cached at ${martini-home}/data/rss.

Example usage:

 def feed = 'http://news.google.com/?output=rss'.rss( false )
 def titles = feed.entries.collect {
     it.title
 }
 

Parameters:

url - the URL where the RSS feed will be read from

onlyNew - flag determining whether or not only new RSS feed items will be included in the returned feed

Returns:

the RSS feed from the provided URL

Since:

1.0

rssToString

public static String rssToString(@GloopParameter(allowNull=false)
                                 GloopModel feedModel)
                          throws IOException,
                                 FeedException

Get the string representation of a feed.

Parameters:

feedModel - the feed

Returns:

an XML string representation of the provided feed

Throws:

IOException - if there was any problem encountered when writing to the Writer

FeedException - if the XML representation of the feed cannot be created

rssToWriter

public static void rssToWriter(@GloopParameter(allowNull=false)
                               GloopModel feedModel,
                               @GloopParameter(allowNull=false)
                               Writer writer)
                        throws IOException,
                               FeedException

Writes a feed to a Writer the XML representation of the feed.

Parameters:

feedModel - the feed to write

writer - where the feed's XML representation will be written

Throws:

IOException - if there was any problem encountered when writing to the Writer

FeedException - if the XML representation of the feed cannot be created