org.clapper.curn
Interface MainConfigItemPlugIn

All Superinterfaces:

PlugIn

All Known Implementing Classes:

AllowEmbeddedHTMLPlugIn, CommonXMLFixupsPlugIn, DataPersisterFactory, EmailOutputPlugIn, EmptyArticleSummaryPlugIn, FeedMaxSummarySizePlugIn, GzipDownloadPlugIn, MetaPlugIn, ShowAuthorsPlugIn, ShowDatesPlugIn, SortArticlesPlugIn, UserAgentPlugIn, ZipOutputPlugIn

public interface MainConfigItemPlugIn
extends PlugIn

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

Version:

$Revision: 6300 $

See Also:

PlugIn, MetaPlugIn, FeedConfigItemPlugIn, OutputHandlerConfigItemPlugIn, UnknownSectionConfigItemPlugIn, Curn

Method Summary

void	runMainConfigItemPlugIn(java.lang.String sectionName, java.lang.String paramName, CurnConfig config) Called immediately after curn has read and processed a configuration item in the main [curn] configuration section.

Methods inherited from interface org.clapper.curn.PlugIn

getPlugInName, getPlugInSortKey, initPlugIn

Method Detail

runMainConfigItemPlugIn

void runMainConfigItemPlugIn(java.lang.String sectionName,
                             java.lang.String paramName,
                             CurnConfig config)
                             throws CurnException

Called immediately after curn has read and processed a configuration item in the main [curn] 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

Throws:

CurnException - on error

See Also:

CurnConfig