public abstract class CalendarNameProvider extends LocaleServiceProvider
Calendar
field values.
Calendar types are used to specify calendar systems for which the getDisplayName
and getDisplayNames
methods provide calendar field value names. See Calendar.getCalendarType()
for details.
Calendar Fields
Calendar fields are specified with the constants defined in Calendar
. The following are calendar-common fields and their values to be supported for each calendar system.
Field | Value | Description |
---|---|---|
Calendar.MONTH |
Calendar.JANUARY to Calendar.UNDECIMBER
| Month numbering is 0-based (e.g., 0 - January, ..., 11 - December). Some calendar systems have 13 months. Month names need to be supported in both the formatting and stand-alone forms if required by the supported locales. If there's no distinction in the two forms, the same names should be returned in both of the forms. |
Calendar.DAY_OF_WEEK |
Calendar.SUNDAY to Calendar.SATURDAY
| Day-of-week numbering is 1-based starting from Sunday (i.e., 1 - Sunday, ..., 7 - Saturday). |
Calendar.AM_PM |
Calendar.AM to Calendar.PM
| 0 - AM, 1 - PM |
The following are calendar-specific fields and their values to be supported.
Calendar Type | Field | Value | Description |
---|---|---|---|
"gregory" | Calendar.ERA | 0 |
GregorianCalendar.BC (BCE) |
1 |
GregorianCalendar.AD (CE) | ||
"buddhist" | Calendar.ERA | 0 | BC (BCE) |
1 | B.E. (Buddhist Era) | ||
"japanese" | Calendar.ERA | 0 | Seireki (Before Meiji) |
1 | Meiji | ||
2 | Taisho | ||
3 | Showa | ||
4 | Heisei | ||
5 | Reiwa | ||
Calendar.YEAR | 1 | the first year in each era. It should be returned when a long style (Calendar.LONG_FORMAT or Calendar.LONG_STANDALONE ) is specified. See also the Year representation in SimpleDateFormat . | |
"roc" | Calendar.ERA | 0 | Before R.O.C. |
1 | R.O.C. | ||
"islamic" | Calendar.ERA | 0 | Before AH |
1 | Anno Hijrah (AH) |
Calendar field value names for "gregory"
must be consistent with the date-time symbols provided by DateFormatSymbolsProvider
.
Time zone names are supported by TimeZoneNameProvider
.
Modifier | Constructor | Description |
---|---|---|
protected |
Sole constructor. |
Modifier and Type | Method | Description |
---|---|---|
abstract String |
getDisplayName |
Returns the string representation (display name) of the calendar field value in the given style and locale . |
abstract Map |
getDisplayNames |
Returns a Map containing all string representations (display names) of the Calendar field in the given style and locale and their corresponding field values. |
getAvailableLocales, isSupportedLocale
protected CalendarNameProvider()
public abstract String getDisplayName(String calendarType, int field, int value, int style, Locale locale)
field value
in the given style
and locale
. If no string representation is applicable, null
is returned. field
is a Calendar
field index, such as Calendar.MONTH
. The time zone fields, Calendar.ZONE_OFFSET
and Calendar.DST_OFFSET
, are not supported by this method. null
must be returned if any time zone fields are specified.
value
is the numeric representation of the field
value. For example, if field
is Calendar.DAY_OF_WEEK
, the valid values are Calendar.SUNDAY
to Calendar.SATURDAY
(inclusive).
style
gives the style of the string representation. It is one of Calendar.SHORT_FORMAT
(SHORT
), Calendar.SHORT_STANDALONE
, Calendar.LONG_FORMAT
(LONG
), Calendar.LONG_STANDALONE
, Calendar.NARROW_FORMAT
, or Calendar.NARROW_STANDALONE
.
For example, the following call will return "Sunday"
.
getDisplayName("gregory", Calendar.DAY_OF_WEEK, Calendar.SUNDAY, Calendar.LONG_STANDALONE, Locale.ENGLISH);
calendarType
- the calendar type. (Any calendar type given by locale
is ignored.)field
- the Calendar
field index, such as Calendar.DAY_OF_WEEK
value
- the value of the Calendar field
, such as Calendar.MONDAY
style
- the string representation style: one of Calendar.SHORT_FORMAT
(SHORT
), Calendar.SHORT_STANDALONE
, Calendar.LONG_FORMAT
(LONG
), Calendar.LONG_STANDALONE
, Calendar.NARROW_FORMAT
, or Calendar.NARROW_STANDALONE
locale
- the desired localefield value
, or
null
if the string representation is not applicable or the given calendar type is unknownIllegalArgumentException
- if field
or style
is invalidNullPointerException
- if locale
is null
public abstract Map<String,Integer> getDisplayNames(String calendarType, int field, int style, Locale locale)
Map
containing all string representations (display names) of the Calendar
field
in the given style
and locale
and their corresponding field values. field
is a Calendar
field index, such as Calendar.MONTH
. The time zone fields, Calendar.ZONE_OFFSET
and Calendar.DST_OFFSET
, are not supported by this method. null
must be returned if any time zone fields are specified.
style
gives the style of the string representation. It must be one of Calendar.ALL_STYLES
, Calendar.SHORT_FORMAT
(SHORT
), Calendar.SHORT_STANDALONE
, Calendar.LONG_FORMAT
(LONG
), Calendar.LONG_STANDALONE
, Calendar.NARROW_FORMAT
, or Calendar.NARROW_STANDALONE
. Note that narrow names may not be unique due to use of single characters, such as "S" for Sunday and Saturday, and that no narrow names are included in that case.
For example, the following call will return a Map
containing "January"
to Calendar.JANUARY
, "Jan"
to Calendar.JANUARY
, "February"
to Calendar.FEBRUARY
, "Feb"
to Calendar.FEBRUARY
, and so on.
getDisplayNames("gregory", Calendar.MONTH, Calendar.ALL_STYLES, Locale.ENGLISH);
calendarType
- the calendar type. (Any calendar type given by locale
is ignored.)field
- the calendar field for which the display names are returnedstyle
- the style applied to the display names; one of Calendar.ALL_STYLES
, Calendar.SHORT_FORMAT
(SHORT
), Calendar.SHORT_STANDALONE
, Calendar.LONG_FORMAT
(LONG
), Calendar.LONG_STANDALONE
, Calendar.NARROW_FORMAT
, or Calendar.NARROW_STANDALONE
locale
- the desired localeMap
containing all display names of field
in style
and locale
and their field
values, or null
if no display names are defined for field
NullPointerException
- if locale
is null
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/spi/CalendarNameProvider.html