模块 java.base

包 java.util.spi

类 CalendarNameProvider

java.lang.Object

java.util.spi.LocaleServiceProvider

java.util.spi.CalendarNameProvider

public abstract class CalendarNameProvider extends LocaleServiceProvider 
      

服务提供商的抽象类，提供 Calendar 字段值的本地化字符串表示（显示名称）。

日历类型

日历类型用于指定日历系统，getDisplayName 和 getDisplayNames 方法为其提供日历字段值名称。有关详细信息，请参阅 Calendar.getCalendarType() 。

Calendar 字段

日历字段使用 Calendar 中定义的常量指定。以下是每个日历系统支持的日历公共字段及其值。

字段值

Field	Value	Description
Calendar.MONTH	Calendar.JANUARY 到 Calendar.UNDECIMBER	月份编号从 0 开始（例如，0 - 一月，...，11 - 十二月）。一些日历系统有 13 个月。如果受支持的locale需要，格式和独立形式都需要支持月份名称。如果两种形式没有区别，则应在两种形式中返回相同的名称。
Calendar.DAY_OF_WEEK	Calendar.SUNDAY 到 Calendar.SATURDAY	从星期日开始，星期几的编号从 1 开始（即 1 - 星期日，...，7 - 星期六）。
Calendar.AM_PM	Calendar.AM 到 Calendar.PM	0 - AM, 1 - PM

以下是特定于日历的字段及其要支持的值。

日历类型和字段值

日历类型	Field	Value	Description
"gregory"	Calendar.ERA	0	GregorianCalendar.BC （公元前）
		1	GregorianCalendar.AD (CE)
"buddhist"	Calendar.ERA	0	BC (BCE)
		1	BE（佛教时代）
"japanese"	Calendar.ERA	0	Seireki（明治前）
		1	Meiji
		2	大正
		3	昭和
		4	平成
		5	令和
	Calendar.YEAR	1	每个时代的第一年。当指定长样式（Calendar.LONG_FORMAT 或 Calendar.LONG_STANDALONE ）时应返回它。另见 SimpleDateFormat 中的年份表示 。
"roc"	Calendar.ERA	0	中华民国之前
		1	R.O.C.
"islamic"	Calendar.ERA	0	啊之前
		1	安诺回历 (AH)

"gregory" 的日历字段值名称必须与 DateFormatSymbolsProvider 提供的日期时间符号一致。

TimeZoneNameProvider 支持时区名称。

自从：

1.8

参见：

• CalendarDataProvider
• Locale.getUnicodeLocaleType(String)

构造方法总结

构造方法

修饰符	构造方法	描述
protected	CalendarNameProvider()	唯一的构造方法。

方法总结

修饰符和类型	方法	描述
abstract String	getDisplayName(String calendarType, int field, int value, int style, Locale locale)	返回给定 style 和 locale 中日历 field value 的字符串表示形式（显示名称）。
abstract Map<String,Integer>	getDisplayNames(String calendarType, int field, int style, Locale locale)	返回一个 Map，其中包含给定 style 和 locale 中 Calendar field 的所有字符串表示形式（显示名称）及其对应的字段值。

在类 java.util.spi.LocaleServiceProvider 中声明的方法

getAvailableLocales, isSupportedLocale

在类 java.lang.Object 中声明的方法

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造方法详细信息

CalendarNameProvider

protected CalendarNameProvider()
            

唯一的构造方法。 （对于子类构造方法的调用，通常是隐式的。）

方法详情

getDisplayName

public abstract String  getDisplayName(String  calendarType, int field, int value, int style, Locale  locale)
            

返回给定 style 和 locale 中日历 field value 的字符串表示形式（显示名称）。如果没有适用的字符串表示，则返回 null。

field 是一个 Calendar 字段索引，例如 Calendar.MONTH 。此方法支持时区字段 Calendar.ZONE_OFFSET 和 Calendar.DST_OFFSET not。如果指定了任何时区字段，则必须返回 null。

value 是 field 值的数字表示。例如，如果 field 是 Calendar.DAY_OF_WEEK ，则有效值为 Calendar.SUNDAY 到 Calendar.SATURDAY （含）。

style 给出了字符串表示的样式。它是 Calendar.SHORT_FORMAT (SHORT )、Calendar.SHORT_STANDALONE 、Calendar.LONG_FORMAT (LONG )、Calendar.LONG_STANDALONE 、Calendar.NARROW_FORMAT 或 Calendar.NARROW_STANDALONE 之一。

例如，以下调用将返回 "Sunday" 。

 getDisplayName("gregory", Calendar.DAY_OF_WEEK, Calendar.SUNDAY,
        Calendar.LONG_STANDALONE, Locale.ENGLISH);
 

参数：

calendarType - 日历类型。 （忽略 locale 给出的任何日历类型。）

field - Calendar 字段索引，如 Calendar.DAY_OF_WEEK

value - Calendar field 的值，例如 Calendar.MONDAY

style - 字符串表示样式：Calendar.SHORT_FORMAT (SHORT )、Calendar.SHORT_STANDALONE 、Calendar.LONG_FORMAT (LONG )、Calendar.LONG_STANDALONE 、Calendar.NARROW_FORMAT 或 Calendar.NARROW_STANDALONE 之一

locale - 所需的locale

返回：

field value 的字符串表示形式，如果字符串表示形式不适用或给定的日历类型未知，则为 null

抛出：

IllegalArgumentException - 如果 field 或 style 无效

NullPointerException - 如果 locale 是 null

参见：

• TimeZoneNameProvider
• Calendar.get(int)
• Calendar.getDisplayName(int, int, Locale)

getDisplayNames

public abstract Map <String ,Integer > getDisplayNames(String  calendarType, int field, int style, Locale  locale)
            

返回一个 Map，其中包含给定 style 和 locale 中 Calendar field 的所有字符串表示形式（显示名称）及其对应的字段值。

field 是一个 Calendar 字段索引，例如 Calendar.MONTH 。此方法支持时区字段 Calendar.ZONE_OFFSET 和 Calendar.DST_OFFSET not。如果指定了任何时区字段，则必须返回 null。

style 给出了字符串表示的样式。它必须是 Calendar.ALL_STYLES 、Calendar.SHORT_FORMAT (SHORT )、Calendar.SHORT_STANDALONE 、Calendar.LONG_FORMAT (LONG )、Calendar.LONG_STANDALONE 、Calendar.NARROW_FORMAT 或 Calendar.NARROW_STANDALONE 之一。请注意，由于使用单个字符（例如“S”代表星期日和星期六），窄名称可能不是唯一的，并且在这种情况下不包含任何窄名称。

例如，以下调用将返回一个 Map，其中包含 "January" 到 Calendar.JANUARY 、"Jan" 到 Calendar.JANUARY 、"February" 到 Calendar.FEBRUARY 、"Feb" 到 Calendar.FEBRUARY 等等。

 getDisplayNames("gregory", Calendar.MONTH, Calendar.ALL_STYLES, Locale.ENGLISH);
 

参数：

calendarType - 日历类型。 （忽略 locale 给出的任何日历类型。）

field - 返回显示名称的日历字段

style - 应用于显示名称的样式； Calendar.ALL_STYLES 、Calendar.SHORT_FORMAT (SHORT )、Calendar.SHORT_STANDALONE 、Calendar.LONG_FORMAT (LONG )、Calendar.LONG_STANDALONE 、Calendar.NARROW_FORMAT 或 Calendar.NARROW_STANDALONE 之一

locale - 所需的locale

返回：

Map 包含 field 在 style 和 locale 及其 field 值中的所有显示名称，或者如果没有为 field 定义显示名称则为 null

抛出：

NullPointerException - 如果 locale 是 null

参见：

• Calendar.getDisplayNames(int, int, Locale)