org.clapper.curn
Interface PostFeedParsePlugIn

All Superinterfaces:

PlugIn

All Known Implementing Classes:

AllowEmbeddedHTMLPlugIn, ArticleFilterPlugIn, EmptyArticleSummaryPlugIn, FeedMaxSummarySizePlugIn, IgnoreDuplicateArticlesPlugIn, MetaPlugIn, ParsedFeedURLEditPlugIn, ShowAuthorsPlugIn, ShowDatesPlugIn, SortArticlesPlugIn, TitleOverridePlugIn

public interface PostFeedParsePlugIn
extends PlugIn

This interface defines the methods that must be supported by plug-ins that wish to be notified just after curn downloads a feed.

Version:

$Revision: 6300 $

See Also:

PlugIn, MetaPlugIn, PreFeedDownloadPlugIn, PostFeedDownloadPlugIn, Curn

Method Summary

boolean

runPostFeedParsePlugIn(FeedInfo feedInfo, RSSChannel channel) Called immediately after a feed is parsed, but before it is otherwise processed.

Methods inherited from interface org.clapper.curn.PlugIn

getPlugInName, getPlugInSortKey, initPlugIn

Method Detail

runPostFeedParsePlugIn

boolean runPostFeedParsePlugIn(FeedInfo feedInfo,
                               RSSChannel channel)
                               throws CurnException

Called immediately after a feed is parsed, but before it is otherwise processed. A post-feed parse plug-in has access to the parsed RSS feed data, via an RSSChannel object. This method can return false to signal curn that the feed should be skipped. For instance, a plug-in that filters on the parsed feed data could use this method to weed out non-matching feeds before they are downloaded. Similarly, a plug-in that edits the parsed data (removing or editing individual items, for instance) could use method to do so.

Parameters:

feedInfo - the FeedInfo object for the feed that has been downloaded and parsed.

channel - the parsed channel data

Returns:

true if curn should continue to process the feed, false to skip the feed. A return value of false aborts all further processing on the feed. In particular, curn will not pass the feed along to other plug-ins that have yet to be notified of this event.

Throws:

CurnException - on error

See Also:

RSSChannel, FeedInfo