RFR: 8310033: Clarify return value of Java Time compareTo methods [v6]
Roger Riggs
rriggs at openjdk.org
Fri Jul 7 20:37:00 UTC 2023
> In java.time packages, clarify timeline order javadoc to mention "before" and "after" in the value of the `compareTo` method return values.
> Add javadoc @see tags to isBefore and isAfter methods
>
> Replace use of "negative" and positive with "less than zero" and "greater than zero" in javadoc @return
> The term "positive" is ambiguous, zero is considered positive and indicates equality.
Roger Riggs has updated the pull request incrementally with one additional commit since the last revision:
Correct the descriptions to correctly identify the compareTo return
value < 0 as this is before that, and > 0 as this is after that.
Thanks to a careful reviewer spotting my reversing of the conditions.
-------------
Changes:
- all: https://git.openjdk.org/jdk/pull/14479/files
- new: https://git.openjdk.org/jdk/pull/14479/files/71dc98ae..5e07e79a
Webrevs:
- full: https://webrevs.openjdk.org/?repo=jdk&pr=14479&range=05
- incr: https://webrevs.openjdk.org/?repo=jdk&pr=14479&range=04-05
Stats: 40 lines in 17 files changed: 0 ins; 6 del; 34 mod
Patch: https://git.openjdk.org/jdk/pull/14479.diff
Fetch: git fetch https://git.openjdk.org/jdk.git pull/14479/head:pull/14479
PR: https://git.openjdk.org/jdk/pull/14479
More information about the core-libs-dev
mailing list