Document resolvers in the Javadoc overview - #81
Merged
Conversation
A secured factory inverts what a resolver means: returning null leaves the reference unresolved and the floor answers it with empty content, instead of handing the reference back to the parser to fetch. A resolver is therefore the only way to allow a fetch, and the identifier to match against an allow-list differs per API, absolute for EntityResolver and relative plus a base URI everywhere else. Add a Resolvers section to the Javadoc overview with one worked example per resolver API, name the channels each one covers, and link the JAXP, SAX and DOM types to the Java 25 API documentation at their first mention. Assisted-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XVaEa2R2sHtBgJh8Mhv841
The JDK 11 javadoc HTML checker reads the bare ">" of "->" as stray markup and fails the build with "bad use of '>'"; the JDK 17 and later checkers accept it, so the samples passed locally. Write the arrow as "->", which renders identically. Assisted-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XVaEa2R2sHtBgJh8Mhv841
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
2 participants
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.
A secured factory inverts what a resolver means: returning
nullleaves the reference unresolved and the floor answers it with empty content, rather than handing the reference back to the parser to fetch. A resolver is therefore the only way to opt a resource back in, which the overview did not say anywhere.Adds a Resolvers section to
overview.html:nullreturn now means, and that a non-null result is honored even where the JAXP 1.5 external-access properties would deny the fetch;EntityResolverand relative plus a base URI for the others;EntityResolver,LSResourceResolver,URIResolver,XMLResolver), each naming the channels that resolver covers;Documentation only, no main code changes.
🤖 Generated with Claude Code