Source code
Description: source: package: org.apache.commons.configuration2.tree, class: ConfigurationNodeVisitorAdapter

    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 *     https://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 implementations.
    022 * </p>
    023 * <p>
    024 * This class provides dummy implementations for the methods defined in the {@code ConfigurationNodeVisitor} interface.
    025 * Derived classes only need to override the methods they really need.
    026 * </p>
    027 *
    028 * @param <T> the type of the nodes processed by this visitor
    029 */
    030public class ConfigurationNodeVisitorAdapter<T> implements ConfigurationNodeVisitor<T> {
    031
    032    /**
    033     * Constructs a new instance.
    034     */
    035    public ConfigurationNodeVisitorAdapter() {
    036        // empty
    037    }
    038
    039    /**
    040     * {@inheritDoc} This implementation returns always <strong>false</strong>; this means that all nodes in the current hierarchy are
    041     * traversed.
    042     */
    043    @Override
    044    public boolean terminate() {
    045        return false;
    046    }
    047
    048    /**
    049     * {@inheritDoc} Empty dummy implementation of this interface method.
    050     */
    051    @Override
    052    public void visitAfterChildren(final T node, final NodeHandler<T> handler) {
    053        // empty
    054    }
    055
    056    /**
    057     * {@inheritDoc} Empty dummy implementation of this interface method.
    058     */
    059    @Override
    060    public void visitBeforeChildren(final T node, final NodeHandler<T> handler) {
    061        // empty
    062    }
    063}