/// <summary>
/// Gets the <see cref="LocaleData"/> object associated with the default <see cref="Category.FORMAT"/> locale.
/// </summary>
/// <returns>A locale data object.</returns>
/// <see cref="Category.FORMAT"/>
/// <stable>ICU 3.4</stable>
public static LocaleData GetInstance()
{
return(LocaleData.GetInstance(ULocale.GetDefault(Category.FORMAT)));
}
/// <summary>
/// Returns the set of exemplar characters for a <paramref name="locale"/>.
/// Equivalent to calling <c>new LocaleData(locale)</c>. <see cref="GetExemplarSet(PatternOptions, ExemplarSetType)"/>.
/// </summary>
/// <param name="locale">Locale for which the exemplar character set
/// is to be retrieved.</param>
/// <param name="options">
/// <see cref="PatternOptions"/> flags to apply to the exemplar pattern.
/// Specify <see cref="PatternOptions.Default"/> to retrieve the exemplar set as it is
/// defined in the locale data. Specify <see cref="PatternOptions.Case"/> to retrieve a case-folded exemplar
/// set. See <see cref="PatternOptions"/> for a complete list of valid options. The
/// <see cref="PatternOptions.IgnoreSpace"/> bit is always set, regardless of the
/// value of <paramref name="options"/>.
/// </param>
/// <param name="extype">The type of exemplar set to be retrieved,
/// <see cref="ExemplarSetType.Standard"/>, <see cref="ExemplarSetType.Index"/>,
/// <see cref="ExemplarSetType.Auxiliary"/>, or <see cref="ExemplarSetType.Punctuation"/>.</param>
/// <returns>The set of exemplar characters for the given <paramref name="locale"/>.</returns>
/// <stable>ICU 3.0</stable>
public static UnicodeSet GetExemplarSet(ULocale locale, PatternOptions options, ExemplarSetType extype)
{
return(LocaleData.GetInstance(locale).GetExemplarSet(options, extype));
}
/// <summary>
/// Gets the <see cref="LocaleData"/> object associated with the <see cref="UCultureInfo.CurrentCulture"/> locale.
/// </summary>
/// <returns>A locale data object.</returns>
/// <see cref="UCultureInfo.CurrentCulture"/>
/// <stable>ICU 3.4</stable>
public static LocaleData GetInstance()
{
return(LocaleData.GetInstance(UCultureInfo.CurrentCulture));
}
////CLOVER:ON
/// <summary>
/// Returns the set of exemplar characters for a locale. Equivalent to calling
/// <see cref="GetExemplarSet(UCultureInfo, PatternOptions, ExemplarSetType)"/> with the
/// extype == <see cref="ExemplarSetType.Standard"/>.
/// </summary>
/// <param name="locale">Locale for which the exemplar character set
/// is to be retrieved.</param>
/// <param name="options">
/// <see cref="PatternOptions"/> flags to apply to the exemplar pattern.
/// Specify <see cref="PatternOptions.Default"/> to retrieve the exemplar set as it is
/// defined in the locale data. Specify <see cref="PatternOptions.Case"/> to retrieve a case-folded exemplar
/// set. See <see cref="PatternOptions"/> for a complete list of valid options. The
/// <see cref="PatternOptions.IgnoreSpace"/> bit is always set, regardless of the
/// value of <paramref name="options"/>.
/// </param>
/// <returns>The set of exemplar characters for the given locale.</returns>
/// <stable>ICU 3.0</stable>
public static UnicodeSet GetExemplarSet(UCultureInfo locale, PatternOptions options)
{
return(LocaleData.GetInstance(locale).GetExemplarSet(options, ExemplarSetType.Standard));
}
/**
* Returns the set of exemplar characters for a locale.
* Equivalent to calling new LocaleData(locale).{@link #getExemplarSet(int, int)}.
*
* @param locale Locale for which the exemplar character set
* is to be retrieved.
* @param 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 {@link UnicodeSet#applyPattern(String,
* int)} for a complete list of valid options. The
* IGNORE_SPACE bit is always set, regardless of the
* value of 'options'.
* @param extype The type of exemplar character set to retrieve.
* @return The set of exemplar characters for the given locale.
* @stable ICU 3.0
*/
public static UnicodeSet GetExemplarSet(ULocale locale, int options, int extype)
{
return(LocaleData.GetInstance(locale).GetExemplarSet(options, extype));
}
///CLOVER:ON
/**
* Returns the set of exemplar characters for a locale. Equivalent to calling {@link #getExemplarSet(ULocale, int, int)} with
* the extype == {@link #ES_STANDARD}.
*
* @param locale Locale for which the exemplar character set
* is to be retrieved.
* @param 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 {@link UnicodeSet#applyPattern(String,
* int)} for a complete list of valid options. The
* IGNORE_SPACE bit is always set, regardless of the
* value of 'options'.
* @return The set of exemplar characters for the given locale.
* @stable ICU 3.0
*/
public static UnicodeSet GetExemplarSet(ULocale locale, int options)
{
return(LocaleData.GetInstance(locale).GetExemplarSet(options, ES_STANDARD));
}
