IChronology.OfLocale(Locale) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Obtains an instance of Chronology from a locale.
[Android.Runtime.Register("ofLocale", "(Ljava/util/Locale;)Ljava/time/chrono/Chronology;", "", ApiSince=26)]
public static Java.Time.Chrono.IChronology? OfLocale (Java.Util.Locale? locale);[<Android.Runtime.Register("ofLocale", "(Ljava/util/Locale;)Ljava/time/chrono/Chronology;", "", ApiSince=26)>]
static member OfLocale : Java.Util.Locale -> Java.Time.Chrono.IChronologyParameters
- locale
- Locale
the locale to use to obtain the calendar system, not null
Returns
the calendar system associated with the locale, not null
- Attributes
Remarks
Obtains an instance of Chronology from a locale.
This returns a Chronology based on the specified locale, typically returning IsoChronology. Other calendar systems are only returned if they are explicitly selected within the locale.
The Locale class provide access to a range of information useful for localizing an application. This includes the language and region, such as "en-GB" for English as used in Great Britain.
The Locale class also supports an extension mechanism that can be used to identify a calendar system. The mechanism is a form of key-value pairs, where the calendar system has the key "ca". For example, the locale "en-JP-u-ca-japanese" represents the English language as used in Japan with the Japanese calendar system.
This method finds the desired calendar system in a manner equivalent to passing "ca" to Locale#getUnicodeLocaleType(String). If the "ca" key is not present, then IsoChronology is returned.
Note that the behavior of this method differs from the older java.util.Calendar#getInstance(Locale) method. If that method receives a locale of "th_TH" it will return BuddhistCalendar. By contrast, this method will return IsoChronology. Passing the locale "th-TH-u-ca-buddhist" into either method will result in the Thai Buddhist calendar system and is therefore the recommended approach going forward for Thai calendar system localization.
A similar, but simpler, situation occurs for the Japanese calendar system. The locale "jp_JP_JP" has previously been used to access the calendar. However, unlike the Thai locale, "ja_JP_JP" is automatically converted by Locale to the modern and recommended form of "ja-JP-u-ca-japanese". Thus, there is no difference in behavior between this method and Calendar#getInstance(Locale).
Java documentation for java.time.chrono.Chronology.ofLocale(java.util.Locale).
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.