Deprecate Rulechain visitors

This commit is contained in:
Clément Fournier
2020-06-29 06:30:22 +02:00
parent 659066ee02
commit 49635c2a66
14 changed files with 23 additions and 0 deletions

View File

@ -16,6 +16,7 @@ import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor; import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule; import net.sourceforge.pmd.lang.rule.XPathRule;
@Deprecated
public class ApexRuleChainVisitor extends AbstractRuleChainVisitor { public class ApexRuleChainVisitor extends AbstractRuleChainVisitor {
@Override @Override

View File

@ -77,7 +77,10 @@ public interface Language extends Comparable<Language> {
* *
* @return The RuleChainVisitor class. * @return The RuleChainVisitor class.
* @see net.sourceforge.pmd.lang.rule.RuleChainVisitor * @see net.sourceforge.pmd.lang.rule.RuleChainVisitor
*
* @deprecated Will be removed in PMD 7, avoid using this
*/ */
@Deprecated
Class<?> getRuleChainVisitorClass(); Class<?> getRuleChainVisitorClass();
/** /**

View File

@ -28,7 +28,10 @@ import net.sourceforge.pmd.lang.ast.Node;
* This is a base class for RuleChainVisitor implementations which extracts * This is a base class for RuleChainVisitor implementations which extracts
* interesting nodes from an AST, and lets each Rule visit the nodes it has * interesting nodes from an AST, and lets each Rule visit the nodes it has
* expressed interest in. * expressed interest in.
*
* @deprecated See {@link RuleChainVisitor}
*/ */
@Deprecated
public abstract class AbstractRuleChainVisitor implements RuleChainVisitor { public abstract class AbstractRuleChainVisitor implements RuleChainVisitor {
private static final Logger LOG = Logger.getLogger(AbstractRuleChainVisitor.class.getName()); private static final Logger LOG = Logger.getLogger(AbstractRuleChainVisitor.class.getName());

View File

@ -9,12 +9,18 @@ import java.util.List;
import net.sourceforge.pmd.Rule; import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.RuleContext; import net.sourceforge.pmd.RuleContext;
import net.sourceforge.pmd.RuleSet; import net.sourceforge.pmd.RuleSet;
import net.sourceforge.pmd.lang.BaseLanguageModule;
import net.sourceforge.pmd.lang.ast.Node; import net.sourceforge.pmd.lang.ast.Node;
/** /**
* The RuleChainVisitor understands how to visit an AST for a particular * The RuleChainVisitor understands how to visit an AST for a particular
* Language. * Language.
*
* @deprecated This interface will be removed. It's only used in internal
* code. Language implementors no longer need to register a rulechain
* visitor implementation in the {@link BaseLanguageModule} constructor.
*/ */
@Deprecated
public interface RuleChainVisitor { public interface RuleChainVisitor {
/** /**
* Add the given rule to the visitor. * Add the given rule to the visitor.

View File

@ -16,6 +16,7 @@ import net.sourceforge.pmd.lang.java.ast.JavaParserVisitorAdapter;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor; import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule; import net.sourceforge.pmd.lang.rule.XPathRule;
@Deprecated
public class JavaRuleChainVisitor extends AbstractRuleChainVisitor { public class JavaRuleChainVisitor extends AbstractRuleChainVisitor {
@Override @Override

View File

@ -16,6 +16,7 @@ import net.sourceforge.pmd.lang.ecmascript.ast.EcmascriptParserVisitor;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor; import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule; import net.sourceforge.pmd.lang.rule.XPathRule;
@Deprecated
public class EcmascriptRuleChainVisitor extends AbstractRuleChainVisitor { public class EcmascriptRuleChainVisitor extends AbstractRuleChainVisitor {
@Override @Override

View File

@ -16,6 +16,7 @@ import net.sourceforge.pmd.lang.jsp.ast.JspParserVisitorAdapter;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor; import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule; import net.sourceforge.pmd.lang.rule.XPathRule;
@Deprecated
public class JspRuleChainVisitor extends AbstractRuleChainVisitor { public class JspRuleChainVisitor extends AbstractRuleChainVisitor {
@Override @Override

View File

@ -16,6 +16,7 @@ import net.sourceforge.pmd.lang.modelica.ast.ModelicaParserVisitorAdapter;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor; import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule; import net.sourceforge.pmd.lang.rule.XPathRule;
@Deprecated
public class ModelicaRuleChainVisitor extends AbstractRuleChainVisitor { public class ModelicaRuleChainVisitor extends AbstractRuleChainVisitor {
@Override @Override
protected void visit(Rule rule, Node node, RuleContext ctx) { protected void visit(Rule rule, Node node, RuleContext ctx) {

View File

@ -18,6 +18,7 @@ import net.sourceforge.pmd.lang.plsql.ast.PLSQLParserVisitorAdapter;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor; import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule; import net.sourceforge.pmd.lang.rule.XPathRule;
@Deprecated
public class PLSQLRuleChainVisitor extends AbstractRuleChainVisitor { public class PLSQLRuleChainVisitor extends AbstractRuleChainVisitor {
private static final Logger LOGGER = Logger.getLogger(PLSQLRuleChainVisitor.class.getName()); private static final Logger LOGGER = Logger.getLogger(PLSQLRuleChainVisitor.class.getName());
private static final String CLASS_NAME = PLSQLRuleChainVisitor.class.getName(); private static final String CLASS_NAME = PLSQLRuleChainVisitor.class.getName();

View File

@ -19,6 +19,7 @@ import net.sourceforge.pmd.lang.scala.ast.ScalaParserVisitorAdapter;
/** /**
* A Rule Chain visitor for Scala. * A Rule Chain visitor for Scala.
*/ */
@Deprecated
public class ScalaRuleChainVisitor extends AbstractRuleChainVisitor { public class ScalaRuleChainVisitor extends AbstractRuleChainVisitor {
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")

View File

@ -48,6 +48,7 @@ public class DummyLanguageModule extends BaseLanguageModule {
addVersion("1.8", new Handler(), false); addVersion("1.8", new Handler(), false);
} }
@Deprecated
public static class DummyRuleChainVisitor extends AbstractRuleChainVisitor { public static class DummyRuleChainVisitor extends AbstractRuleChainVisitor {
@Override @Override
protected void visit(Rule rule, Node node, RuleContext ctx) { protected void visit(Rule rule, Node node, RuleContext ctx) {

View File

@ -16,6 +16,7 @@ import net.sourceforge.pmd.lang.vf.ast.VfNode;
import net.sourceforge.pmd.lang.vf.ast.VfParserVisitor; import net.sourceforge.pmd.lang.vf.ast.VfParserVisitor;
import net.sourceforge.pmd.lang.vf.ast.VfParserVisitorAdapter; import net.sourceforge.pmd.lang.vf.ast.VfParserVisitorAdapter;
@Deprecated
public class VfRuleChainVisitor extends AbstractRuleChainVisitor { public class VfRuleChainVisitor extends AbstractRuleChainVisitor {
@Override @Override

View File

@ -17,6 +17,7 @@ import net.sourceforge.pmd.lang.vm.ast.VmNode;
import net.sourceforge.pmd.lang.vm.ast.VmParserVisitor; import net.sourceforge.pmd.lang.vm.ast.VmParserVisitor;
import net.sourceforge.pmd.lang.vm.ast.VmParserVisitorAdapter; import net.sourceforge.pmd.lang.vm.ast.VmParserVisitorAdapter;
@Deprecated
public class VmRuleChainVisitor extends AbstractRuleChainVisitor { public class VmRuleChainVisitor extends AbstractRuleChainVisitor {
@Override @Override

View File

@ -14,6 +14,7 @@ import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor; import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule; import net.sourceforge.pmd.lang.rule.XPathRule;
@Deprecated
public class XmlRuleChainVisitor extends AbstractRuleChainVisitor { public class XmlRuleChainVisitor extends AbstractRuleChainVisitor {
@Override @Override