8299502: Usage of constructors of primitive wrapper classes should be avoided in javax.xml API docs

[justin-curtis-lu]

Removed constructors of primitive wrapper classes (deprecated for removal) in javax.xml.stream.XMLOutputFactory

Replaced with Boolean static fields: Boolean.TRUE and Boolean.FALSE

---

Progress

• Change must be properly reviewed (1 review required, with at least 1 Reviewer)
• Change must not contain extraneous whitespace
• Commit message must refer to an issue

Issue

• JDK-8299502: Usage of constructors of primitive wrapper classes should be avoided in javax.xml API docs

Reviewers

• Joe Wang (@JoeWang-Java - Reviewer)
• Naoto Sato (@naotoj - Reviewer)
• Lance Andersen (@LanceAndersen - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk pull/11872/head:pull/11872
$ git checkout pull/11872

Update a local copy of the PR:
$ git checkout pull/11872
$ git pull https://git.openjdk.org/jdk pull/11872/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 11872

View PR using the GUI difftool:
$ git pr show -t 11872

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/11872.diff

[bridgekeeper]

👋 Welcome back justin-curtis-lu! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@justin-curtis-lu The following label will be automatically applied to this pull request:

• core-libs

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

[justin-curtis-lu]

From a code standpoint I don't see why the OR operation is needed (Also, shouldn't a Conditional OR be used over a Bitwise OR). Is it to emphasize that true or false can be passed as a parameter?

[JoeWang-Java]

I think the later, that the value can be true or false. As an example, one value is fine, e.g.
{@code setProperty("javax.xml.stream.isRepairingNamespaces", Boolean.TRUE);}
or
{@code setProperty("javax.xml.stream.isRepairingNamespaces", true);}
let autoboxing handle it.

[LanceAndersen]

The true|false should just be changed to just set the value to true or false.

I think Boolean.TRUE is fine. If the consensus is to use autoboxing in the example that is fine also.

[justin-curtis-lu]

Thank you Joe and Lance, will replace it with a single value

[mlbridge]

Webrevs

• 01: Full - Incremental (91d20422)
• 00: Full (44c37d9f)

[openjdk]

@justin-curtis-lu This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8299502: Usage of constructors of primitive wrapper classes should be avoided in javax.xml API docs

Reviewed-by: joehw, naoto, lancea

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 61 new commits pushed to the master branch:

• 679e485: 8043251: Bogus javac error: required: no arguments, found: no arguments
• cd10c72: 8299500: Usage of constructors of primitive wrapper classes should be avoided in java.text API docs
• bfd5971: 8299757: Update JCov version to 3.0.14
• 17a3f0e: 8299275: Add some ClassLoaderData verification code
• 4ba8122: 8299312: Clean up BarrierSetNMethod
• 66db0bb: 8299692: G1: Remove unused G1BlockOffsetTable::is_card_boundary
• 7068457: 8298472: AArch64: Detect Ampere-1 and Ampere-1A CPUs and set default options
• 500c3c1: 8298730: Refactor subsystem_file_line_contents and add docs and tests
• 4072412: 8298876: Swing applications do not get repainted coming out of sleep on Windows 10
• a503ec2: 8299608: Add Register + imm32 orq to x86_64 assembler
• ... and 51 more: https://git.openjdk.org/jdk/compare/44be5edf5aa661169c665aa9386e5930a3632524...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@JoeWang-Java, @naotoj, @LanceAndersen) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

[justin-curtis-lu]

/integrate

[openjdk]

@justin-curtis-lu
Your change (at version 91d2042) is now ready to be sponsored by a Committer.

[naotoj]

/sponsor

[openjdk]

Going to push as commit b8852f6.
Since your change was applied there have been 61 commits pushed to the master branch:

• 679e485: 8043251: Bogus javac error: required: no arguments, found: no arguments
• cd10c72: 8299500: Usage of constructors of primitive wrapper classes should be avoided in java.text API docs
• bfd5971: 8299757: Update JCov version to 3.0.14
• 17a3f0e: 8299275: Add some ClassLoaderData verification code
• 4ba8122: 8299312: Clean up BarrierSetNMethod
• 66db0bb: 8299692: G1: Remove unused G1BlockOffsetTable::is_card_boundary
• 7068457: 8298472: AArch64: Detect Ampere-1 and Ampere-1A CPUs and set default options
• 500c3c1: 8298730: Refactor subsystem_file_line_contents and add docs and tests
• 4072412: 8298876: Swing applications do not get repainted coming out of sleep on Windows 10
• a503ec2: 8299608: Add Register + imm32 orq to x86_64 assembler
• ... and 51 more: https://git.openjdk.org/jdk/compare/44be5edf5aa661169c665aa9386e5930a3632524...master

Your commit was automatically rebased without conflicts.

[openjdk]

@naotoj @justin-curtis-lu Pushed as commit b8852f6.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

[altrisi]

Why not just true and false? Autoboxing handles that.

Edit: I have now seen it has already been mentioned, though I still don't understand what does using BOOLEAN.[val] add.

[justin-curtis-lu]

Why not just true and false? Autoboxing handles that.

That was a topic that was talked about in 8299498. It seemed that there was a consensus from a documentation standpoint that it was more clear to use the wrapper methods/fields (valueOf() or in this case Boolean.TRUE)

[altrisi]

I'd say in there it makes more sense given the method is used when you want a wrapper, and therefore explicitly converting it helps documentation, but here it's just setting a property, where I don't think it helps anything, just decreases readability as it seems like there may be a reason to call it explicitly with a wrapper and not a simple true/false.

[justin-curtis-lu]

I'd say in there it makes more sense given the method is used when you want a wrapper, and therefore explicitly converting it helps documentation, but here it's just setting a property, where I don't think it helps anything, just decreases readability as it seems like there may be a reason to call it explicitly with a wrapper and not a simple true/false.

In setProperty(String name, Object value), the method is expecting value to be an Object. Like the other methods, it is a matter of passing the wrapper class or letting the primitive auto box. Passing true or false would have auto boxed boolean to Boolean.

The original statement before my change passed a Boolean, the consensus from the other PR was to pass the wrapper class, setProperty() is expecting value to be an Object, and the implementation of setProperty() casts value to be Boolean regardless. Those are the reasons why I picked the wrapper over the primitive.

I think an argument can be made for either way, and I don't necessarily believe one way is right or wrong, hope that helped.