Skip to content

Correct the class names the deprecation notes point at - #428

Merged
slachiewicz merged 1 commit into
masterfrom
agent/fix-deprecation-javadoc
Sep 10, 2026
Merged

slachiewicz merged 1 commit into
masterfrom
agent/fix-deprecation-javadoc

Conversation

@slachiewicz

Copy link
Copy Markdown
Member

42 references in @deprecated notes named classes that do not exist. Since 3.5.0 is largely a deprecation sweep, these notes are the migration advice, and as written a good part of it sends readers to packages that were never there.

Wrong Correct Count
java.nio.files.Files java.nio.file.Files 14
java.nio.charset.StandardCharset StandardCharsets 12
java.nio.Files java.nio.file.Files 6
java.lang.Objects java.util.Objects 3
commons.io.input.XmlStreamWriter commons.io.output.XmlStreamWriter 3
Charset.getDefaultCharset Charset.defaultCharset 2
commons.io.FileNameUtils commons.io.FilenameUtils 1
{}@code {@code 1

The commons-io packages were read from the 2.22.0 jar rather than assumed: XmlStreamReader is in input, XmlStreamWriter is in output. The XmlStreamReader references were already right and are untouched.

Javadoc text only across 6 files. No signature, behaviour or dependency changes.

Verified: mvn -B javadoc:javadoc -> BUILD SUCCESS. mvn -B verify on JDK 17 -> Tests run: 788, Failures: 0, Errors: 0. Spotless clean. The no comment warnings that remain are pre-existing and untouched.

This change was created with AI assistance.

42 references across 6 files named classes that do not exist, so the
migration advice attached to the 3.5.0 deprecation sweep sent readers
nowhere.

  java.nio.files.Files                    -> java.nio.file.Files      (14)
  java.nio.charset.StandardCharset        -> StandardCharsets         (12)
  java.nio.Files                          -> java.nio.file.Files       (6)
  java.lang.Objects                       -> java.util.Objects         (3)
  commons.io.input.XmlStreamWriter        -> commons.io.output....     (3)
  Charset.getDefaultCharset               -> Charset.defaultCharset    (2)
  commons.io.FileNameUtils                -> FilenameUtils             (1)
  {}@code                                 -> {@code                    (1)

The commons-io packages were read from the 2.22.0 jar: XmlStreamReader
is in input, XmlStreamWriter is in output.

Javadoc text only; no signature or behaviour changes.

Verified: mvn -B javadoc:javadoc -> BUILD SUCCESS; mvn -B verify on
JDK 17 -> Tests run: 788, Failures: 0
@slachiewicz slachiewicz added the documentation Improvements or additions to documentation label Sep 10, 2026
@slachiewicz slachiewicz added this to the 3.5.0 milestone Sep 10, 2026
@slachiewicz
slachiewicz requested a review from elharo September 10, 2026 10:57
@slachiewicz
slachiewicz marked this pull request as ready for review September 10, 2026 10:57
@slachiewicz
slachiewicz merged commit 04323a6 into master Sep 10, 2026
16 checks passed
@slachiewicz
slachiewicz deleted the agent/fix-deprecation-javadoc branch September 10, 2026 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants