org.clapper.curn
Interface OutputHandlerConfigItemPlugIn

All Superinterfaces:

PlugIn

All Known Implementing Classes:

DisableOutputHandlerPlugIn, MetaPlugIn

public interface OutputHandlerConfigItemPlugIn
extends PlugIn

This interface defines the methods that must be supported by plug-ins that wish intercept curn output handler-related configuration items.

Version:

$Revision: 6300 $

See Also:

PlugIn, MetaPlugIn, FeedConfigItemPlugIn, MainConfigItemPlugIn, UnknownSectionConfigItemPlugIn, Curn

Method Summary

boolean

runOutputHandlerConfigItemPlugIn(java.lang.String sectionName, java.lang.String paramName, CurnConfig config, ConfiguredOutputHandler handler) Called immediately after curn has read and processed a configuration item in an output handler configuration section.

Methods inherited from interface org.clapper.curn.PlugIn

getPlugInName, getPlugInSortKey, initPlugIn

Method Detail

runOutputHandlerConfigItemPlugIn

boolean runOutputHandlerConfigItemPlugIn(java.lang.String sectionName,
                                         java.lang.String paramName,
                                         CurnConfig config,
                                         ConfiguredOutputHandler handler)
                                         throws CurnException

Called immediately after curn has read and processed a configuration item in an output handler 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

handler - partially complete ConfiguredOutputHandler object. The class name is guaranteed to be set, but the other fields may not be.

Returns:

true to continue processing the handler, false to skip it

Throws:

CurnException - on error

See Also:

CurnConfig, ConfiguredOutputHandler