Package com.ibm.icu.impl

Class PluralRulesLoader

java.lang.Object

com.ibm.icu.text.PluralRules.Factory

com.ibm.icu.impl.PluralRulesLoader

public class PluralRulesLoader
extends PluralRules.Factory

Loader for plural rules data.

Field Summary

Fields

Modifier and Type	Field	Description
static PluralRulesLoader	loader	The only instance of the loader.

Method Summary

Modifier and Type	Method	Description
PluralRules	forLocale(ULocale locale, PluralRules.PluralType type)	Returns the plural rules for the the locale.
ULocale[]	getAvailableULocales()	Returns the locales for which we have plurals data.
ULocale	getFunctionalEquivalent(ULocale locale, boolean[] isAvailable)	Returns the functionally equivalent locale.
UResourceBundle	getPluralBundle()	Return the plurals resource.
PluralRanges	getPluralRanges(ULocale locale)
PluralRules	getRulesForRulesId(String rulesId)	Gets the rule from the rulesId.
String	getRulesIdForLocale(ULocale locale, PluralRules.PluralType type)	Gets the rulesId from the locale,with locale fallback.
boolean	hasOverride(ULocale locale)	Returns whether or not there are overrides.
boolean	isPluralRangesAvailable(ULocale locale)

Methods inherited from class com.ibm.icu.text.PluralRules.Factory

forLocale, getDefaultFactory

Methods inherited from class java.lang.Object

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

Field Detail

loader

public static final PluralRulesLoader loader

The only instance of the loader.

Method Detail

getAvailableULocales

public ULocale[] getAvailableULocales()

Returns the locales for which we have plurals data. Utility for testing.

Specified by:

getAvailableULocales in class PluralRules.Factory

getFunctionalEquivalent

public ULocale getFunctionalEquivalent(ULocale locale,
                                       boolean[] isAvailable)

Returns the functionally equivalent locale.

Specified by:

getFunctionalEquivalent in class PluralRules.Factory

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

getRulesIdForLocale

public String getRulesIdForLocale(ULocale locale,
                                  PluralRules.PluralType type)

Gets the rulesId from the locale,with locale fallback. If there is no rulesId, return null. The rulesId might be the empty string if the rule is the default rule.

getRulesForRulesId

public PluralRules getRulesForRulesId(String rulesId)

Gets the rule from the rulesId. If there is no rule for this rulesId, return null.

getPluralBundle

public UResourceBundle getPluralBundle()
                                throws MissingResourceException

Return the plurals resource. Note MissingResourceException is unchecked, listed here for clarity. Callers should handle this exception.

Throws:

MissingResourceException

forLocale

public PluralRules forLocale(ULocale locale,
                             PluralRules.PluralType type)

Returns the plural rules for the the locale. If we don't have data, com.ibm.icu.text.PluralRules.DEFAULT is returned.

Specified by:

forLocale in class PluralRules.Factory

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.

hasOverride

public boolean hasOverride(ULocale locale)

Description copied from class: PluralRules.Factory

Returns whether or not there are overrides.

Specified by:

hasOverride in class PluralRules.Factory

getPluralRanges

public PluralRanges getPluralRanges(ULocale locale)

isPluralRangesAvailable

public boolean isPluralRangesAvailable(ULocale locale)