com.ibm.icu.text

Class PluralRules.Factory

java.lang.Object

com.ibm.icu.text.PluralRules.Factory

Enclosing class:

PluralRules

Deprecated.

This API is ICU internal only.

@Deprecated
public abstract static class PluralRules.Factory
extends Object

Provides a factory for returning plural rules

Status:

Internal. This API is ICU internal only.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Factory() Deprecated. This API is ICU internal only.

Method Summary

Modifier and Type	Method and Description
PluralRules	forLocale(ULocale locale) Deprecated. This API is ICU internal only.
abstract PluralRules	forLocale(ULocale locale, PluralRules.PluralType type) Deprecated. This API is ICU internal only.
abstract ULocale[]	getAvailableULocales() Deprecated. This API is ICU internal only.
static com.ibm.icu.impl.PluralRulesLoader	getDefaultFactory() Deprecated. This API is ICU internal only.
abstract ULocale	getFunctionalEquivalent(ULocale locale, boolean[] isAvailable) Deprecated. This API is ICU internal only.
abstract boolean	hasOverride(ULocale locale) Deprecated. This API is ICU internal only.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Factory

@Deprecated
protected Factory()

Deprecated. This API is ICU internal only.

Sole constructor

Status:

Internal. This API is ICU internal only.

Method Detail

forLocale

@Deprecated
public abstract PluralRules forLocale(ULocale locale,
                                                  PluralRules.PluralType type)

Deprecated. This API is ICU internal only.

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 https://unicode-org.github.io/cldr-staging/charts/latest/supplemental/language_plural_rules.html

Parameters:

locale - The locale for which a PluralRules object is returned.

type - The plural type (e.g., cardinal or ordinal).

Returns:

The predefined PluralRules object for this locale. If there's no predefined rules for this locale, the rules for the closest parent in the locale hierarchy that has one will be returned. The final fallback always returns the default rules.

Status:

Internal. This API is ICU internal only.

forLocale

@Deprecated
public final PluralRules forLocale(ULocale locale)

Deprecated. This API is ICU internal only.

Utility for getting CARDINAL rules.

Parameters:

locale - the locale

Returns:

plural rules.

Status:

Internal. This API is ICU internal only.

getAvailableULocales

@Deprecated
public abstract ULocale[] getAvailableULocales()

Deprecated. This API is ICU internal only.

Returns the locales for which there is plurals data.

Status:

Internal. This API is ICU internal only.

getFunctionalEquivalent

@Deprecated
public abstract ULocale getFunctionalEquivalent(ULocale locale,
                                                            boolean[] isAvailable)

Deprecated. This API is ICU internal only.

Returns the 'functionally equivalent' locale with respect to plural rules. Calling PluralRules.forLocale with the functionally equivalent locale, and with the provided locale, returns rules that behave the same.
All locales with the same functionally equivalent locale have plural rules that behave the same. This is not exhaustive; there may be other locales whose plural rules behave the same that do not have the same equivalent locale.

Parameters:

locale - the locale to check

isAvailable - if not null and of length > 0, this will hold 'true' at index 0 if locale is directly defined (without fallback) as having plural rules

Returns:

the functionally-equivalent locale

Status:

Internal. This API is ICU internal only.

getDefaultFactory

@Deprecated
public static com.ibm.icu.impl.PluralRulesLoader getDefaultFactory()

Deprecated. This API is ICU internal only.

Returns the default factory.

Status:

Internal. This API is ICU internal only.

hasOverride

@Deprecated
public abstract boolean hasOverride(ULocale locale)

Deprecated. This API is ICU internal only.

Returns whether or not there are overrides.

Status:

Internal. This API is ICU internal only.