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.configuration2.tree;
18  
19  /**
20   * <p>
21   * A simple adapter class that simplifies writing custom node visitor implementations.
22   * </p>
23   * <p>
24   * This class provides dummy implementations for the methods defined in the {@code ConfigurationNodeVisitor} interface.
25   * Derived classes only need to override the methods they really need.
26   * </p>
27   *
28   * @param <T> the type of the nodes processed by this visitor
29   */
30  public class ConfigurationNodeVisitorAdapter<T> implements ConfigurationNodeVisitor<T> {
31      /**
32       * {@inheritDoc} This implementation returns always <strong>false</strong>; this means that all nodes in the current hierarchy are
33       * traversed.
34       */
35      @Override
36      public boolean terminate() {
37          return false;
38      }
39  
40      /**
41       * {@inheritDoc} Empty dummy implementation of this interface method.
42       */
43      @Override
44      public void visitAfterChildren(final T node, final NodeHandler<T> handler) {
45          // empty
46      }
47  
48      /**
49       * {@inheritDoc} Empty dummy implementation of this interface method.
50       */
51      @Override
52      public void visitBeforeChildren(final T node, final NodeHandler<T> handler) {
53          // empty
54      }
55  }