Class DateFormat.Field
java.lang.Object
java.text.AttributedCharacterIterator.Attribute
java.text.Format.Field
java.text.DateFormat.Field
- All Implemented Interfaces:
Serializable
- Enclosing class:
DateFormat
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
Modifier and TypeFieldDescriptionstatic final DateFormat.Field
Constant identifying the time of day indicator (e.g. "a.m." or "p.m.") field.static final DateFormat.Field
Constant identifying the day of month field.static final DateFormat.Field
Constant identifying the day of week field.static final DateFormat.Field
Constant identifying the day of week field.static final DateFormat.Field
Constant identifying the day of year field.static final DateFormat.Field
Constant identifying the era field.static final DateFormat.Field
Constant identifying the hour of day field, where the legal values are 0 to 23.static final DateFormat.Field
Constant identifying the hour of day field, where the legal values are 1 to 24.static final DateFormat.Field
Constant identifying the hour field, where the legal values are 0 to 11.static final DateFormat.Field
Constant identifying the hour field, where the legal values are 1 to 12.static final DateFormat.Field
Constant identifying the millisecond field.static final DateFormat.Field
Constant identifying the minute field.static final DateFormat.Field
Constant identifying the month field.static final DateFormat.Field
Constant identifying the second field.static final DateFormat.Field
Constant identifying the time zone field.static final DateFormat.Field
Constant identifying the week of month field.static final DateFormat.Field
Constant identifying the week of year field.static final DateFormat.Field
Constant identifying the year field.Fields inherited from class java.text.AttributedCharacterIterator.Attribute
INPUT_METHOD_SEGMENT, LANGUAGE, READING
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
Returns theCalendar
field associated with this attribute.static DateFormat.Field
ofCalendarField
(int calendarField) Returns theField
constant that corresponds to theCalendar
constantcalendarField
.protected Object
Resolves instances being deserialized to the predefined constants.Methods inherited from class java.text.AttributedCharacterIterator.Attribute
equals, getName, hashCode, toString
-
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
Creates aField
.- Parameters:
name
- the name of theField
calendarField
- theCalendar
constant thisField
corresponds to; any value, even one outside the range of legalCalendar
values may be used, but-1
should be used for values that don't correspond to legalCalendar
values
-
-
Method Details
-
ofCalendarField
Returns theField
constant that corresponds to theCalendar
constantcalendarField
. If there is no direct mapping between theCalendar
constant and aField
, null is returned.- Parameters:
calendarField
- Calendar field constant- Returns:
- Field instance representing calendarField.
- Throws:
IllegalArgumentException
- ifcalendarField
is not the value of aCalendar
field constant.- See Also:
-
getCalendarField
public int getCalendarField()Returns theCalendar
field associated with this attribute. For example, if this represents the hours field of aCalendar
, this method would returnCalendar.HOUR
. The return value of-1
guarantees that this field does not represent any corresponding constant inCalendar
.- Implementation Requirements:
- The default implementation always returns
-1
if it does not represent any corresponding constant inCalendar
. - Returns:
- Calendar constant for this field
- See Also:
-
readResolve
Resolves instances being deserialized to the predefined constants.- Overrides:
readResolve
in classAttributedCharacterIterator.Attribute
- Returns:
- resolved DateFormat.Field constant
- Throws:
InvalidObjectException
- if the constant could not be resolved.
-