org.clapper.curn
Interface FeedConfigItemPlugIn

All Superinterfaces:

PlugIn

All Known Implementing Classes:

AllowEmbeddedHTMLPlugIn, ArticleFilterPlugIn, CommonXMLFixupsPlugIn, DisableFeedPlugIn, EmptyArticleSummaryPlugIn, FeedMaxSummarySizePlugIn, GzipDownloadPlugIn, IgnoreDuplicateArticlesPlugIn, MetaPlugIn, ParsedFeedURLEditPlugIn, RawFeedEditPlugIn, RawFeedSaveAsPlugIn, ShowAuthorsPlugIn, ShowDatesPlugIn, SortArticlesPlugIn, TitleOverridePlugIn, UserAgentPlugIn

public interface FeedConfigItemPlugIn
extends PlugIn

This interface defines the methods that must be supported by plug-ins that wish intercept curn feed-section configuration items.

Version:

$Revision: 6300 $

See Also:

PlugIn, MetaPlugIn, MainConfigItemPlugIn, OutputHandlerConfigItemPlugIn, UnknownSectionConfigItemPlugIn, Curn

Method Summary

boolean

runFeedConfigItemPlugIn(java.lang.String sectionName, java.lang.String paramName, CurnConfig config, FeedInfo feedInfo) Called immediately after curn has read and processed a configuration item in a "feed" configuration section.

Methods inherited from interface org.clapper.curn.PlugIn

getPlugInName, getPlugInSortKey, initPlugIn

Method Detail

runFeedConfigItemPlugIn

boolean runFeedConfigItemPlugIn(java.lang.String sectionName,
                                java.lang.String paramName,
                                CurnConfig config,
                                FeedInfo feedInfo)
                                throws CurnException

Called immediately after curn has read and processed a configuration item in a "feed" configuration section. All configuration items are passed, one by one, to each loaded plug-in. If a plug-in class is not interested in a particular configuration item, this method should simply return without doing anything. Note that some configuration items may simply be variable assignment; there's no real way to distinguish a variable assignment from a blessed configuration item.

Parameters:

sectionName - the name of the configuration section where the item was found

paramName - the name of the parameter

config - the CurnConfig object

feedInfo - partially complete FeedInfo object for the feed. The URL is guaranteed to be present, but no other fields are.

Returns:

true to continue processing the feed, false to skip it

Throws:

CurnException - on error

See Also:

CurnConfig, FeedInfo, FeedInfo.getURL()