com.ibm.icu.util

Class LocaleData


public final class LocaleData
extends Object

A class for accessing miscelleneous data in the locale bundles
Author:
ram

Nested Class Summary

static class
LocaleData.MeasurementSystem
Enumeration for representing the measurement systems.
static class
LocaleData.PaperSize
A class that represents the size of letter head used in the country

Field Summary

static int
ALT_QUOTATION_END
Delimiter type for getDelimiter(int).
static int
ALT_QUOTATION_START
Delimiter type for getDelimiter(int).
static int
DELIMITER_COUNT
Count of delimiter types for getDelimiter(int).
static int
ES_AUXILIARY
EXType for getExemplarSet(int,int).
static int
ES_COUNT
Count of EXTypes for getExemplarSet(int,int).
static int
ES_STANDARD
EXType for getExemplarSet(int,int).
static int
QUOTATION_END
Delimiter type for getDelimiter(int).
static int
QUOTATION_START
Delimiter type for getDelimiter(int).

Method Summary

String
getDelimiter(int type)
Retrieves a delimiter string from the locale data.
static UnicodeSet
getExemplarSet(ULocale locale, int options)
Returns the set of exemplar characters for a locale.
UnicodeSet
getExemplarSet(int options, int extype)
Returns the set of exemplar characters for a locale.
static LocaleData
getInstance()
Gets the LocaleData object associated with the default locale
static LocaleData
getInstance(ULocale locale)
Gets the LocaleData object associated with the ULocale specified in locale
static LocaleData.MeasurementSystem
getMeasurementSystem(ULocale locale)
Returns the measurement system used in the locale specified by the locale.
boolean
getNoSubstitute()
Gets the "no substitute" behavior of this locale data object.
static LocaleData.PaperSize
getPaperSize(ULocale locale)
Returns the size of paper used in the locale.
void
setNoSubstitute(boolean setting)
Sets the "no substitute" behavior of this locale data object.

Field Details

ALT_QUOTATION_END

public static final int ALT_QUOTATION_END
Field Value:
3

ALT_QUOTATION_START

public static final int ALT_QUOTATION_START
Field Value:
2

DELIMITER_COUNT

public static final int DELIMITER_COUNT
Field Value:
4

ES_AUXILIARY

public static final int ES_AUXILIARY
Field Value:
1

ES_COUNT

public static final int ES_COUNT
Field Value:
2

ES_STANDARD

public static final int ES_STANDARD
Field Value:
0

QUOTATION_END

public static final int QUOTATION_END
Field Value:
1

QUOTATION_START

public static final int QUOTATION_START
Field Value:
0

Method Details

getDelimiter

public String getDelimiter(int type)
Retrieves a delimiter string from the locale data.
Parameters:
type - The type of delimiter string desired. Currently, the valid choices are QUOTATION_START, QUOTATION_END, ALT_QUOTATION_START, or ALT_QUOTATION_END.
Returns:
The desired delimiter string.

getExemplarSet

public static UnicodeSet getExemplarSet(ULocale locale,
                                        int options)
Returns the set of exemplar characters for a locale.
Parameters:
locale - Locale for which the exemplar character set is to be retrieved.
options - Bitmask for options to apply to the exemplar pattern. Specify zero to retrieve the exemplar set as it is defined in the locale data. Specify UnicodeSet.CASE to retrieve a case-folded exemplar set. See UnicodeSet.applyPattern(String,int) for a complete list of valid options. The IGNORE_SPACE bit is always set, regardless of the value of 'options'.
Returns:
The set of exemplar characters for the given locale.

getExemplarSet

public UnicodeSet getExemplarSet(int options,
                                 int extype)
Returns the set of exemplar characters for a locale.
Parameters:
options - Bitmask for options to apply to the exemplar pattern. Specify zero to retrieve the exemplar set as it is defined in the locale data. Specify UnicodeSet.CASE to retrieve a case-folded exemplar set. See UnicodeSet.applyPattern(String,int) for a complete list of valid options. The IGNORE_SPACE bit is always set, regardless of the value of 'options'.
extype - The type of exemplar set to be retrieved, ES_STANDARD or ES_AUXILIARY
Returns:
The set of exemplar characters for the given locale.

getInstance

public static final LocaleData getInstance()
Gets the LocaleData object associated with the default locale
Returns:
A locale data object.

getInstance

public static final LocaleData getInstance(ULocale locale)
Gets the LocaleData object associated with the ULocale specified in locale
Parameters:
locale - Locale with thich the locale data object is associated.
Returns:
A locale data object.

getMeasurementSystem

public static final LocaleData.MeasurementSystem getMeasurementSystem(ULocale locale)
Returns the measurement system used in the locale specified by the locale.
Parameters:
locale - The locale for which the measurement system to be retrieved.
Returns:
MeasurementSystem the measurement system used in the locale.

getNoSubstitute

public boolean getNoSubstitute()
Gets the "no substitute" behavior of this locale data object.
Returns:
Value for the no substitute behavior. If TRUE, methods of this locale data object will return an error when no data is available for that method, given the locale ID supplied to the constructor.

getPaperSize

public static final LocaleData.PaperSize getPaperSize(ULocale locale)
Returns the size of paper used in the locale. The paper sizes returned are always in milli-meters.
Parameters:
locale - The locale for which the measurement system to be retrieved.
Returns:
The paper size used in the locale

setNoSubstitute

public void setNoSubstitute(boolean setting)
Sets the "no substitute" behavior of this locale data object.
Parameters:
setting - Value for the no substitute behavior. If TRUE, methods of this locale data object will return an error when no data is available for that method, given the locale ID supplied to the constructor.

Copyright (c) 2006 IBM Corporation and others.