[DOM] NaiveASTFlattener should be sync with ASTFlattener of the JDT.UI

[subyssurendran666]

What it does

The unnamed variables and pattern's DOM and ASTRewrite implemented through #2623. Following items should be added along with that.

• The Javadoc of both APIs i.e. TypePattern.getPatternVariable() and TypePattern.getPatternVariable2() is same and not clear regarding the difference.
• The methods in JDT UI's ASTFlattener are kept in sync with NaiveASTFlattener(TypePattern). Hence, the change should be done in NaiveASTFlattener as well and then synced to ASTFlattener.

The Problem has reported here: eclipse-jdt/eclipse.jdt.ui#1764 (comment)

How to test

This PR closes #3261

Author checklist

• I have thoroughly tested my changes
• The change is following the coding conventions
• I have signed the Eclipse Contributor Agreement (ECA)

[subyssurendran666]

@mpalat could you please review this PR and share your insights on this ?

[mpalat]

@mpalat could you please review this PR and share your insights on this ?

Will take a look. Meanwhile, please have a look and follow the process at https://github.com/eclipse-platform/eclipse.platform/blob/master/docs/Eclipse_API_Central_Deprecation_Policy.md when you are looking at deprecating APIs

[mpalat]

Suby,
Let us do some additional cleanup here - Refer to MethodDeclaration - modifiers and see how it got changed. Let us do a similar approach here.

[mpalat]

+1
Please rebase and submit. Thanks

[laeubi]

@mpalat @subyssurendran666

There is an javadoc error that fails the build now:

Error:  Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.11.2:javadoc (attach-javadocs) on project org.eclipse.jdt.doc.isv: An error has occurred in Javadoc report generation: 
Error:  Exit code: 1
Error:  /home/runner/work/tycho/tycho/aggregator/eclipse.platform.common/bundles/org.eclipse.jdt.doc.isv/../../../eclipse.jdt.core/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/TypePattern.java:190: error: unknown tag: Deprecated
Error:  	 * @Deprecated(forRemoval = true, since="2024-07")
Error:  	   ^

eclipse.jdt.core/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/TypePattern.java

Line 190 in 5c82c91

* @Deprecated(forRemoval = true, since="2024-07")

I assume this should be a method annotation and not part of the javadoc.

Also the date seems wrong @Deprecated(forRemoval = true, since="2025-03") is probably wanted?

[mpalat]

@mpalat @subyssurendran666

There is an javadoc error that fails the build now:

Error:  Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.11.2:javadoc (attach-javadocs) on project org.eclipse.jdt.doc.isv: An error has occurred in Javadoc report generation: 
Error:  Exit code: 1
Error:  /home/runner/work/tycho/tycho/aggregator/eclipse.platform.common/bundles/org.eclipse.jdt.doc.isv/../../../eclipse.jdt.core/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/TypePattern.java:190: error: unknown tag: Deprecated
Error:  	 * @Deprecated(forRemoval = true, since="2024-07")

Thanks @laeubi for flagging this.
@subyssurendran666 : "D" in deprecated should be small "d" - could you please correct the same?

[subyssurendran666]

@mpalat @subyssurendran666
There is an javadoc error that fails the build now:

Error:  Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.11.2:javadoc (attach-javadocs) on project org.eclipse.jdt.doc.isv: An error has occurred in Javadoc report generation: 
Error:  Exit code: 1
Error:  /home/runner/work/tycho/tycho/aggregator/eclipse.platform.common/bundles/org.eclipse.jdt.doc.isv/../../../eclipse.jdt.core/org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/TypePattern.java:190: error: unknown tag: Deprecated
Error:  	 * @Deprecated(forRemoval = true, since="2024-07")

Thanks @laeubi for flagging this. @subyssurendran666 : "D" in deprecated should be small "d" - could you please correct the same?

Hello @mpalat @laeubi,

I was referring this doc for the deprecation and it is clearly mentioned that, the javaDoc changes should be @Deprecated(forRemoval = true, since="2024-12"). That is why the deprecated in the javadoc written as D. I will modify that with d(lower case).

The reason why I have added the since="2024-07", because this should be deprecated since 7th month of 2024. However after referring @laeubi comment, I got idea that this should be 2025-03.

[laeubi]

I was referring this doc for the deprecation and it is clearly mentioned that, the javaDoc changes should be @deprecated(forRemoval = true, since="2024-12").

Please read again! As also mentioned above this is not an javadoc tag it is a method annotation as also mentioned in the doc:

Java API is deprecated through use of the @Deprecate annotation.

there is also a javadoc tag @deprecated but it has different purpose, see for example:

https://stackoverflow.com/questions/20674135/deprecated-vs-deprecated

[iloveeclipse]

@laeubi : #3504

[jukzi]

this PR caused regression in ui: eclipse-jdt/eclipse.jdt.ui#1899

[rgrunber]

I've also noticed a regression (initially from the JDT-LS side). Affecting "Pattern matching for instanceof" cleanup.

Screencast.From.2025-01-06.17-14-17.mp4