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