View Javadoc

1   package org.apache.commons.digester3.plugins.strategies;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.commons.logging.Log;
23  import org.apache.commons.digester3.Digester;
24  import org.apache.commons.digester3.plugins.RuleLoader;
25  
26  /**
27   * A RuleLoader which creates a single SetPropertiesRule and adds it to the digester when its addRules() method is
28   * invoked.
29   * <p>
30   * This loader ensures that any xml attributes on the plugin tag get mapped to equivalent properties on a javabean. This
31   * allows JavaBean classes to be used as plugins without any requirement to create custom plugin rules.
32   * 
33   * @since 1.6
34   */
35  public class LoaderSetProperties
36      extends RuleLoader
37  {
38  
39      /**
40       * {@inheritDoc}
41       */
42      @Override
43      public void addRules( Digester digester, String path )
44      {
45          Log log = digester.getLogger();
46          boolean debug = log.isDebugEnabled();
47          if ( debug )
48          {
49              log.debug( "LoaderSetProperties loading rules for plugin at path [" + path + "]" );
50          }
51  
52          digester.addSetProperties( path );
53      }
54  
55  }