org.clapper.curn.plugins
Class DisableOutputHandlerPlugIn

java.lang.Object
  org.clapper.curn.plugins.DisableOutputHandlerPlugIn

All Implemented Interfaces:

OutputHandlerConfigItemPlugIn, PlugIn

public class DisableOutputHandlerPlugIn
extends java.lang.Object
implements OutputHandlerConfigItemPlugIn

The DisableOutputHandlerPlugIn handles disabling an output handler. It intercepts the following per-handler configuration parameters:

Disabled	Flag indicating whether or not to disable the output handler.

Version:

$Revision: 6491 $

Constructor Summary

DisableOutputHandlerPlugIn()
Default constructor (required).

Method Summary

java.lang.String	getPlugInName() Get a displayable name for the plug-in.
java.lang.String	getPlugInSortKey() Get the sort key for this plug-in.
void	initPlugIn() Initialize the plug-in.
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DisableOutputHandlerPlugIn

public DisableOutputHandlerPlugIn()

Default constructor (required).

Method Detail

getPlugInName

public java.lang.String getPlugInName()

Get a displayable name for the plug-in.

Specified by:

getPlugInName in interface PlugIn

Returns:

the name

getPlugInSortKey

public java.lang.String getPlugInSortKey()

Get the sort key for this plug-in.

Specified by:

getPlugInSortKey in interface PlugIn

Returns:

the sort key string.

initPlugIn

public void initPlugIn()
                throws CurnException

Initialize the plug-in. This method is called before any of the plug-in methods are called.

Specified by:

initPlugIn in interface PlugIn

Throws:

CurnException - on error

runOutputHandlerConfigItemPlugIn

public 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.

Specified by:

runOutputHandlerConfigItemPlugIn in interface OutputHandlerConfigItemPlugIn

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