net.sourceforge.pmd.lang.java.rule.AbstractJavaRulechainRule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pmd-java Show documentation

There is a newer version: 7.7.0

/*
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */

package net.sourceforge.pmd.lang.java.rule;

import org.checkerframework.checker.nullness.qual.NonNull;

import net.sourceforge.pmd.annotation.Experimental;
import net.sourceforge.pmd.lang.java.ast.JavaNode;
import net.sourceforge.pmd.lang.rule.RuleTargetSelector;

/**
 * Base class for rules using the rulechain. The visit methods don't
 * recurse by default.
 *
 * @author Clément Fournier
 * @since 7.0.0
 */
public abstract class AbstractJavaRulechainRule extends AbstractJavaRule {

    private final RuleTargetSelector selector;

    /**
     * Specify the node types to visit as parameters.
     *
     * @param first  The first node, there must be at least one
     * @param visits The rest
     */
    @SafeVarargs
    @Experimental
    public AbstractJavaRulechainRule(Class first, Class... visits) {
        selector = RuleTargetSelector.forTypes(first, visits);
    }

    @Override
    protected final @NonNull RuleTargetSelector buildTargetSelector() {
        return selector;
    }

    @Override
    public Object visitJavaNode(JavaNode node, Object data) {
        return data;
    }
}