RFR: 8261123: Augment discussion of equivalence classes in Object.equals and comparison methods [v3]

Stuart Marks smarks at openjdk.java.net
Thu Feb 11 04:49:42 UTC 2021


On Wed, 10 Feb 2021 02:55:14 GMT, Brian Burkhalter <bpb at openjdk.org> wrote:

>> This is the exact text recommended in java.lang.Comparable when a type's natural ordering is inconsistent with equals. The statement to that effect at the top of BigDecimal didn't use that exact wording
>
> Okay, I see.

The note itself should be here, but it's demarcated with an `@apiNote` tag. This introduces a subhead "API Note:" in the rendered javadoc. Thus, it's not necessary to start the text with "Note:".

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

PR: https://git.openjdk.java.net/jdk/pull/2471


More information about the core-libs-dev mailing list