Collator class performs locale-sensitive
- * String comparison. You use this class to build
+ * The {@code Collator} class performs locale-sensitive
+ * {@code String} comparison. You use this class to build
* searching and sorting routines for natural language text.
*
*
- * Collator is an abstract base class. Subclasses
+ * {@code Collator} is an abstract base class. Subclasses
* implement specific collation strategies. One subclass,
- * RuleBasedCollator, is currently provided with
+ * {@code RuleBasedCollator}, is currently provided with
* the Java Platform and is applicable to a wide set of languages. Other
* subclasses may be created to handle more specialized needs.
*
*
* Like other locale-sensitive classes, you can use the static
- * factory method, getInstance, to obtain the appropriate
- * Collator object for a given locale. You will only need
- * to look at the subclasses of Collator if you need
+ * factory method, {@code getInstance}, to obtain the appropriate
+ * {@code Collator} object for a given locale. You will only need
+ * to look at the subclasses of {@code Collator} if you need
* to understand the details of a particular collation strategy or
* if you need to modify that strategy.
*
*
* The following example shows how to compare two strings using
- * the Collator for the default locale.
+ * the {@code Collator} for the default locale.
*
* {@code
* // Compare two strings in the default locale
@@ -83,10 +83,10 @@
*
*
*
- * You can set a Collator's strength property
+ * You can set a {@code Collator}'s strength property
* to determine the level of difference considered significant in
- * comparisons. Four strengths are provided: PRIMARY,
- * SECONDARY, TERTIARY, and IDENTICAL.
+ * comparisons. Four strengths are provided: {@code PRIMARY},
+ * {@code SECONDARY}, {@code TERTIARY}, and {@code IDENTICAL}.
* The exact assignment of strengths to language features is
* locale dependent. For example, in Czech, "e" and "f" are considered
* primary differences, while "e" and "ě" are secondary differences,
@@ -104,19 +104,19 @@
*
*
*
- * For comparing Strings exactly once, the compare
+ * For comparing {@code String}s exactly once, the {@code compare}
* method provides the best performance. When sorting a list of
- * Strings however, it is generally necessary to compare each
- * String multiple times. In this case, CollationKeys
- * provide better performance. The CollationKey class converts
- * a String to a series of bits that can be compared bitwise
- * against other CollationKeys. A CollationKey is
- * created by a Collator object for a given String.
+ * {@code String}s however, it is generally necessary to compare each
+ * {@code String} multiple times. In this case, {@code CollationKey}s
+ * provide better performance. The {@code CollationKey} class converts
+ * a {@code String} to a series of bits that can be compared bitwise
+ * against other {@code CollationKey}s. A {@code CollationKey} is
+ * created by a {@code Collator} object for a given {@code String}.
*
- * Note: CollationKeys from different
- * Collators can not be compared. See the class description
+ * Note: {@code CollationKey}s from different
+ * {@code Collator}s can not be compared. See the class description
* for {@link CollationKey}
- * for an example using CollationKeys.
+ * for an example using {@code CollationKey}s.
*
* @see RuleBasedCollator
* @see CollationKey
@@ -291,7 +291,7 @@
* to, or greater than the second.
*
* This implementation merely returns
- * compare((String)o1, (String)o2) .
+ * {@code compare((String)o1, (String)o2) }.
*
* @return a negative integer, zero, or a positive integer as the
* first argument is less than, equal to, or greater than the
@@ -416,7 +416,7 @@
/**
* Returns an array of all locales for which the
- * getInstance methods of this class can return
+ * {@code getInstance} methods of this class can return
* localized instances.
* The returned array represents the union of locales supported
* by the Java runtime and by installed
@@ -425,7 +425,7 @@
* {@link java.util.Locale#US Locale.US}.
*
* @return An array of locales for which localized
- * Collator instances are available.
+ * {@code Collator} instances are available.
*/
public static synchronized Locale[] getAvailableLocales() {
LocaleServiceProviderPool pool =