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

2021-02-12 Thread Stuart Marks
On Fri, 12 Feb 2021 22:12:30 GMT, Joe Darcy wrote: >> src/java.base/share/classes/java/lang/Comparable.java line 90: >> >>> 88: * of the {@code equals} method and the equivalence classes defined by >>> 89: * the quotient of the {@code compareTo} method are the same. >>> 90: * >> >> I think

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

2021-02-12 Thread Joe Darcy
On Fri, 12 Feb 2021 22:39:55 GMT, Roger Riggs wrote: >> Added "The string output is not necessary stable over time." The particulars >> of the toString contract of a given class will depend on the class of course. > > Perhaps "necessary" -> "necessarily" Good catch Roger; will change to "The

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

2021-02-12 Thread Roger Riggs
On Fri, 12 Feb 2021 22:28:33 GMT, Joe Darcy wrote: >> src/java.base/share/classes/java/lang/Object.java line 236: >> >>> 234: * be a concise but informative representation that is easy for a >>> 235: * person to read. >>> 236: * It is recommended that all subclasses override this

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

2021-02-12 Thread Joe Darcy
On Thu, 11 Feb 2021 04:44:08 GMT, Stuart Marks wrote: >> src/java.base/share/classes/java/math/BigDecimal.java line 97: >> >>> 95: * contrast, the {@link equals equals} method requires both the >>> 96: * numerical value and representation to be the same for equality to >>> 97: * hold. >> >>

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

2021-02-12 Thread Joe Darcy
On Thu, 11 Feb 2021 04:22:18 GMT, Stuart Marks wrote: >> Joe Darcy has updated the pull request incrementally with one additional >> commit since the last revision: >> >> Fix typos in javadoc tags found during review. > > src/java.base/share/classes/java/lang/Object.java line 236: > >> 234:

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

2021-02-12 Thread Joe Darcy
On Thu, 11 Feb 2021 04:17:48 GMT, Stuart Marks wrote: >> Joe Darcy has updated the pull request incrementally with one additional >> commit since the last revision: >> >> Fix typos in javadoc tags found during review. > > src/java.base/share/classes/java/lang/Object.java line 135: > >> 133:

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

2021-02-12 Thread Joe Darcy
On Thu, 11 Feb 2021 04:12:06 GMT, Stuart Marks wrote: >> Joe Darcy has updated the pull request incrementally with one additional >> commit since the last revision: >> >> Fix typos in javadoc tags found during review. > > src/java.base/share/classes/java/lang/Comparable.java line 90: > >>

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

2021-02-12 Thread Joe Darcy
On Thu, 11 Feb 2021 04:09:16 GMT, Stuart Marks wrote: >> Joe Darcy has updated the pull request incrementally with one additional >> commit since the last revision: >> >> Fix typos in javadoc tags found during review. > > src/java.base/share/classes/java/lang/Comparable.java line 68: > >>

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

2021-02-11 Thread Joe Darcy
On Thu, 11 Feb 2021 04:37:34 GMT, Stuart Marks wrote: >> Joe Darcy has updated the pull request incrementally with one additional >> commit since the last revision: >> >> Fix typos in javadoc tags found during review. > > src/java.base/share/classes/java/util/Comparator.java line 159: > >>

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

2021-02-11 Thread Joe Darcy
On Thu, 11 Feb 2021 04:19:29 GMT, Stuart Marks wrote: >> Joe Darcy has updated the pull request incrementally with one additional >> commit since the last revision: >> >> Fix typos in javadoc tags found during review. > > src/java.base/share/classes/java/lang/Object.java line 149: > >> 147:

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

2021-02-11 Thread Joe Darcy
On Thu, 11 Feb 2021 04:14:08 GMT, Stuart Marks wrote: >> Joe Darcy has updated the pull request incrementally with one additional >> commit since the last revision: >> >> Fix typos in javadoc tags found during review. > > src/java.base/share/classes/java/lang/Comparable.java line 110: > >>

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

2021-02-10 Thread Joe Darcy
On Thu, 11 Feb 2021 04:29:11 GMT, Stuart Marks wrote: >> 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:". My thinking here

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

2021-02-10 Thread Stuart Marks
On Thu, 11 Feb 2021 04:24:40 GMT, Stuart Marks wrote: >> Joe Darcy has updated the pull request incrementally with one additional >> commit since the last revision: >> >> Fix typos in javadoc tags found during review. > > src/java.base/share/classes/java/math/BigDecimal.java line 97: > >>

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

2021-02-10 Thread Stuart Marks
On Wed, 10 Feb 2021 01:49:55 GMT, Joe Darcy wrote: >> A follow-up of sorts to JDK-8257086, this change aims to improve the >> discussion of the relationship between Object.equals and compareTo and >> compare methods. The not-consistent-with-equals natural ordering of >> BigDecimal get more

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

2021-02-10 Thread Stuart Marks
On Wed, 10 Feb 2021 02:55:14 GMT, Brian Burkhalter 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

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

2021-02-09 Thread Brian Burkhalter
On Wed, 10 Feb 2021 01:55:24 GMT, Joe Darcy wrote: >> src/java.base/share/classes/java/math/BigDecimal.java line 3062: >> >>> 3060: >>> 3061: * @apiNote >>> 3062: * Note: this class has a natural ordering that is inconsistent >>> with equals. >> >> Is `Note: ` really needed? > >

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

2021-02-09 Thread Brian Burkhalter
On Wed, 10 Feb 2021 01:49:55 GMT, Joe Darcy wrote: >> A follow-up of sorts to JDK-8257086, this change aims to improve the >> discussion of the relationship between Object.equals and compareTo and >> compare methods. The not-consistent-with-equals natural ordering of >> BigDecimal get more

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

2021-02-09 Thread Joe Darcy
On Tue, 9 Feb 2021 19:41:25 GMT, Brian Burkhalter wrote: >> Joe Darcy has updated the pull request incrementally with one additional >> commit since the last revision: >> >> Fix typos in javadoc tags found during review. > > src/java.base/share/classes/java/lang/Object.java line 148: > >>

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

2021-02-09 Thread Joe Darcy
> A follow-up of sorts to JDK-8257086, this change aims to improve the > discussion of the relationship between Object.equals and compareTo and > compare methods. The not-consistent-with-equals natural ordering of > BigDecimal get more explication too. While updating Object, I added some uses