OpenJDK 1.23 · java.text.Collator · APIdia, the JavaDoc alternative

The Collator class performs locale-sensitive String comparison. You use this class to build searching and sorting routines for natural language text.

Collator is an abstract base class. Subclasses implement specific collation strategies. One subclass, 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 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.

// Compare two strings in the default locale
Collator myCollator = Collator.getInstance();
if (myCollator.compare("abc", "ABC") < 0) {
    System.out.println("abc is less than ABC");
} else {
    System.out.println("abc is greater than or equal to ABC");
}

You can set a Collator's strength property to determine the level of difference considered significant in comparisons. Four strengths are provided: PRIMARY, SECONDARY, TERTIARY, and 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, "e" and "E" are tertiary differences and "e" and "e" are identical. The following shows how both case and accents could be ignored for US English.

// Get the Collator for US English and set its strength to PRIMARY
Collator usCollator = Collator.getInstance(Locale.US);
usCollator.setStrength(Collator.PRIMARY);
if (usCollator.compare("abc", "ABC") == 0) {
    System.out.println("Strings are equivalent");
}

For comparing Strings exactly once, the 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.

Field Summary

Modifier and Type	Field and Description
private static final ConcurrentMap<Locale, SoftReference<Collator>>	cache
public static final int	CANONICAL_DECOMPOSITION Decomposition mode value.
private int	decmp
pack-priv static final int	EQUAL EQUAL is returned if source string is compared to be equal to target string in the compare() method.
public static final int	FULL_DECOMPOSITION Decomposition mode value.
pack-priv static final int	GREATER GREATER is returned if source string is compared to be greater than target string in the compare() method.
public static final int	IDENTICAL Collator strength value.
pack-priv static final int	LESS LESS is returned if source string is compared to be less than target string in the compare() method.
public static final int	NO_DECOMPOSITION Decomposition mode value.
public static final int	PRIMARY Collator strength value.
public static final int	SECONDARY Collator strength value.
private int	strength
public static final int	TERTIARY Collator strength value.

Access	Constructor and Description
protected	Collator() Default constructor.

Method Summary

Modifier and Type	Method and Description
public Object	clone() Overrides java.lang.Object.clone. Overrides Cloneable
public abstract int	Returns: Returns an integer value. Value is less than zero if source is less than target, value is zero if source and target are equal, value is greater than zero if source is greater than target. compare(String the source string. source, String the target string. target) Redeclares java.util.Comparator.compare. Compares the source string to the target string according to the collation rules for this Collator.
public int	Returns: a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. compare(Object the first object to be compared. o1, Object the second object to be compared. o2) Implements java.util.Comparator.compare. Compares its two arguments for order.
public boolean	Returns: true if the strings are equal according to the collation rules. false, otherwise. equals(String the source string to be compared with. source, String the target string to be compared with. target) Convenience method for comparing the equality of two strings based on this Collator's collation rules.
public boolean	Returns: true if this Collator is the same as that Collator; false otherwise. equals(Object the Collator to be compared with this. that) Overrides java.lang.Object.equals. Implements java.util.Comparator.equals. Compares the equality of two Collators.
public static synchronized Locale[]	Returns: An array of locales for which localized `Collator` instances are available. getAvailableLocales() Returns an array of all locales for which the `getInstance` methods of this class can return localized instances.
public abstract CollationKey	Returns: the CollationKey for the given String based on this Collator's collation rules. If the source String is null, a null CollationKey is returned. getCollationKey(String the string to be transformed into a collation key. source) Transforms the String into a series of bits that can be compared bitwise to other CollationKeys.
public synchronized int	Returns: the decomposition mode getDecomposition() Get the decomposition mode of this Collator.
public static synchronized Collator	Returns: the Collator for the default locale.(for example, en_US) getInstance() Gets the Collator for the current default locale.
public static Collator	Returns: the Collator for the desired locale. getInstance(Locale the desired locale. desiredLocale) Gets the Collator for the desired locale.
public synchronized int	Returns: this Collator's current strength property. getStrength() Returns this Collator's strength property.
public abstract int	hashCode() Overrides java.lang.Object.hashCode. Generates the hash code for this Collator.
public synchronized void	setDecomposition(int the new decomposition mode. decompositionMode) Set the decomposition mode of this Collator.
public synchronized void	setStrength(int the new strength value. newStrength) Sets this Collator's strength property.

Inherited from java.lang.Object:: finalize getClass notify notifyAll toString wait wait wait

Field Detail

cache	back to summary
private static final ConcurrentMap<Locale, SoftReference<Collator>> cache

CANONICAL_DECOMPOSITION back to summary

CANONICAL_DECOMPOSITION	back to summary
public static final int CANONICAL_DECOMPOSITION Decomposition mode value. With CANONICAL_DECOMPOSITION set, characters that are canonical variants according to Unicode standard will be decomposed for collation. This should be used to get correct collation of accented characters. CANONICAL_DECOMPOSITION corresponds to Normalization Form D as described in Unicode Standard Annex #15: Unicode Normalization Forms. External Specification https://www.unicode.org/reports/tr15 See Also `java.text.Collator#getDecomposition`, `java.text.Collator#setDecomposition`

public static final int CANONICAL_DECOMPOSITION

Decomposition mode value. With CANONICAL_DECOMPOSITION set, characters that are canonical variants according to Unicode standard will be decomposed for collation. This should be used to get correct collation of accented characters.

CANONICAL_DECOMPOSITION corresponds to Normalization Form D as described in Unicode Standard Annex #15: Unicode Normalization Forms.

External Specification: https://www.unicode.org/reports/tr15
See Also: java.text.Collator#getDecomposition, java.text.Collator#setDecomposition

decmp	back to summary
private int decmp

EQUAL back to summary

EQUAL	back to summary
pack-priv static final int EQUAL EQUAL is returned if source string is compared to be equal to target string in the compare() method. See Also `java.text.Collator#compare`

pack-priv static final int EQUAL

EQUAL is returned if source string is compared to be equal to target string in the compare() method.

See Also: java.text.Collator#compare

FULL_DECOMPOSITION back to summary

FULL_DECOMPOSITION	back to summary
public static final int FULL_DECOMPOSITION Decomposition mode value. With FULL_DECOMPOSITION set, both Unicode canonical variants and Unicode compatibility variants will be decomposed for collation. This causes not only accented characters to be collated, but also characters that have special formats to be collated with their norminal form. For example, the half-width and full-width ASCII and Katakana characters are then collated together. FULL_DECOMPOSITION is the most complete and therefore the slowest decomposition mode. FULL_DECOMPOSITION corresponds to Normalization Form KD as described in Unicode Standard Annex #15: Unicode Normalization Forms. External Specification https://www.unicode.org/reports/tr15 See Also `java.text.Collator#getDecomposition`, `java.text.Collator#setDecomposition`

public static final int FULL_DECOMPOSITION

Decomposition mode value. With FULL_DECOMPOSITION set, both Unicode canonical variants and Unicode compatibility variants will be decomposed for collation. This causes not only accented characters to be collated, but also characters that have special formats to be collated with their norminal form. For example, the half-width and full-width ASCII and Katakana characters are then collated together. FULL_DECOMPOSITION is the most complete and therefore the slowest decomposition mode.

FULL_DECOMPOSITION corresponds to Normalization Form KD as described in Unicode Standard Annex #15: Unicode Normalization Forms.

External Specification: https://www.unicode.org/reports/tr15
See Also: java.text.Collator#getDecomposition, java.text.Collator#setDecomposition

GREATER back to summary

GREATER	back to summary
pack-priv static final int GREATER GREATER is returned if source string is compared to be greater than target string in the compare() method. See Also `java.text.Collator#compare`

pack-priv static final int GREATER

GREATER is returned if source string is compared to be greater than target string in the compare() method.

See Also: java.text.Collator#compare

IDENTICAL	back to summary
public static final int IDENTICAL Collator strength value. When set, all differences are considered significant during comparison. The assignment of strengths to language features is locale dependent. A common example is for control characters ("\u0001" vs "\u0002") to be considered equal at the PRIMARY, SECONDARY, and TERTIARY levels but different at the IDENTICAL level. Additionally, differences between pre-composed accents such as "\u00C0" (A-grave) and combining accents such as "A\u0300" (A, combining-grave) will be considered significant at the IDENTICAL level if decomposition is set to NO_DECOMPOSITION.

IDENTICAL

back to summary

public static final int IDENTICAL

Collator strength value. When set, all differences are considered significant during comparison. The assignment of strengths to language features is locale dependent. A common example is for control characters ("\u0001" vs "\u0002") to be considered equal at the PRIMARY, SECONDARY, and TERTIARY levels but different at the IDENTICAL level. Additionally, differences between pre-composed accents such as "\u00C0" (A-grave) and combining accents such as "A\u0300" (A, combining-grave) will be considered significant at the IDENTICAL level if decomposition is set to NO_DECOMPOSITION.

LESS back to summary

LESS	back to summary
pack-priv static final int LESS LESS is returned if source string is compared to be less than target string in the compare() method. See Also `java.text.Collator#compare`

pack-priv static final int LESS

LESS is returned if source string is compared to be less than target string in the compare() method.

See Also: java.text.Collator#compare

NO_DECOMPOSITION back to summary

NO_DECOMPOSITION	back to summary
public static final int NO_DECOMPOSITION Decomposition mode value. With NO_DECOMPOSITION set, accented characters will not be decomposed for collation. This setting provides the fastest collation but will only produce correct results for languages that do not use accents. See Also `java.text.Collator#getDecomposition`, `java.text.Collator#setDecomposition`

public static final int NO_DECOMPOSITION

Decomposition mode value. With NO_DECOMPOSITION set, accented characters will not be decomposed for collation. This setting provides the fastest collation but will only produce correct results for languages that do not use accents.

See Also: java.text.Collator#getDecomposition, java.text.Collator#setDecomposition

PRIMARY back to summary

PRIMARY	back to summary
public static final int PRIMARY Collator strength value. When set, only PRIMARY differences are considered significant during comparison. The assignment of strengths to language features is locale dependent. A common example is for different base letters ("a" vs "b") to be considered a PRIMARY difference. See Also `java.text.Collator#setStrength`, `java.text.Collator#getStrength`

public static final int PRIMARY

Collator strength value. When set, only PRIMARY differences are considered significant during comparison. The assignment of strengths to language features is locale dependent. A common example is for different base letters ("a" vs "b") to be considered a PRIMARY difference.

See Also: java.text.Collator#setStrength, java.text.Collator#getStrength

SECONDARY back to summary

SECONDARY	back to summary
public static final int SECONDARY Collator strength value. When set, only SECONDARY and above differences are considered significant during comparison. The assignment of strengths to language features is locale dependent. A common example is for different accented forms of the same base letter ("a" vs "ä") to be considered a SECONDARY difference. See Also `java.text.Collator#setStrength`, `java.text.Collator#getStrength`

public static final int SECONDARY

Collator strength value. When set, only SECONDARY and above differences are considered significant during comparison. The assignment of strengths to language features is locale dependent. A common example is for different accented forms of the same base letter ("a" vs "ä") to be considered a SECONDARY difference.

See Also: java.text.Collator#setStrength, java.text.Collator#getStrength

strength	back to summary
private int strength

TERTIARY back to summary

TERTIARY	back to summary
public static final int TERTIARY Collator strength value. When set, only TERTIARY and above differences are considered significant during comparison. The assignment of strengths to language features is locale dependent. A common example is for case differences ("a" vs "A") to be considered a TERTIARY difference. See Also `java.text.Collator#setStrength`, `java.text.Collator#getStrength`

public static final int TERTIARY

Collator strength value. When set, only TERTIARY and above differences are considered significant during comparison. The assignment of strengths to language features is locale dependent. A common example is for case differences ("a" vs "A") to be considered a TERTIARY difference.

See Also: java.text.Collator#setStrength, java.text.Collator#getStrength

Constructor Detail

Collator back to summary

Collator	back to summary
protected Collator() Default constructor. This constructor is protected so subclasses can get access to it. Users typically create a Collator sub-class by calling the factory method getInstance. See Also `java.text.Collator#getInstance`

protected Collator()

Default constructor. This constructor is protected so subclasses can get access to it. Users typically create a Collator sub-class by calling the factory method getInstance.

See Also: java.text.Collator#getInstance

Method Detail

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Overrides Cloneable Returns:Object Doc from java.lang.Object.clone. a clone of this instance. Annotations @Override

clone

back to summary

public Object clone()

Overrides java.lang.Object.clone.

Overrides Cloneable

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations

@Override

compare back to summary

compare	back to summary
public abstract int compare(String source, String target) Redeclares java.util.Comparator.compare. Compares the source string to the target string according to the collation rules for this Collator. Returns an integer less than, equal to or greater than zero depending on whether the source String is less than, equal to or greater than the target string. See the Collator class description for an example of use. For a one time comparison, this method has the best performance. If a given String will be involved in multiple comparisons, CollationKey.compareTo has the best performance. See the Collator class description for an example using CollationKeys. Parameters source:String the source string. target:String the target string. Returns:int Returns an integer value. Value is less than zero if source is less than target, value is zero if source and target are equal, value is greater than zero if source is greater than target. See Also `java.text.CollationKey`, `java.text.Collator#getCollationKey`

public abstract int compare(String source, String target)

Redeclares java.util.Comparator.compare.

Compares the source string to the target string according to the collation rules for this Collator. Returns an integer less than, equal to or greater than zero depending on whether the source String is less than, equal to or greater than the target string. See the Collator class description for an example of use.

For a one time comparison, this method has the best performance. If a given String will be involved in multiple comparisons, CollationKey.compareTo has the best performance. See the Collator class description for an example using CollationKeys.

Parameters

source:String: the source string.
target:String: the target string.

Returns:int

Returns an integer value. Value is less than zero if source is less than target, value is zero if source and target are equal, value is greater than zero if source is greater than target.

compare back to summary

compare	back to summary
public int compare(Object o1, Object o2) Implements java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. This implementation merely returns `compare((String)o1, (String)o2)` . Parameters o1:Object Doc from java.util.Comparator.compare. the first object to be compared. o2:Object Doc from java.util.Comparator.compare. the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. Annotations @Override Exceptions ClassCastException: the arguments cannot be cast to Strings. Since 1.2 See Also `java.util.Comparator`

public int compare(Object o1, Object o2)

Implements java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

This implementation merely returns compare((String)o1, (String)o2) .

Parameters

o1:Object

Doc from java.util.Comparator.compare.

the first object to be compared.

o2:Object

Doc from java.util.Comparator.compare.

the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

Annotations

@Override

Exceptions

ClassCastException:: the arguments cannot be cast to Strings.

Since

1.2

See Also

java.util.Comparator

equals back to summary

equals	back to summary
public boolean equals(String source, String target) Convenience method for comparing the equality of two strings based on this Collator's collation rules. Parameters source:String the source string to be compared with. target:String the target string to be compared with. Returns:boolean true if the strings are equal according to the collation rules. false, otherwise. See Also `java.text.Collator#compare`

public boolean equals(String source, String target)

Convenience method for comparing the equality of two strings based on this Collator's collation rules.

Parameters

source:String: the source string to be compared with.
target:String: the target string to be compared with.

Returns:boolean

true if the strings are equal according to the collation rules. false, otherwise.

See Also

java.text.Collator#compare

equals	back to summary
public boolean equals(Object that) Overrides java.lang.Object.equals. Implements java.util.Comparator.equals. Compares the equality of two Collators. Parameters that:Object the Collator to be compared with this. Returns:boolean true if this Collator is the same as that Collator; false otherwise. Annotations @Override

equals

back to summary

public boolean equals(Object that)

Overrides java.lang.Object.equals.

Implements java.util.Comparator.equals.

Compares the equality of two Collators.

Parameters

that:Object: the Collator to be compared with this.

Returns:boolean

true if this Collator is the same as that Collator; false otherwise.

Annotations

@Override

getAvailableLocales back to summary

getAvailableLocales	back to summary
public static synchronized Locale[] getAvailableLocales() Returns an array of all locales for which the `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 `CollatorProvider` implementations. At a minimum, the returned array must contain a `Locale` instance equal to `Locale.ROOT` and a `Locale` instance equal to `Locale.US`. Returns:Locale[] An array of locales for which localized `Collator` instances are available.

public static synchronized Locale[] getAvailableLocales()

Returns an array of all locales for which the 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 CollatorProvider implementations. At a minimum, the returned array must contain a Locale instance equal to Locale.ROOT and a Locale instance equal to Locale.US.

Returns:Locale[]: An array of locales for which localized Collator instances are available.

getCollationKey back to summary

getCollationKey	back to summary
public abstract CollationKey getCollationKey(String source) Transforms the String into a series of bits that can be compared bitwise to other CollationKeys. CollationKeys provide better performance than Collator.compare when Strings are involved in multiple comparisons. See the Collator class description for an example using CollationKeys. Parameters source:String the string to be transformed into a collation key. Returns:CollationKey the CollationKey for the given String based on this Collator's collation rules. If the source String is null, a null CollationKey is returned. See Also `java.text.CollationKey`, `java.text.Collator#compare`

public abstract CollationKey getCollationKey(String source)

Transforms the String into a series of bits that can be compared bitwise to other CollationKeys. CollationKeys provide better performance than Collator.compare when Strings are involved in multiple comparisons. See the Collator class description for an example using CollationKeys.

Parameters

source:String: the string to be transformed into a collation key.

Returns:CollationKey

the CollationKey for the given String based on this Collator's collation rules. If the source String is null, a null CollationKey is returned.

getDecomposition back to summary

getDecomposition	back to summary
public synchronized int getDecomposition() Get the decomposition mode of this Collator. Decomposition mode determines how Unicode composed characters are handled. Adjusting decomposition mode allows the user to select between faster and more complete collation behavior. The three values for decomposition mode are: NO_DECOMPOSITION, CANONICAL_DECOMPOSITION FULL_DECOMPOSITION. See the documentation for these three constants for a description of their meaning. Returns:int the decomposition mode See Also `java.text.Collator#setDecomposition`, `java.text.Collator#NO_DECOMPOSITION`, `java.text.Collator#CANONICAL_DECOMPOSITION`, `java.text.Collator#FULL_DECOMPOSITION`

public synchronized int getDecomposition()

Get the decomposition mode of this Collator. Decomposition mode determines how Unicode composed characters are handled. Adjusting decomposition mode allows the user to select between faster and more complete collation behavior.

The three values for decomposition mode are:

NO_DECOMPOSITION,
CANONICAL_DECOMPOSITION
FULL_DECOMPOSITION.

See the documentation for these three constants for a description of their meaning.

Returns:int: the decomposition mode
See Also: java.text.Collator#setDecomposition, java.text.Collator#NO_DECOMPOSITION, java.text.Collator#CANONICAL_DECOMPOSITION, java.text.Collator#FULL_DECOMPOSITION

getInstance back to summary

getInstance	back to summary
public static synchronized Collator getInstance() Gets the Collator for the current default locale. The default locale is determined by `Locale#getDefault()`. Returns:Collator the Collator for the default locale.(for example, en_US) See Also `java.util.Locale#getDefault`

public static synchronized Collator getInstance()

Gets the Collator for the current default locale. The default locale is determined by Locale#getDefault().

Returns:Collator: the Collator for the default locale.(for example, en_US)
See Also: java.util.Locale#getDefault

getInstance back to summary

public static Collator getInstance(Locale desiredLocale)

Gets the Collator for the desired locale. If the desired locale has the "ks" and/or the "kk" Unicode collation settings, this method will call setStrength(int) and/or setDecomposition(int) on the created instance, if the specified Unicode collation settings are recognized based on the following mappings:

Strength/Decomposition mappings
BCP 47 values for strength (ks)	Collator constants for strength
level1	PRIMARY
level2	SECONDARY
level3	TERTIARY^*
identic	IDENTICAL
BCP 47 values for normalization (kk)	Collator constants for decomposition
true	CANONICAL_DECOMPOSITION
false	NO_DECOMPOSITION^*

Asterisk (^*) denotes the default value. If the specified setting value is not recognized, the strength and/or decomposition is not overridden, as if there were no BCP 47 collation options in the desired locale.

API Note

Implementations of Collator class may produce different instances based on the "co" Unicode collation identifier in the desiredLocale. For example:

Collator.getInstance(Locale.forLanguageTag("sv-u-co-trad"));

may return a Collator instance with the Swedish traditional sorting, which gives 'v' and 'w' the same sorting order, while the Collator instance for the Swedish locale without "co" identifier distinguishes 'v' and 'w'.

Parameters

desiredLocale:Locale: the desired locale.

Returns:Collator

the Collator for the desired locale.

External Specification

https://www.unicode.org/reports/tr35

getStrength back to summary

getStrength	back to summary
public synchronized int getStrength() Returns this Collator's strength property. The strength property determines the minimum level of difference considered significant during comparison. See the Collator class description for an example of use. Returns:int this Collator's current strength property. See Also `java.text.Collator#setStrength`, `java.text.Collator#PRIMARY`, `java.text.Collator#SECONDARY`, `java.text.Collator#TERTIARY`, `java.text.Collator#IDENTICAL`

public synchronized int getStrength()

Returns this Collator's strength property. The strength property determines the minimum level of difference considered significant during comparison. See the Collator class description for an example of use.

Returns:int: this Collator's current strength property.
See Also: java.text.Collator#setStrength, java.text.Collator#PRIMARY, java.text.Collator#SECONDARY, java.text.Collator#TERTIARY, java.text.Collator#IDENTICAL

hashCode	back to summary
public abstract int hashCode() Overrides java.lang.Object.hashCode. Generates the hash code for this Collator. Returns:int Doc from java.lang.Object.hashCode. a hash code value for this object Annotations @Override

hashCode

back to summary

public abstract int hashCode()

Overrides java.lang.Object.hashCode.

Generates the hash code for this Collator.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object

Annotations

@Override

setDecomposition back to summary

setDecomposition	back to summary
public synchronized void setDecomposition(int decompositionMode) Set the decomposition mode of this Collator. See getDecomposition for a description of decomposition mode. Parameters decompositionMode:int the new decomposition mode. Exceptions IllegalArgumentException: If the given value is not a valid decomposition mode. See Also `java.text.Collator#getDecomposition`, `java.text.Collator#NO_DECOMPOSITION`, `java.text.Collator#CANONICAL_DECOMPOSITION`, `java.text.Collator#FULL_DECOMPOSITION`

public synchronized void setDecomposition(int decompositionMode)

Set the decomposition mode of this Collator. See getDecomposition for a description of decomposition mode.

Parameters

decompositionMode:int: the new decomposition mode.

Exceptions

IllegalArgumentException:: If the given value is not a valid decomposition mode.

setStrength back to summary

setStrength	back to summary
public synchronized void setStrength(int newStrength) Sets this Collator's strength property. The strength property determines the minimum level of difference considered significant during comparison. See the Collator class description for an example of use. Parameters newStrength:int the new strength value. Exceptions IllegalArgumentException: If the new strength value is not one of PRIMARY, SECONDARY, TERTIARY or IDENTICAL. See Also `java.text.Collator#getStrength`, `java.text.Collator#PRIMARY`, `java.text.Collator#SECONDARY`, `java.text.Collator#TERTIARY`, `java.text.Collator#IDENTICAL`

public synchronized void setStrength(int newStrength)

Sets this Collator's strength property. The strength property determines the minimum level of difference considered significant during comparison. See the Collator class description for an example of use.

Parameters

newStrength:int: the new strength value.

Exceptions

IllegalArgumentException:: If the new strength value is not one of PRIMARY, SECONDARY, TERTIARY or IDENTICAL.

public abstract Class Collator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail