RFR: 8309819: Clarify API note in Class::getName and MethodType::toMethodDescriptorString [v5]
Chen Liang
liach at openjdk.org
Thu Jun 15 02:38:08 UTC 2023
> The API specification for descriptorString not being a strict inverse of Class::forName and MethodType::fromDescriptorString are not entirely correct.
>
> 1. Class::descriptorString was never an inverse of Class::forName, which takes a binary name instead. Class::getName was a partial inverse instead.
> 2. MethodType::toMethodDescriptorString ends with a meaningless sentence: "fromMethodDescriptorString, because the latter requires a suitable class loader argument.", and the "Note:" section can be replaced with an `@apiNote`.
> 3. Both of these didn't mention hidden classes (or other non-nominally-describable classes) as a reason that prevents the inversion operation, in addition to distinct classloaders.
>
> A few user-defined anchor links are replaced with updated javadoc link tag format as well. The explicit html-style links in `@see` tags are unchanged in order to retain the non-code output.
>
> The rendered specifications:
> https://cr.openjdk.org/~liach/8309819/03/java.base/java/lang/Class.html
> https://cr.openjdk.org/~liach/8309819/03/java.base/java/lang/invoke/MethodType.html
Chen Liang has updated the pull request incrementally with one additional commit since the last revision:
Update the note for getName
-------------
Changes:
- all: https://git.openjdk.org/jdk/pull/14411/files
- new: https://git.openjdk.org/jdk/pull/14411/files/6950d2ed..ff26c099
Webrevs:
- full: https://webrevs.openjdk.org/?repo=jdk&pr=14411&range=04
- incr: https://webrevs.openjdk.org/?repo=jdk&pr=14411&range=03-04
Stats: 5 lines in 1 file changed: 1 ins; 0 del; 4 mod
Patch: https://git.openjdk.org/jdk/pull/14411.diff
Fetch: git fetch https://git.openjdk.org/jdk.git pull/14411/head:pull/14411
PR: https://git.openjdk.org/jdk/pull/14411
More information about the core-libs-dev
mailing list