001/* $Id: LoaderSetProperties.java 471661 2006-11-06 08:09:25Z skitching $
002 *
003 * Licensed to the Apache Software Foundation (ASF) under one or more
004 * contributor license agreements.  See the NOTICE file distributed with
005 * this work for additional information regarding copyright ownership.
006 * The ASF licenses this file to You under the Apache License, Version 2.0
007 * (the "License"); you may not use this file except in compliance with
008 * the License.  You may obtain a copy of the License at
009 * 
010 *      http://www.apache.org/licenses/LICENSE-2.0
011 * 
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */ 
018 
019package org.apache.commons.digester.plugins.strategies;
020
021import org.apache.commons.digester.Digester;
022import org.apache.commons.logging.Log;
023import org.apache.commons.digester.plugins.RuleLoader;
024
025/**
026 * A RuleLoader which creates a single SetPropertiesRule and adds it to the
027 * digester when its addRules() method is invoked.
028 * <p>
029 * This loader ensures that any xml attributes on the plugin tag get
030 * mapped to equivalent properties on a javabean. This allows JavaBean
031 * classes to be used as plugins without any requirement to create custom
032 * plugin rules.
033 *
034 * @since 1.6
035 */
036
037public class LoaderSetProperties extends RuleLoader {
038    
039    /**
040     * Just add a SetPropertiesRule at the specified path.
041     */
042    public void addRules(Digester digester, String path) {
043        Log log = digester.getLogger();
044        boolean debug = log.isDebugEnabled();
045        if (debug) {
046            log.debug(
047                "LoaderSetProperties loading rules for plugin at path [" 
048                + path + "]");
049        }
050
051        digester.addSetProperties(path);
052    }
053}
054