DateFormat.Field (Java SE 17 & JDK 17)
- All Implemented Interfaces:
Serializable
- Enclosing class:
- DateFormat
public static class DateFormat.Field extends Format.Field
Defines constants that are used as attribute keys in the
AttributedCharacterIterator returned
from DateFormat.formatToCharacterIterator and as
field identifiers in FieldPosition.
The class also provides two methods to map between its constants and the corresponding Calendar constants.
- Since:
- 1.4
- See Also:
-
Field Summary
Fields
Constant identifying the time of day indicator (e.g.
Constant identifying the day of month field.
Constant identifying the day of week field.
Constant identifying the day of week field.
Constant identifying the day of year field.
Constant identifying the era field.
Constant identifying the hour of day field, where the legal values are 0 to 23.
Constant identifying the hour of day field, where the legal values are 1 to 24.
Constant identifying the hour field, where the legal values are 0 to 11.
Constant identifying the hour field, where the legal values are 1 to 12.
Constant identifying the millisecond field.
Constant identifying the minute field.
Constant identifying the month field.
Constant identifying the second field.
Constant identifying the time zone field.
Constant identifying the week of month field.
Constant identifying the week of year field.
Constant identifying the year field.
-
Constructor Summary
Constructors
-
Method Summary
intReturns the
Calendarfield associated with this attribute.ofCalendarField(int calendarField) Returns the
Fieldconstant that corresponds to theCalendarconstantcalendarField.Resolves instances being deserialized to the predefined constants.
-
Field Details
-
ERA
Constant identifying the era field.
-
YEAR
Constant identifying the year field.
-
MONTH
Constant identifying the month field.
-
DAY_OF_MONTH
Constant identifying the day of month field.
-
HOUR_OF_DAY1
Constant identifying the hour of day field, where the legal values are 1 to 24.
-
HOUR_OF_DAY0
Constant identifying the hour of day field, where the legal values are 0 to 23.
-
MINUTE
Constant identifying the minute field.
-
SECOND
Constant identifying the second field.
-
MILLISECOND
Constant identifying the millisecond field.
-
DAY_OF_WEEK
Constant identifying the day of week field.
-
DAY_OF_YEAR
Constant identifying the day of year field.
-
DAY_OF_WEEK_IN_MONTH
Constant identifying the day of week field.
-
WEEK_OF_YEAR
Constant identifying the week of year field.
-
WEEK_OF_MONTH
Constant identifying the week of month field.
-
AM_PM
Constant identifying the time of day indicator (e.g. "a.m." or "p.m.") field.
-
HOUR1
Constant identifying the hour field, where the legal values are 1 to 12.
-
HOUR0
Constant identifying the hour field, where the legal values are 0 to 11.
-
TIME_ZONE
Constant identifying the time zone field.
-
-
Constructor Details
-
Field
protected Field
(String name, int calendarField) Creates a
Field.- Parameters:
name- the name of theFieldcalendarField- theCalendarconstant thisFieldcorresponds to; any value, even one outside the range of legalCalendarvalues may be used, but-1should be used for values that don't correspond to legalCalendarvalues
-
-
Method Details
-
ofCalendarField
public static DateFormat.Field ofCalendarField
(int calendarField) Returns the
Fieldconstant that corresponds to theCalendarconstantcalendarField. If there is no direct mapping between theCalendarconstant and aField, null is returned.- Parameters:
calendarField- Calendar field constant- Returns:
- Field instance representing calendarField.
- Throws:
IllegalArgumentException- ifcalendarFieldis not the value of aCalendarfield constant.- See Also:
-
getCalendarField
public int getCalendarField()
Returns the
Calendarfield associated with this attribute. For example, if this represents the hours field of aCalendar, this would returnCalendar.HOUR. If there is no correspondingCalendarconstant, this will return -1.- Returns:
- Calendar constant for this field
- See Also:
-
readResolve
Resolves instances being deserialized to the predefined constants.
- Overrides:
readResolvein classAttributedCharacterIterator.Attribute- Returns:
- resolved DateFormat.Field constant
- Throws:
InvalidObjectException- if the constant could not be resolved.
-