RFR: 8310033: Clarify return value of Java Time compareTo methods [v2]

Roger Riggs rriggs at openjdk.org
Fri Jun 16 22:12:43 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 with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains five additional commits since the last revision:

 - Use {@code xxx} to highlight the comparison against the arg.
   Update copyrights.
 - Merge branch 'master' into 8310033-time-compareto
 - Clarify for Duration, AbstractChronology, and Chronology
 - Correct javadoc of compareInstant
 - 8310033: Improve Instant.compareTo javadoc to mention before and after
   Refine timeline order to mention before and after
   Add javadoc @see tags to isBefore and isAfter methods

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

Changes:
  - all: https://git.openjdk.org/jdk/pull/14479/files
  - new: https://git.openjdk.org/jdk/pull/14479/files/61021307..cd997ede

Webrevs:
 - full: https://webrevs.openjdk.org/?repo=jdk&pr=14479&range=01
 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=14479&range=00-01

  Stats: 12213 lines in 386 files changed: 3676 ins; 7398 del; 1139 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