PluralRules

KEYWORD_FEW

String KEYWORD_FEW

Common name for the 'paucal' or other special plural form.

Constant Value: "few"

KEYWORD_MANY

String KEYWORD_MANY

Common name for the arabic (11 to 99) plural form.

Constant Value: "many"

KEYWORD_ONE

String KEYWORD_ONE

Common name for the 'singular' plural form.

Constant Value: "one"

KEYWORD_OTHER

String KEYWORD_OTHER

Common name for the default plural form. This name is returned for values to which no other form in the rule applies. It can additionally be assigned rules of its own.

Constant Value: "other"

KEYWORD_TWO

String KEYWORD_TWO

Common name for the 'dual' plural form.

Constant Value: "two"

KEYWORD_ZERO

String KEYWORD_ZERO

Common name for the 'zero' plural form.

Constant Value: "zero"

NO_UNIQUE_VALUE

double NO_UNIQUE_VALUE

Value returned by getUniqueKeywordValue(String) when there is no unique value to return.

Constant Value: -0.00123456777

DEFAULT

PluralRules DEFAULT

The default rules that accept any number and return KEYWORD_OTHER.

createRules

PluralRules createRules (String description)

Creates a PluralRules from a description if it is parsable, otherwise returns null.

equals

boolean equals (PluralRules rhs)

Returns true if rhs is equal to this.

equals

boolean equals (Object rhs)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

forLocale

PluralRules forLocale (ULocale locale, 
                PluralRules.PluralType type)

Provides access to the predefined PluralRules for a given locale and the plural type.

ICU defines plural rules for many locales based on CLDR Language Plural Rules. For these predefined rules, see CLDR page at http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html

forLocale

PluralRules forLocale (Locale locale, 
                PluralRules.PluralType type)

Provides access to the predefined PluralRules for a given Locale and the plural type.

ICU defines plural rules for many locales based on CLDR Language Plural Rules. For these predefined rules, see CLDR page at http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html

forLocale

PluralRules forLocale (ULocale locale)

Provides access to the predefined cardinal-number PluralRules for a given locale. Same as forLocale(locale, PluralType.CARDINAL).

ICU defines plural rules for many locales based on CLDR Language Plural Rules. For these predefined rules, see CLDR page at http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html

forLocale

PluralRules forLocale (Locale locale)

Provides access to the predefined cardinal-number PluralRules for a given Locale. Same as forLocale(locale, PluralType.CARDINAL).

ICU defines plural rules for many locales based on CLDR Language Plural Rules. For these predefined rules, see CLDR page at http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html

getAllKeywordValues

Collection<Double> getAllKeywordValues (String keyword)

Returns all the values that trigger this keyword, or null if the number of such values is unlimited.

getKeywords

Set<String> getKeywords ()

Returns a set of all rule keywords used in this PluralRules object. The rule "other" is always present by default.

getSamples

Collection<Double> getSamples (String keyword)

Returns a list of integer values for which select() would return that keyword, or null if the keyword is not defined. The returned collection is unmodifiable. The returned list is not complete, and there might be additional values that would return the keyword.

getUniqueKeywordValue

double getUniqueKeywordValue (String keyword)

Returns the unique value that this keyword matches, or NO_UNIQUE_VALUE if the keyword matches multiple values or is not defined for this PluralRules.

parseDescription

PluralRules parseDescription (String description)

Parses a plural rules description and returns a PluralRules.

select

String select (double number)

Given a number, returns the keyword of the first rule that applies to the number.

toString

String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())