- java.lang.Object
-
- java.text.AttributedCharacterIterator.Attribute
-
- java.text.Format.Field
-
- java.text.DateFormat.Field
-
- All Implemented Interfaces:
- Serializable
- Enclosing class:
- DateFormat
public static class DateFormat.Field extends Format.Field
Defines constants that are used as attribute keys in theAttributedCharacterIterator
returned fromDateFormat.formatToCharacterIterator
and as field identifiers inFieldPosition
.The class also provides two methods to map between its constants and the corresponding Calendar constants.
- Since:
- 1.4
- See Also:
Calendar
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description static DateFormat.Field
AM_PM
Constant identifying the time of day indicator (e.g.static DateFormat.Field
DAY_OF_MONTH
Constant identifying the day of month field.static DateFormat.Field
DAY_OF_WEEK
Constant identifying the day of week field.static DateFormat.Field
DAY_OF_WEEK_IN_MONTH
Constant identifying the day of week field.static DateFormat.Field
DAY_OF_YEAR
Constant identifying the day of year field.static DateFormat.Field
ERA
Constant identifying the era field.static DateFormat.Field
HOUR_OF_DAY0
Constant identifying the hour of day field, where the legal values are 0 to 23.static DateFormat.Field
HOUR_OF_DAY1
Constant identifying the hour of day field, where the legal values are 1 to 24.static DateFormat.Field
HOUR0
Constant identifying the hour field, where the legal values are 0 to 11.static DateFormat.Field
HOUR1
Constant identifying the hour field, where the legal values are 1 to 12.static DateFormat.Field
MILLISECOND
Constant identifying the millisecond field.static DateFormat.Field
MINUTE
Constant identifying the minute field.static DateFormat.Field
MONTH
Constant identifying the month field.static DateFormat.Field
SECOND
Constant identifying the second field.static DateFormat.Field
TIME_ZONE
Constant identifying the time zone field.static DateFormat.Field
WEEK_OF_MONTH
Constant identifying the week of month field.static DateFormat.Field
WEEK_OF_YEAR
Constant identifying the week of year field.static DateFormat.Field
YEAR
Constant identifying the year field.-
Fields inherited from class java.text.AttributedCharacterIterator.Attribute
INPUT_METHOD_SEGMENT, LANGUAGE, READING
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
DateFormat.Field(String name, int calendarField)
Creates aField
.
-
Method Summary
Methods Modifier and Type Method and Description int
getCalendarField()
Returns theCalendar
field associated with this attribute.static DateFormat.Field
ofCalendarField(int calendarField)
Returns theField
constant that corresponds to theCalendar
constantcalendarField
.protected Object
readResolve()
Resolves instances being deserialized to the predefined constants.
-
-
-
Field Detail
-
ERA
public static final DateFormat.Field ERA
Constant identifying the era field.
-
YEAR
public static final DateFormat.Field YEAR
Constant identifying the year field.
-
MONTH
public static final DateFormat.Field MONTH
Constant identifying the month field.
-
DAY_OF_MONTH
public static final DateFormat.Field DAY_OF_MONTH
Constant identifying the day of month field.
-
HOUR_OF_DAY1
public static final DateFormat.Field HOUR_OF_DAY1
Constant identifying the hour of day field, where the legal values are 1 to 24.
-
HOUR_OF_DAY0
public static final DateFormat.Field HOUR_OF_DAY0
Constant identifying the hour of day field, where the legal values are 0 to 23.
-
MINUTE
public static final DateFormat.Field MINUTE
Constant identifying the minute field.
-
SECOND
public static final DateFormat.Field SECOND
Constant identifying the second field.
-
MILLISECOND
public static final DateFormat.Field MILLISECOND
Constant identifying the millisecond field.
-
DAY_OF_WEEK
public static final DateFormat.Field DAY_OF_WEEK
Constant identifying the day of week field.
-
DAY_OF_YEAR
public static final DateFormat.Field DAY_OF_YEAR
Constant identifying the day of year field.
-
DAY_OF_WEEK_IN_MONTH
public static final DateFormat.Field DAY_OF_WEEK_IN_MONTH
Constant identifying the day of week field.
-
WEEK_OF_YEAR
public static final DateFormat.Field WEEK_OF_YEAR
Constant identifying the week of year field.
-
WEEK_OF_MONTH
public static final DateFormat.Field WEEK_OF_MONTH
Constant identifying the week of month field.
-
AM_PM
public static final DateFormat.Field AM_PM
Constant identifying the time of day indicator (e.g. "a.m." or "p.m.") field.
-
HOUR1
public static final DateFormat.Field HOUR1
Constant identifying the hour field, where the legal values are 1 to 12.
-
HOUR0
public static final DateFormat.Field HOUR0
Constant identifying the hour field, where the legal values are 0 to 11.
-
TIME_ZONE
public static final DateFormat.Field TIME_ZONE
Constant identifying the time zone field.
-
-
Constructor Detail
-
DateFormat.Field
protected DateFormat.Field(String name, int calendarField)
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 Detail
-
ofCalendarField
public static DateFormat.Field ofCalendarField(int calendarField)
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:
Calendar
-
getCalendarField
public int getCalendarField()
Returns theCalendar
field associated with this attribute. For example, if this represents the hours field of aCalendar
, this would returnCalendar.HOUR
. If there is no correspondingCalendar
constant, this will return -1.- Returns:
- Calendar constant for this field
- See Also:
Calendar
-
readResolve
protected Object readResolve() throws InvalidObjectException
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.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/text/dateformat.field.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.