org.apache.commons.digester.plugins.strategies.LoaderSetProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of antx-autoconfig Show documentation

The newest version!

/* $Id: LoaderSetProperties.java 471661 2006-11-06 08:09:25Z skitching $
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */ 
 
package org.apache.commons.digester.plugins.strategies;

import org.apache.commons.digester.Digester;
import org.apache.commons.logging.Log;
import org.apache.commons.digester.plugins.RuleLoader;

/**
 * A RuleLoader which creates a single SetPropertiesRule and adds it to the
 * digester when its addRules() method is invoked.
 * 
 * This loader ensures that any xml attributes on the plugin tag get
 * mapped to equivalent properties on a javabean. This allows JavaBean
 * classes to be used as plugins without any requirement to create custom
 * plugin rules.
 *
 * @since 1.6
 */

public class LoaderSetProperties extends RuleLoader {
    
    /**
     * Just add a SetPropertiesRule at the specified path.
     */
    public void addRules(Digester digester, String path) {
        Log log = digester.getLogger();
        boolean debug = log.isDebugEnabled();
        if (debug) {
            log.debug(
                "LoaderSetProperties loading rules for plugin at path [" 
                + path + "]");
        }

        digester.addSetProperties(path);
    }
}