Skip to content

Document LoggingPermission constructor - #460

Merged
jonathanpeppers merged 3 commits into
mainfrom
jonathanpeppers-java-util-logging-docs
Aug 18, 2026
Merged

Document LoggingPermission constructor#460
jonathanpeppers merged 3 commits into
mainfrom
jonathanpeppers-java-util-logging-docs

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Refs #251

Documents the Java SE LoggingPermission(String, String) contract while leaving generated interop placeholders and unverified members out of scope.

Sources

Validation

  • Parsed every docs/xml/Java.Util.Logging/*.xml file as XML.
  • Confirmed CRLF line endings throughout the namespace.
  • Ran git diff --check and reviewed the focused namespace diff.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the API XML documentation for Java.Util.Logging.LoggingPermission to reflect the Java SE contract for the LoggingPermission(String, String) constructor, replacing “To be added.” placeholders with concrete parameter and summary text.

Changes:

  • Documented the required name value (control) for the constructor.
  • Documented the allowed actions values (null or empty string).
  • Added a concise constructor <summary>.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

@dalexsoto review

@dalexsotodalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs/xml/Java.Util.Logging/LoggingPermission.xml: the constructor documents the accepted values but omits its enforced failure behavior. A null name throws Java.Lang.NullPointerException, while an empty/invalid name or invalid actions throw Java.Lang.IllegalArgumentException. Please document both exceptions.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9bcaa47e-a2e3-4285-a2e4-630247d650b1
@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

Addressed the requested constructor failure behavior in 6ba4e58: documented Java.Lang.NullPointerException for a null
ame, and Java.Lang.IllegalArgumentException for an empty/invalid
ame or invalid �ctions.

@dalexsotodalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new constructor contract contradicts supported Android behavior. Android's LoggingPermission constructor ignores both arguments and calls super("", ""), so null/invalid names and arbitrary actions are accepted; the nullable managed signature reflects this. Please document that Android ignores the arguments and remove the unsupported exception claims.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 9bcaa47e-a2e3-4285-a2e4-630247d650b1
@jonathanpeppers

Copy link
Copy Markdown
MemberAuthor

Addressed the Android-specific behavior in 5a4c415. Both constructor parameters now say "Ignored on Android," and the unsupported exception claims were removed.

@dalexsotodalexsoto left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The LoggingPermission constructor now accurately documents Android's ignored arguments and nullable managed signature.

@jonathanpeppers
jonathanpeppers merged commit c512b0e into mainAug 18, 2026
3 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-java-util-logging-docs branch August 18, 2026 18:38
Sign up for freeto 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.

3 participants

@jonathanpeppers@dalexsoto