org.clapper.curn
Interface PostFeedDownloadPlugIn

All Superinterfaces:

PlugIn

All Known Implementing Classes:

CommonXMLFixupsPlugIn, MetaPlugIn, RawFeedEditPlugIn, RawFeedSaveAsPlugIn

public interface PostFeedDownloadPlugIn
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, PostFeedParsePlugIn, Curn

Method Summary

boolean

runPostFeedDownloadPlugIn(FeedInfo feedInfo, java.io.File feedDataFile, java.lang.String encoding) Called immediately after a feed is downloaded.

Methods inherited from interface org.clapper.curn.PlugIn

getPlugInName, getPlugInSortKey, initPlugIn

Method Detail

runPostFeedDownloadPlugIn

boolean runPostFeedDownloadPlugIn(FeedInfo feedInfo,
                                  java.io.File feedDataFile,
                                  java.lang.String encoding)
                                  throws CurnException

Called immediately after a feed is downloaded. This method can return false to signal curn that the feed should be skipped. For instance, a plug-in that filters on the unparsed XML feed content could use this method to weed out non-matching feeds before they are downloaded.

Parameters:

feedInfo - the FeedInfo object for the feed that has been downloaded

feedDataFile - the file containing the downloaded, unparsed feed XML. curn may delete this file after all plug-ins are notified!

encoding - the encoding used to store the data in the file, or null for the default

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:

FeedInfo