phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add deprecation javadocs

Browse Source
This commit is contained in:
Andreas Dangel
2020-07-17 14:43:43 +02:00
parent c25e10717b
commit 7ae424a35b
14 changed files with 67 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ApexLanguageModule.java
View File

@ -5,17 +5,20 @@
package net.sourceforge.pmd.lang.apex;
import net.sourceforge.pmd.lang.BaseLanguageModule;
import net.sourceforge.pmd.util.CollectionUtil;
import apex.jorje.services.Version;
public class ApexLanguageModule extends BaseLanguageModule {
private static final String FIRST_EXTENSION = "cls";
private static final String[] REMAINING_EXTENSIONS = {"trigger"};
public static final String NAME = "Apex";
public static final String TERSE_NAME = "apex";
public static final String[] EXTENSIONS = { "cls", "trigger" };
public static final String[] EXTENSIONS = CollectionUtil.listOf(FIRST_EXTENSION, REMAINING_EXTENSIONS).toArray(new String[0]);
public ApexLanguageModule() {
super(NAME, null, TERSE_NAME, "cls", "trigger");
super(NAME, null, TERSE_NAME, FIRST_EXTENSION, REMAINING_EXTENSIONS);
addVersion(String.valueOf((int) Version.CURRENT.getExternal()), new ApexHandler(), true);
}
}

5
pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/rule/ApexRuleChainVisitor.java
View File

@ -14,8 +14,13 @@ import net.sourceforge.pmd.lang.apex.ast.ApexNode;
import net.sourceforge.pmd.lang.apex.ast.ApexParserVisitor;
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.RuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule;
/**
* @deprecated for removal with PMD 7. A language dependent rule chain visitor is not needed anymore.
* See {@link RuleChainVisitor}.
*/
@Deprecated
public class ApexRuleChainVisitor extends AbstractRuleChainVisitor {

2
pmd-core/src/main/java/net/sourceforge/pmd/lang/internal/DefaultRulechainVisitor.java
View File

@ -9,6 +9,7 @@ import java.util.List;
import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.RuleContext;
import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.RuleChainVisitor;
@ -17,6 +18,7 @@ import net.sourceforge.pmd.lang.rule.RuleChainVisitor;
* @deprecated See {@link RuleChainVisitor}
*/
@Deprecated
@InternalApi
public class DefaultRulechainVisitor extends AbstractRuleChainVisitor {
@Override

6
pmd-core/src/test/java/net/sourceforge/pmd/lang/DummyLanguageModule.java
View File

@ -24,6 +24,7 @@ import net.sourceforge.pmd.lang.ast.xpath.DocumentNavigator;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.AbstractRuleViolationFactory;
import net.sourceforge.pmd.lang.rule.ParametricRuleViolation;
import net.sourceforge.pmd.lang.rule.RuleChainVisitor;
import net.sf.saxon.expr.XPathContext;
import net.sf.saxon.sxpath.IndependentContext;
@ -49,6 +50,11 @@ public class DummyLanguageModule extends BaseLanguageModule {
addVersion("1.8", new Handler(), "8");
}
/**
* @deprecated for removal with PMD 7. A language dependent rule chain visitor is not needed anymore.
* See {@link RuleChainVisitor}.
*/
@Deprecated
public static class DummyRuleChainVisitor extends AbstractRuleChainVisitor {
@Override
protected void visit(Rule rule, Node node, RuleContext ctx) {

5
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/JavaRuleChainVisitor.java
View File

@ -14,8 +14,13 @@ import net.sourceforge.pmd.lang.java.ast.JavaNode;
import net.sourceforge.pmd.lang.java.ast.JavaParserVisitor;
import net.sourceforge.pmd.lang.java.ast.JavaParserVisitorAdapter;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.RuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule;
/**
* @deprecated for removal with PMD 7. A language dependent rule chain visitor is not needed anymore.
* See {@link RuleChainVisitor}.
*/
@Deprecated
public class JavaRuleChainVisitor extends AbstractRuleChainVisitor {

5
pmd-javascript/src/main/java/net/sourceforge/pmd/lang/ecmascript/rule/EcmascriptRuleChainVisitor.java
View File

@ -14,8 +14,13 @@ import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.ecmascript.ast.EcmascriptNode;
import net.sourceforge.pmd.lang.ecmascript.ast.EcmascriptParserVisitor;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.RuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule;
/**
* @deprecated for removal with PMD 7. A language dependent rule chain visitor is not needed anymore.
* See {@link RuleChainVisitor}.
*/
@Deprecated
public class EcmascriptRuleChainVisitor extends AbstractRuleChainVisitor {

5
pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/rule/JspRuleChainVisitor.java
View File

@ -14,8 +14,13 @@ import net.sourceforge.pmd.lang.jsp.ast.JspNode;
import net.sourceforge.pmd.lang.jsp.ast.JspParserVisitor;
import net.sourceforge.pmd.lang.jsp.ast.JspParserVisitorAdapter;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.RuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule;
/**
* @deprecated for removal with PMD 7. A language dependent rule chain visitor is not needed anymore.
* See {@link RuleChainVisitor}.
*/
@Deprecated
public class JspRuleChainVisitor extends AbstractRuleChainVisitor {

5
pmd-modelica/src/main/java/net/sourceforge/pmd/lang/modelica/rule/ModelicaRuleChainVisitor.java
View File

@ -14,8 +14,13 @@ import net.sourceforge.pmd.lang.modelica.ast.ModelicaNode;
import net.sourceforge.pmd.lang.modelica.ast.ModelicaParserVisitor;
import net.sourceforge.pmd.lang.modelica.ast.ModelicaParserVisitorAdapter;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.RuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule;
/**
* @deprecated for removal with PMD 7. A language dependent rule chain visitor is not needed anymore.
* See {@link RuleChainVisitor}.
*/
@Deprecated
public class ModelicaRuleChainVisitor extends AbstractRuleChainVisitor {
@Override

5
pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/rule/PLSQLRuleChainVisitor.java
View File

@ -16,8 +16,13 @@ import net.sourceforge.pmd.lang.plsql.ast.PLSQLNode;
import net.sourceforge.pmd.lang.plsql.ast.PLSQLParserVisitor;
import net.sourceforge.pmd.lang.plsql.ast.PLSQLParserVisitorAdapter;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.RuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule;
/**
* @deprecated for removal with PMD 7. A language dependent rule chain visitor is not needed anymore.
* See {@link RuleChainVisitor}.
*/
@Deprecated
public class PLSQLRuleChainVisitor extends AbstractRuleChainVisitor {
private static final Logger LOGGER = Logger.getLogger(PLSQLRuleChainVisitor.class.getName());

4
pmd-scala-modules/pmd-scala-common/src/main/java/net/sourceforge/pmd/lang/scala/rule/ScalaRuleChainVisitor.java
View File

@ -10,6 +10,7 @@ import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.RuleContext;
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.RuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule;
import net.sourceforge.pmd.lang.scala.ast.ASTSource;
import net.sourceforge.pmd.lang.scala.ast.ScalaNode;
@ -18,6 +19,9 @@ import net.sourceforge.pmd.lang.scala.ast.ScalaParserVisitorAdapter;
/**
* A Rule Chain visitor for Scala.
*
* @deprecated for removal with PMD 7. A language dependent rule chain visitor is not needed anymore.
* See {@link RuleChainVisitor}.
*/
@Deprecated
public class ScalaRuleChainVisitor extends AbstractRuleChainVisitor {

5
pmd-test/src/main/java/net/sourceforge/pmd/test/lang/DummyLanguageModule.java
View File

@ -25,6 +25,7 @@ import net.sourceforge.pmd.lang.ast.ParseException;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.AbstractRuleViolationFactory;
import net.sourceforge.pmd.lang.rule.ParametricRuleViolation;
import net.sourceforge.pmd.lang.rule.RuleChainVisitor;
import net.sourceforge.pmd.test.lang.ast.DummyNode;
/**
@ -48,6 +49,10 @@ public class DummyLanguageModule extends BaseLanguageModule {
addVersion("1.8", new Handler(), false);
}
/**
* @deprecated for removal with PMD 7. A language dependent rule chain visitor is not needed anymore.
* See {@link RuleChainVisitor}.
*/
@Deprecated
public static class DummyRuleChainVisitor extends AbstractRuleChainVisitor {
@Override

5
pmd-visualforce/src/main/java/net/sourceforge/pmd/lang/vf/rule/VfRuleChainVisitor.java
View File

@ -10,12 +10,17 @@ import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.RuleContext;
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.RuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule;
import net.sourceforge.pmd.lang.vf.ast.ASTCompilationUnit;
import net.sourceforge.pmd.lang.vf.ast.VfNode;
import net.sourceforge.pmd.lang.vf.ast.VfParserVisitor;
import net.sourceforge.pmd.lang.vf.ast.VfParserVisitorAdapter;
/**
* @deprecated for removal with PMD 7. A language dependent rule chain visitor is not needed anymore.
* See {@link RuleChainVisitor}.
*/
@Deprecated
public class VfRuleChainVisitor extends AbstractRuleChainVisitor {

5
pmd-vm/src/main/java/net/sourceforge/pmd/lang/vm/rule/VmRuleChainVisitor.java
View File

@ -10,6 +10,7 @@ import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.RuleContext;
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.RuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule;
import net.sourceforge.pmd.lang.vm.ast.ASTprocess;
import net.sourceforge.pmd.lang.vm.ast.AbstractVmNode;
@ -17,6 +18,10 @@ import net.sourceforge.pmd.lang.vm.ast.VmNode;
import net.sourceforge.pmd.lang.vm.ast.VmParserVisitor;
import net.sourceforge.pmd.lang.vm.ast.VmParserVisitorAdapter;
/**
* @deprecated for removal with PMD 7. A language dependent rule chain visitor is not needed anymore.
* See {@link RuleChainVisitor}.
*/
@Deprecated
public class VmRuleChainVisitor extends AbstractRuleChainVisitor {

5
pmd-xml/src/main/java/net/sourceforge/pmd/lang/xml/rule/XmlRuleChainVisitor.java
View File

@ -12,8 +12,13 @@ import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.RuleContext;
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.rule.AbstractRuleChainVisitor;
import net.sourceforge.pmd.lang.rule.RuleChainVisitor;
import net.sourceforge.pmd.lang.rule.XPathRule;
/**
* @deprecated for removal with PMD 7. A language dependent rule chain visitor is not needed anymore.
* See {@link RuleChainVisitor}.
*/
@Deprecated
public class XmlRuleChainVisitor extends AbstractRuleChainVisitor {