GlobalizationPreferences (icu4j)

Overview

Package

Class

Use

Tree

Serialized

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.icu.util
Class GlobalizationPreferences

java.lang.Object
  com.ibm.icu.util.GlobalizationPreferences

All Implemented Interfaces:: Freezable<GlobalizationPreferences>, Cloneable

public class GlobalizationPreferences
extends Object
implements Freezable<GlobalizationPreferences>
extends Object
implements Freezable<GlobalizationPreferences>

This convenience class provides a mechanism for bundling together different globalization preferences. It includes:

A list of locales/languages in preference order
A territory
A currency
A timezone
A calendar
A collator (for language-sensitive sorting, searching, and matching).
Explicit overrides for date/time formats, etc.

The class will heuristically compute implicit, heuristic values for the above based on available data if explicit values are not supplied. These implicit values can be presented to users for confirmation, or replacement if the values are incorrect.

To reset any explicit field so that it will get heuristic values, pass in null. For example, myPreferences.setLocale(null);

All of the heuristics can be customized by subclasses, by overriding getTerritory(), guessCollator(), etc.

The class also supplies display names for languages, scripts, territories, currencies, timezones, etc. These are computed according to the locale/language preference list. Thus, if the preference is Breton; French; English, then the display name for a language will be returned in Breton if available, otherwise in French if available, otherwise in English.

The codes used to reference territory, currency, etc. are as defined elsewhere in ICU, and are taken from CLDR (which reflects RFC 3066bis usage, ISO 4217, and the TZ Timezone database identifiers).

This is at a prototype stage, and has not incorporated all the design changes that we would like yet; further feedback is welcome.

Note:

to get the display name for the first day of the week, use the calendar + display names.
to get the work days, ask the calendar (when that is available).
to get papersize / measurement system/bidi-orientation, ask the locale (when that is available there)
to get the field order in a date, and whether a time is 24hour or not, ask the DateFormat (when that is available there)
it will support HOST locale when it becomes available (it is a special locale that will ask the services to use the host platform's values).

Status:: Draft ICU 3.6 (retainAll).

Field Summary
`static int`	`BI_CHARACTER` Break iterator type
`static int`	`BI_LINE` Break iterator type
`static int`	`BI_SENTENCE` Break iterator type
`static int`	`BI_TITLE` Break iterator type
`static int`	`BI_WORD` Break iterator type
`static int`	`DF_FULL` Date Format type
`static int`	`DF_LONG` Date Format type
`static int`	`DF_MEDIUM` Date Format type
`static int`	`DF_NONE` Date Format type
`static int`	`DF_SHORT` Date Format type
`static int`	`ID_CURRENCY` For selecting a choice of display names
`static int`	`ID_CURRENCY_SYMBOL` For selecting a choice of display names
`static int`	`ID_KEYWORD` For selecting a choice of display names
`static int`	`ID_KEYWORD_VALUE` For selecting a choice of display names
`static int`	`ID_LANGUAGE` For selecting a choice of display names
`static int`	`ID_LOCALE` For selecting a choice of display names
`static int`	`ID_SCRIPT` For selecting a choice of display names
`static int`	`ID_TERRITORY` For selecting a choice of display names
`static int`	`ID_TIMEZONE` For selecting a choice of display names
`static int`	`ID_VARIANT` For selecting a choice of display names
`static int`	`NF_CURRENCY` Number Format type
`static int`	`NF_INTEGER` Number Format type
`static int`	`NF_NUMBER` Number Format type
`static int`	`NF_PERCENT` Number Format type
`static int`	`NF_SCIENTIFIC` Number Format type

Constructor Summary
`GlobalizationPreferences()` Default constructor

Method Summary
`GlobalizationPreferences`	`cloneAsThawed()` Provides for the clone operation.
`GlobalizationPreferences`	`freeze()` Locks the object.
`BreakIterator`	`getBreakIterator(int type)` Get a copy of the break iterator for the specified type according to the settings.
`Calendar`	`getCalendar()` Get a copy of the calendar according to the settings.
`Collator`	`getCollator()` Get a copy of the collator according to the settings.
`Currency`	`getCurrency()` Get a copy of the currency computed according to the settings.
`DateFormat`	`getDateFormat(int dateStyle, int timeStyle)` Gets a date format according to the current settings.
`String`	`getDisplayName(String id, int type)` Get the display name for an ID: language, script, territory, currency, timezone...
`ULocale`	`getLocale(int index)` Convenience function for getting the locales in priority order
`List<ULocale>`	`getLocales()` Get a copy of the language/locale priority list
`NumberFormat`	`getNumberFormat(int style)` Gets a number format according to the current settings.
`ResourceBundle`	`getResourceBundle(String baseName)` Convenience function to get a ResourceBundle instance using the specified base name based on the language/locale priority list stored in this object.
`ResourceBundle`	`getResourceBundle(String baseName, ClassLoader loader)` Convenience function to get a ResourceBundle instance using the specified base name and class loader based on the language/locale priority list stored in this object.
`String`	`getTerritory()` Gets the territory setting.
`TimeZone`	`getTimeZone()` Get the timezone.
`protected BreakIterator`	`guessBreakIterator(int type)` This function can be overridden by subclasses to use different heuristics.
`protected Calendar`	`guessCalendar()` This function can be overridden by subclasses to use different heuristics.
`protected Collator`	`guessCollator()` This function can be overridden by subclasses to use different heuristics.
`protected Currency`	`guessCurrency()` This function can be overridden by subclasses to use different heuristics
`protected DateFormat`	`guessDateFormat(int dateStyle, int timeStyle)` This function can be overridden by subclasses to use different heuristics.
`protected List<ULocale>`	`guessLocales()` This function can be overridden by subclasses to use different heuristics It MUST return a 'safe' value, one whose modification will not affect this object.
`protected NumberFormat`	`guessNumberFormat(int style)` This function can be overridden by subclasses to use different heuristics.
`protected String`	`guessTerritory()` This function can be overridden by subclasses to use different heuristics.
`protected TimeZone`	`guessTimeZone()` This function can be overridden by subclasses to use different heuristics.
`boolean`	`isFrozen()` Determines whether the object has been locked or not.
`protected List<ULocale>`	`processLocales(List<ULocale> inputLocales)` Process a language/locale priority list specified via `setLocales`.
`GlobalizationPreferences`	`reset()` Restore the object to the initial state.
`GlobalizationPreferences`	`setBreakIterator(int type, BreakIterator iterator)` Explicitly set the break iterator for this object.
`GlobalizationPreferences`	`setCalendar(Calendar calendar)` Sets the calendar.
`GlobalizationPreferences`	`setCollator(Collator collator)` Explicitly set the collator for this object.
`GlobalizationPreferences`	`setCurrency(Currency currency)` Sets the currency code.
`GlobalizationPreferences`	`setDateFormat(int dateStyle, int timeStyle, DateFormat format)` Set an explicit date format.
`GlobalizationPreferences`	`setLocale(ULocale uLocale)` Convenience routine for setting the language/locale priority list from a single locale/language.
`GlobalizationPreferences`	`setLocales(List<ULocale> inputLocales)` Sets the language/locale priority list.
`GlobalizationPreferences`	`setLocales(String acceptLanguageString)` Convenience routine for setting the locale priority list from an Accept-Language string.
`GlobalizationPreferences`	`setLocales(ULocale[] uLocales)` Convenience routine for setting the language/locale priority list from an array.
`GlobalizationPreferences`	`setNumberFormat(int style, NumberFormat format)` Sets a number format explicitly.
`GlobalizationPreferences`	`setTerritory(String territory)` Sets the territory, which is a valid territory according to for RFC 3066 (or successor).
`GlobalizationPreferences`	`setTimeZone(TimeZone timezone)` Sets the timezone ID.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

NF_NUMBER

public static final int NF_NUMBER

Number Format type

See Also:: Constant Field Values
Status:: Draft ICU 3.6.

NF_CURRENCY

public static final int NF_CURRENCY

Number Format type

See Also:: Constant Field Values
Status:: Draft ICU 3.6.

NF_PERCENT

public static final int NF_PERCENT

Number Format type

See Also:: Constant Field Values
Status:: Draft ICU 3.6.

NF_SCIENTIFIC

public static final int NF_SCIENTIFIC

Number Format type

See Also:: Constant Field Values
Status:: Draft ICU 3.6.

NF_INTEGER

public static final int NF_INTEGER

Number Format type

See Also:: Constant Field Values
Status:: Draft ICU 3.6.

DF_FULL

public static final int DF_FULL

Date Format type

See Also:: Constant Field Values
Status:: Draft ICU 3.6.

DF_LONG

public static final int DF_LONG

Date Format type

See Also:: Constant Field Values
Status:: Draft ICU 3.6.

DF_MEDIUM

public static final int DF_MEDIUM

Date Format type

See Also:: Constant Field Values
Status:: Draft ICU 3.6.

DF_SHORT

public static final int DF_SHORT

Date Format type

See Also:: Constant Field Values
Status:: Draft ICU 3.6.

DF_NONE

public static final int DF_NONE

Date Format type

See Also:: Constant Field Values
Status:: Draft ICU 3.6.