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

Merge branch 'deprecations-for-2807'

Browse Source 
[core] Deprecations for ParametricRuleViolation and ParserOptions#suppressMarker #2907
This commit is contained in:
Clément Fournier
2020-11-08 09:03:26 +01:00
parent ae7fa3d1fe db404434b4
commit 154f9387b2
4 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/pages/release_notes.md
View File

@ -38,6 +38,9 @@ You can identify them with the `@InternalApi` annotation. You'll also get a depr
* {% jdoc !!javascript::lang.ecmascript.Ecmascript3Parser %}
* {% jdoc !!javascript::lang.ecmascript.ast.EcmascriptParser#parserOptions %}
* {% jdoc !!javascript::lang.ecmascript.ast.EcmascriptParser#getSuppressMap() %}
* {% jdoc !!core::lang.rule.ParametricRuleViolation %}
* {% jdoc !!core::lang.ParserOptions#suppressMarker %}
* {% jdoc !!modelica::lang.modelica.rule.ModelicaRuleViolationFactory %}
### External Contributions

4
pmd-core/src/main/java/net/sourceforge/pmd/lang/ParserOptions.java
View File

@ -11,6 +11,10 @@ package net.sourceforge.pmd.lang;
* {@link Object#hashCode()}.
*/
public class ParserOptions {
/**
* @deprecated Use {@link #getSuppressMarker()} instead.
*/
@Deprecated
protected String suppressMarker;
public String getSuppressMarker() {

6
pmd-core/src/main/java/net/sourceforge/pmd/lang/rule/ParametricRuleViolation.java
View File

@ -10,10 +10,16 @@ import java.util.regex.Pattern;
import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.RuleContext;
import net.sourceforge.pmd.RuleViolation;
import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.properties.PropertyDescriptor;
import net.sourceforge.pmd.util.StringUtil;
/**
* @deprecated This is internal. Clients should exclusively use {@link RuleViolation}.
*/
@Deprecated
@InternalApi
public class ParametricRuleViolation<T extends Node> implements RuleViolation {
protected final Rule rule;

7
pmd-modelica/src/main/java/net/sourceforge/pmd/lang/modelica/rule/ModelicaRuleViolationFactory.java
View File

@ -7,10 +7,17 @@ package net.sourceforge.pmd.lang.modelica.rule;
import net.sourceforge.pmd.Rule;
import net.sourceforge.pmd.RuleContext;
import net.sourceforge.pmd.RuleViolation;
import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.rule.AbstractRuleViolationFactory;
import net.sourceforge.pmd.lang.rule.ParametricRuleViolation;
import net.sourceforge.pmd.lang.rule.RuleViolationFactory;
/**
* @deprecated See {@link RuleViolationFactory}
*/
@Deprecated
@InternalApi
public final class ModelicaRuleViolationFactory extends AbstractRuleViolationFactory {
public static final ModelicaRuleViolationFactory INSTANCE = new ModelicaRuleViolationFactory();