View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.configuration.tree;
18  
19  /**
20   * <p>
21   * A simple adapter class that simplifies writing custom node visitor
22   * implementations.
23   * </p>
24   * <p>
25   * This class provides dummy implementations for the methods defined in the
26   * {@code ConfigurationNodeVisitor} interface. Derived classes only need
27   * to override the methods they really need.
28   * </p>
29   *
30   * @author <a
31   * href="http://commons.apache.org/configuration/team-list.html">Commons
32   * Configuration team</a>
33   * @version $Id: ConfigurationNodeVisitorAdapter.java 1206464 2011-11-26 15:49:10Z oheger $
34   */
35  public class ConfigurationNodeVisitorAdapter implements
36          ConfigurationNodeVisitor
37  {
38      /**
39       * Empty dummy implementation of this interface method.
40       *
41       * @param node the node
42       */
43      public void visitBeforeChildren(ConfigurationNode node)
44      {
45      }
46  
47      /**
48       * Empty dummy implementation of this interface method.
49       *
50       * @param node the node
51       */
52      public void visitAfterChildren(ConfigurationNode node)
53      {
54      }
55  
56      /**
57       * Dummy implementation of this interface method. Returns always <b>false</b>.
58       *
59       * @return the terminate flag
60       */
61      public boolean terminate()
62      {
63          return false;
64      }
65  }