Skip to content

Complete @Deprecated annotation classification and replacement docs - #9266

Open
Mohit20057 wants to merge 1 commit into
apache:masterfrom
Mohit20057:finalize-deprecated-annotation-cleanup
Open

Mohit20057 wants to merge 1 commit into
apache:masterfrom
Mohit20057:finalize-deprecated-annotation-cleanup

Conversation

@Mohit20057

Copy link
Copy Markdown
Contributor

What is the purpose of the change

Follow-up to umbrella issue #8994 addressing review audit feedback from #issuecomment-6712947172:

  • Completes explicit since = "..." and forRemoval classification on the remaining 12 @Deprecated declarations on master (achieving zero bare @Deprecated across all production code):
    • Flux.java: Added since = "2.0.0", forRemoval = true, and explanatory Javadocs for obsolete CLI option constants (OPTION_LOCAL, OPTION_REMOTE, OPTION_SLEEP, OPTION_ZOOKEEPER).
    • LinearDRPCTopologyBuilder.java: Added since = "1.0.0" to the two addBolt(IRichBolt...) overloads.
    • TimeCacheMap.java: Added since = "0.7.0" to TimeCacheMap (forRemoval = false).
    • NodeSorter.java & NodeSorterHostProximity.java: Added since = "2.3.0", forRemoval = false to private sorting helpers (sortObjectResourcesGeneric and sortObjectResourcesDefault).
    • ServerUtils.java: Added since = "2.0.0", forRemoval = true to zipFileSize(File).
  • Updates Javadoc @deprecated tags to document explicit replacements:
    • PlainSaslTransportPlugin: Documented replacement with DigestSaslTransportPlugin or KerberosSaslTransportPlugin.
    • SaslPlainServer: Documented standard SASL mechanism alternatives (DIGEST-MD5 / GSSAPI).
    • IMetricsContext.registerMetric (3 overloads): Documented metrics v2 replacement methods (registerGauge, registerCounter, registerMeter, registerHistogram, registerTimer).
    • ServerUtils.zipFileSize: Documented replacement with File#length() or standard Java NIO/zip utilities.

How was this tested

  • Validated repository-wide audit script confirming 0 production @Deprecated annotations missing since
  • Checkstyle validated with 0 violations across storm-client, storm-server, and flux-core
  • Built and test-compiled storm-client with JDK 23

@GGraziadei GGraziadei changed the title [STORM-8994] Complete @Deprecated annotation classification and replacement docs Complete @Deprecated annotation classification and replacement docs Nov 8, 2026
@GGraziadei GGraziadei added this to the 3.3.0 milestone Nov 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants