8267262: com/sun/net/httpserver/Filter improve API documentation of static methods

[FrauBoes]

The filter operation Consumer that is passed to the factory methods can throw an unchecked exception. This change adds a note on the exception handling in that case. It also adds a clarification to Filter::afterHandler on the relation of the filter operation and the client receiving the response.

CSR: https://bugs.openjdk.java.net/browse/JDK-8267379

---

Progress

• Change must not contain extraneous whitespace
• Commit message must refer to an issue
• Change must be properly reviewed

Issue

• JDK-8267262: com/sun/net/httpserver/Filter improve API documentation of static methods

Reviewers

• Daniel Fuchs (@dfuch - Reviewer) ⚠️ Review applies to ef8ffbf
• Chris Hegarty (@ChrisHegarty - Reviewer) ⚠️ Review applies to ef8ffbf

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/4085/head:pull/4085
$ git checkout pull/4085

Update a local copy of the PR:
$ git checkout pull/4085
$ git pull https://git.openjdk.java.net/jdk pull/4085/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 4085

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/4085.diff

[bridgekeeper]

👋 Welcome back jboes! 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]

@FrauBoes The following label will be automatically applied to this pull request:

• net

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.

[openjdk]

@FrauBoes 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:

8267262: com/sun/net/httpserver/Filter improve API documentation of static methods

Reviewed-by: dfuchs, chegar

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 33 new commits pushed to the master branch:

• 237fee8: 8267339: Temporarily disable os.release_multi_mappings_vm on macOS x64
• 64e2479: 8267407: ProblemList vmTestbase/vm/mlvm/anonloader/stress/oome/metaspace/Test.java on linux-aarch64
• 9760dba: 8267321: Use switch expression for VarHandle$AccessMode lookup
• fdd0352: 8267338: [JVMCI] revive JVMCI API removed by JDK-8243287
• 0b49f5a: 8267257: Shenandoah: Always deduplicate strings when it is enabled during full gc
• 12050f0: 8266651: Convert Table method parameters from String to Content
• e749f75: 8267304: Bump global JTReg memory limit to 768m
• e858dd6: 8267361: JavaTokenizer reads octal numbers mistakenly
• 1b93b81: 8267133: jdk/jfr/event/gc/collection/TestG1ParallelPhases.java fails with Not expected phases: RestorePreservedMarks, RemoveSelfForwardingPtr: expected true, was false
• 88b1142: 8267357: build breaks with -Werror option on micro benchmark added for JDK-8256973
• ... and 23 more: https://git.openjdk.java.net/jdk/compare/894547d2c102dcbe1f9ec8a1edb11c6b31e4270e...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.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[mlbridge]

Webrevs

• 02: Full - Incremental (4ea073a0)
• 01: Full - Incremental (8d3749b7)
• 00: Full (ef8ffbfe)

[dfuch]

I suspect this need a CSR...
/csr needed

[openjdk]

@dfuch has indicated that a compatibility and specification (CSR) request is needed for this pull request.
@FrauBoes please create a CSR request for issue JDK-8267262. This pull request cannot be integrated until the CSR request is approved.

[FrauBoes]

CSR for review: https://bugs.openjdk.java.net/browse/JDK-8267379

[FrauBoes]

/integrate

[openjdk]

@FrauBoes Since your change was applied there have been 44 commits pushed to the master branch:

• 7dcb9fd: 8265684: implement Sealed Classes as a standard feature in Java, javadoc changes
• 0fa9223: 8260517: implement Sealed Classes as a standard feature in Java
• 31b98e1: 8265319: implement Sealed Classes as a standard feature in Java, javax.lang.model changes
• 726785b: 8267155: runtime/os/TestTracePageSizes times out
• 8e3549f: 8266332: Adler32 intrinsic for x86 64-bit platforms
• b961f25: 8267191: Avoid repeated SystemDictionaryShared::should_be_excluded calls
• 74f30ad: 8263684: Avoid wrapping into BufferedWriter twice
• 9820f3d: 8267371: Concurrent gtests take too long
• 38d690b: 8265262: CITime - 'other' incorrectly calculated
• 66ab6d8: 8264181: javadoc tool Incorrect error message about malformed link
• ... and 34 more: https://git.openjdk.java.net/jdk/compare/894547d2c102dcbe1f9ec8a1edb11c6b31e4270e...master

Your commit was automatically rebased without conflicts.

Pushed as commit 31320c3.

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