rdonkin 2003/10/04 05:29:36
Added: digester/src/java/org/apache/commons/digester/plugins
PluginManager.java
Log:
Added plugins module. Submitted by Simon Kitching.
Revision Changes Path
1.1
jakarta-commons/digester/src/java/org/apache/commons/digester/plugins/PluginManager.java
Index: PluginManager.java
===================================================================
/*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-2003 The Apache Software Foundation. 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. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* 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 THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.commons.digester.plugins;
import java.util.HashMap;
import org.apache.commons.digester.Digester;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* Coordinates between PluginDeclarationRule and PluginCreateRule objects,
* providing a place to share data between instances of these rules.
* <p>
* One instance of this class exists per PluginRules instance,
* ie one per Digester instance.
*
* @author Simon Kitching
*/
public class PluginManager {
private static Log log = LogFactory.getLog(PluginManager.class);
/** Map of classname->Declaration */
private HashMap declarationsByClass_ = new HashMap();
/** Map of id->Declaration */
private HashMap declarationsById_ = new HashMap();
/** the parent manager to which this one may delegate lookups. */
private PluginManager parent_;
//------------------- constructors ---------------------------------------
/** Constructor. */
public PluginManager() {
}
/** Constructor. */
public PluginManager(PluginManager parent) {
parent_ = parent;
}
//------------------- methods --------------------------------------------
/**
* Add the declaration to the set of known declarations.
*
[EMAIL PROTECTED] decl an object representing a plugin class.
*/
public void addDeclaration(Declaration decl) {
Class pluginClass = decl.getPluginClass();
String id = decl.getId();
declarationsByClass_.put(pluginClass.getName(), decl);
if (id != null) {
declarationsById_.put(id, decl);
if (log.isDebugEnabled()) {
log.debug(
"Indexing plugin-id [" + id + "]"
+ " -> class [" + pluginClass.getName() + "]");
}
}
}
/**
* Return the declaration object with the specified class.
* If no such plugin is known, null is returned.
*/
public Declaration getDeclarationByClass(String className) {
Declaration decl =
(Declaration) declarationsByClass_.get(className);
if ((decl == null) && (parent_ != null)) {
decl = parent_.getDeclarationByClass(className);
}
return decl;
}
/**
* Return the declaration object with the specified id.
* If no such plugin is known, null is returned.
*
[EMAIL PROTECTED] id Description of the Parameter
[EMAIL PROTECTED] The declaration value
*/
public Declaration getDeclarationById(String id) {
Declaration decl = (Declaration) declarationsById_.get(id);
if ((decl == null) && (parent_ != null)) {
decl = parent_.getDeclarationById(id);
}
return decl;
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
