RFR: 8310033: Clarify return value of Java Time compareTo methods

Roger Riggs rriggs at openjdk.org
Fri Jun 16 19:31:22 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.

-------------

Commit messages:
 - Clarify for Duration, AbstractChronology, and Chronology
 - Correct javadoc of compareInstant
 - 8310033: Improve Instant.compareTo javadoc to mention before and after

Changes: https://git.openjdk.org/jdk/pull/14479/files
 Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=14479&range=00
  Issue: https://bugs.openjdk.org/browse/JDK-8310033
  Stats: 60 lines in 17 files changed: 42 ins; 0 del; 18 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