001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.configuration2.tree;
018
019/**
020 * <p>
021 * A simple adapter class that simplifies writing custom node visitor
022 * implementations.
023 * </p>
024 * <p>
025 * This class provides dummy implementations for the methods defined in the
026 * {@code ConfigurationNodeVisitor} interface. Derived classes only need
027 * to override the methods they really need.
028 * </p>
029 *
030 * @param  <T> the type of the nodes processed by this visitor
031 */
032public class ConfigurationNodeVisitorAdapter<T> implements
033        ConfigurationNodeVisitor<T>
034{
035    /**
036     * {@inheritDoc} Empty dummy implementation of this interface method.
037     */
038    @Override
039    public void visitBeforeChildren(final T node, final NodeHandler<T> handler)
040    {
041    }
042
043    /**
044     * {@inheritDoc} Empty dummy implementation of this interface method.
045     */
046    @Override
047    public void visitAfterChildren(final T node, final NodeHandler<T> handler)
048    {
049    }
050
051    /**
052     * {@inheritDoc} This implementation returns always <b>false</b>; this means
053     * that all nodes in the current hierarchy are traversed.
054     */
055    @Override
056    public boolean terminate()
057    {
058        return false;
059    }
060}