Conversation
- Add private constructor to EncodingMap and XMLChar to prevent
instantiation of utility classes (Sonar/checkstyle compliance)
- Add explicit public constructor to SimpleHTMLScanner to satisfy
Javadoc strict mode
- Fix Javadoc inline code tag: ¬=, ©= → {@code ¬=, ©=}
- Enable legacyMode in maven-javadoc-plugin to fix Javadoc generation
- Remove EncodingMapTest#testConstructor that tested public instantiation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Code quality fixes for utility classes and Javadoc generation in the
saxpackage.Changes Made
EncodingMapis a static utility class and should not be instantiated¬=→{@code ¬=, ©=})<legacyMode>true</legacyMode>in maven-javadoc-plugin to resolve Javadoc generation issues with newer JDKtestConstructor()which tested public instantiation of what is now a non-instantiable utility classTesting
The removed test was validating behavior (instantiability) that is now intentionally prohibited. All remaining tests cover the static API surface, which is unaffected.
Breaking Changes
None —
EncodingMapandXMLCharwere not meant to be instantiated; this change enforces that contract.SimpleHTMLScannerretains its public constructor.Additional Notes
These changes align with standard Java utility class conventions and static analysis tool expectations (e.g., SonarQube HideUtilityClassConstructor rule).