--- a/jdk/src/java.base/share/classes/java/lang/String.java Tue Oct 27 10:14:36 2015 +0530
+++ b/jdk/src/java.base/share/classes/java/lang/String.java Tue Oct 27 09:20:24 2015 -0700
@@ -102,6 +102,10 @@
* Unicode code points (i.e., characters), in addition to those for
* dealing with Unicode code units (i.e., {@code char} values).
*
+ * <p>Unless otherwise noted, methods for comparing Strings do not take locale
+ * into account. The {@link java.text.Collator} class provides methods for
+ * finer-grain, locale-sensitive String comparison.
+ *
* @author Lee Boynton
* @author Arthur van Hoff
* @author Martin Buchholz
@@ -971,6 +975,9 @@
* String} object that represents the same sequence of characters as this
* object.
*
+ * <p>For finer-grained String comparison, refer to
+ * {@link java.text.Collator}.
+ *
* @param anObject
* The object to compare this {@code String} against
*
@@ -1008,6 +1015,9 @@
* sequence of characters as the specified {@code StringBuffer}. This method
* synchronizes on the {@code StringBuffer}.
*
+ * <p>For finer-grained String comparison, refer to
+ * {@link java.text.Collator}.
+ *
* @param sb
* The {@code StringBuffer} to compare this {@code String} against
*
@@ -1043,6 +1053,9 @@
* {@code CharSequence} is a {@code StringBuffer} then the method
* synchronizes on it.
*
+ * <p>For finer-grained String comparison, refer to
+ * {@link java.text.Collator}.
+ *
* @param cs
* The sequence to compare this {@code String} against
*
@@ -1092,14 +1105,14 @@
* <ul>
* <li> The two characters are the same (as compared by the
* {@code ==} operator)
- * <li> Applying the method {@link
- * java.lang.Character#toUpperCase(char)} to each character
- * produces the same result
- * <li> Applying the method {@link
- * java.lang.Character#toLowerCase(char)} to each character
- * produces the same result
+ * <li> Calling {@code Character.toLowerCase(Character.toUpperCase(char))}
+ * on each character produces the same result
* </ul>
*
+ * <p>Note that this method does <em>not</em> take locale into account, and
+ * will result in unsatisfactory results for certain locales. The
+ * {@link java.text.Collator} class provides locale-sensitive comparison.
+ *
* @param anotherString
* The {@code String} to compare this {@code String} against
*
@@ -1150,6 +1163,9 @@
* this.length()-anotherString.length()
* </pre></blockquote>
*
+ * <p>For finer-grained String comparison, refer to
+ * {@link java.text.Collator}.
+ *
* @param anotherString the {@code String} to be compared.
* @return the value {@code 0} if the argument string is equal to
* this string; a value less than {@code 0} if this string
@@ -1181,10 +1197,9 @@
* <p>
* Note that this Comparator does <em>not</em> take locale into account,
* and will result in an unsatisfactory ordering for certain locales.
- * The java.text package provides <em>Collators</em> to allow
- * locale-sensitive ordering.
+ * The {@link java.text.Collator} class provides locale-sensitive comparison.
*
- * @see java.text.Collator#compare(String, String)
+ * @see java.text.Collator
* @since 1.2
*/
public static final Comparator<String> CASE_INSENSITIVE_ORDER
@@ -1231,14 +1246,13 @@
* <p>
* Note that this method does <em>not</em> take locale into account,
* and will result in an unsatisfactory ordering for certain locales.
- * The java.text package provides <em>collators</em> to allow
- * locale-sensitive ordering.
+ * The {@link java.text.Collator} class provides locale-sensitive comparison.
*
* @param str the {@code String} to be compared.
* @return a negative integer, zero, or a positive integer as the
* specified String is greater than, equal to, or less
* than this String, ignoring case considerations.
- * @see java.text.Collator#compare(String, String)
+ * @see java.text.Collator
* @since 1.2
*/
public int compareToIgnoreCase(String str) {
@@ -1268,6 +1282,9 @@
* <i>k</i>{@code )}
* </ul>
*
+ * <p>Note that this method does <em>not</em> take locale into account. The
+ * {@link java.text.Collator} class provides locale-sensitive comparison.
+ *
* @param toffset the starting offset of the subregion in this string.
* @param other the string argument.
* @param ooffset the starting offset of the subregion in the string
@@ -1323,16 +1340,16 @@
* <li>{@code ignoreCase} is {@code true} and there is some nonnegative
* integer <i>k</i> less than {@code len} such that:
* <blockquote><pre>
- * Character.toLowerCase(this.charAt(toffset+k)) !=
- Character.toLowerCase(other.charAt(ooffset+k))
- * </pre></blockquote>
- * and:
- * <blockquote><pre>
- * Character.toUpperCase(this.charAt(toffset+k)) !=
- * Character.toUpperCase(other.charAt(ooffset+k))
+ * Character.toLowerCase(Character.toUpperCase(this.charAt(toffset+k))) !=
+ Character.toLowerCase(Character.toUpperCase(other.charAt(ooffset+k)))
* </pre></blockquote>
* </ul>
*
+ * <p>Note that this method does <em>not</em> take locale into account,
+ * and will result in unsatisfactory results for certain locales when
+ * {@code ignoreCase} is {@code true}. The {@link java.text.Collator} class
+ * provides locale-sensitive comparison.
+ *
* @param ignoreCase if {@code true}, ignore case when comparing
* characters.
* @param toffset the starting offset of the subregion in this