From 60eca92180135b14267223921bcbe53bcd43feb5 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Thu, 11 Jan 2024 09:47:10 +0100 Subject: [PATCH] [core] Undeprecate Node::getImage() in PMD 7 This should be done for 7.x again - see #4787 --- .../pmd/lang/apex/ast/ASTAnnotation.java | 3 +-- .../lang/apex/ast/ASTAnnotationParameter.java | 1 - .../pmd/lang/apex/ast/BaseApexClass.java | 7 ------- .../net/sourceforge/pmd/lang/ast/Node.java | 18 ++++++++++-------- .../ast/impl/javacc/AbstractJjtreeNode.java | 2 +- .../lang/java/ast/ASTAnyTypeDeclaration.java | 2 +- .../lang/java/ast/ASTVariableDeclaratorId.java | 2 +- .../java/ast/AbstractAnyTypeDeclaration.java | 2 +- .../pmd/lang/java/ast/JavaComment.java | 2 +- 9 files changed, 16 insertions(+), 23 deletions(-) diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnnotation.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnnotation.java index 36249a30c0..402010bd48 100644 --- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnnotation.java +++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnnotation.java @@ -23,9 +23,8 @@ public final class ASTAnnotation extends AbstractApexNode { } @Override - @Deprecated public String getImage() { - return node.getType().getApexName(); + return getName(); } public boolean isResolved() { diff --git a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnnotationParameter.java b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnnotationParameter.java index 9c9a17e1ef..d06310df33 100644 --- a/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnnotationParameter.java +++ b/pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ASTAnnotationParameter.java @@ -38,7 +38,6 @@ public final class ASTAnnotationParameter extends AbstractApexNode extends AbstractApexNode implements ASTUserClassOrInterface { @@ -21,12 +19,7 @@ abstract class BaseApexClass extends AbstractApexNode return true; } - /** - * @deprecated Use {@link #getSimpleName()} - */ @Override - @Deprecated - @DeprecatedUntil700 public String getImage() { return getSimpleName(); } diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/Node.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/Node.java index c9c2e14816..88726fd611 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/Node.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/Node.java @@ -72,11 +72,12 @@ public interface Node extends Reportable { * node. This is usually an identifier, but you should check that using the Designer. On most nodes though, this * method returns {@code null}. * - * @deprecated Should be replaced with methods that have more specific - * names in node classes. + *

Note: + * This method will be deprecated in the future (#4787). + * It will be replaced with methods that have more specific names in node classes. In some cases, there + * are already alternatives available that should be used.

*/ - @Deprecated - @DeprecatedUntil700 + // @Deprecated // todo deprecate (#4787) default String getImage() { return null; } @@ -85,12 +86,13 @@ public interface Node extends Reportable { /** * Returns true if this node's image is equal to the given string. * + *

Note: + * This method will be deprecated in the future (#4787). + * See {@link #getImage()}. + *

* @param image The image to check - * - * @deprecated See {@link #getImage()} */ - @Deprecated - @DeprecatedUntil700 + // @Deprecated // todo deprecate (#4787) default boolean hasImageEqualTo(String image) { return Objects.equals(getImage(), image); } diff --git a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/impl/javacc/AbstractJjtreeNode.java b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/impl/javacc/AbstractJjtreeNode.java index bd11611c28..0a8e70b58b 100644 --- a/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/impl/javacc/AbstractJjtreeNode.java +++ b/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/impl/javacc/AbstractJjtreeNode.java @@ -38,7 +38,7 @@ public abstract class AbstractJjtreeNode, N e } @Override - // @Deprecated // todo deprecate, will change tree dump tests + // @Deprecated // todo deprecate, will change tree dump tests (#4787) public String getImage() { return image; } diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTAnyTypeDeclaration.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTAnyTypeDeclaration.java index 5a51c7b109..e7714d02d6 100644 --- a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTAnyTypeDeclaration.java +++ b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTAnyTypeDeclaration.java @@ -69,7 +69,7 @@ public interface ASTAnyTypeDeclaration /** * @deprecated Use {@link #getSimpleName()} */ - @Deprecated + @Deprecated // note: already deprecated in 6.55.0 @DeprecatedAttribute(replaceWith = "@SimpleName") @Override String getImage(); diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTVariableDeclaratorId.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTVariableDeclaratorId.java index 4c2d2c1089..067cf80553 100644 --- a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTVariableDeclaratorId.java +++ b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/ASTVariableDeclaratorId.java @@ -112,7 +112,7 @@ public final class ASTVariableDeclaratorId extends AbstractTypedSymbolDeclarator */ @Override @DeprecatedAttribute(replaceWith = "@Name") - @Deprecated + @Deprecated // note: already deprecated in 6.55.0 public String getImage() { return getName(); } diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/AbstractAnyTypeDeclaration.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/AbstractAnyTypeDeclaration.java index 82d6ebb80d..c6818b7db5 100644 --- a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/AbstractAnyTypeDeclaration.java +++ b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/AbstractAnyTypeDeclaration.java @@ -40,7 +40,7 @@ abstract class AbstractAnyTypeDeclaration extends AbstractTypedSymbolDeclarator< /** * @deprecated Use {@link #getSimpleName()} */ - @Deprecated + @Deprecated // note: already deprecated in 6.55.0 @DeprecatedAttribute(replaceWith = "@SimpleName") @Override public String getImage() { diff --git a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/JavaComment.java b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/JavaComment.java index d2655ae5e0..83cd9e0de4 100644 --- a/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/JavaComment.java +++ b/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/JavaComment.java @@ -42,7 +42,7 @@ public class JavaComment implements Reportable { */ @Deprecated public String getImage() { - return getToken().getImage(); + return getText().toString(); } /** The token underlying this comment. */