/*---------------------------------------------------------------------------*\
$Id: PostConfigPlugIn.java 7041 2007-09-09 01:04:47Z bmc $
---------------------------------------------------------------------------
This software is released under a BSD-style license:
Copyright (c) 2004-2007 Brian M. Clapper. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. The end-user documentation included with the redistribution, if any,
must include the following acknowlegement:
"This product includes software developed by Brian M. Clapper
(bmc@clapper.org, http://www.clapper.org/bmc/). That software is
copyright (c) 2004-2007 Brian M. Clapper."
Alternately, this acknowlegement may appear in the software itself,
if wherever such third-party acknowlegements normally appear.
3. Neither the names "clapper.org", "curn", nor any of the names of the
project contributors may be used to endorse or promote products
derived from this software without prior written permission. For
written permission, please contact bmc@clapper.org.
4. Products derived from this software may not be called "curn", nor may
"clapper.org" appear in their names without prior written permission
of Brian M. Clapper.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
NO EVENT SHALL BRIAN M. CLAPPER BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\*---------------------------------------------------------------------------*/
package org.clapper.curn;
/**
* This interface defines the methods that must be supported by plug-ins
* that wish to be invoked right after <i>curn</i> finishes loading its
* configuration file.
*
* @see PlugIn
* @see MetaPlugIn
* @see MainConfigItemPlugIn
* @see FeedConfigItemPlugIn
* @see OutputHandlerConfigItemPlugIn
* @see UnknownSectionConfigItemPlugIn
* @see Curn
*
* @version <tt>$Revision: 7041 $</tt>
*/
public interface PostConfigPlugIn extends PlugIn
{
/*----------------------------------------------------------------------*\
Public Methods
\*----------------------------------------------------------------------*/
/**
* Called after the entire configuration has been read and parsed, but
* before any feeds are processed. Intercepting this event is useful
* for plug-ins that want to adjust the configuration. For instance,
* the <i>curn</i> command-line wrapper intercepts this plug-in event
* so it can adjust the configuration to account for command line
* options.
*
* @param config the parsed {@link CurnConfig} object
*
* @throws CurnException on error
*
* @see CurnConfig
*/
public void runPostConfigPlugIn (CurnConfig config)
throws CurnException;
}
|