DateFormat.Field (Java 2 Platform SE 5.0) (original) (raw)
java.text
Class DateFormat.Field
java.lang.Object
java.text.AttributedCharacterIterator.Attribute
java.text.Format.Field
java.text.DateFormat.Field
All Implemented Interfaces:
Enclosing class:
public static class DateFormat.Field
extends Format.Field
Defines constants that are used as attribute keys in theAttributedCharacterIterator 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 | |
|---|---|
| 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 | |
|---|---|
| protected | [DateFormat.Field](../../java/text/DateFormat.Field.html#DateFormat.Field%28java.lang.String, int%29)(String name, int calendarField) Creates a Field with the specified name. |
| Method Summary | |
|---|---|
| int | getCalendarField() Returns the Calendar field associated with this attribute. |
| static DateFormat.Field | ofCalendarField(int calendarField) Returns the Field constant that corresponds to the Calendar constant calendarField. |
| protected Object | readResolve() Resolves instances being deserialized to the predefined constants. |
| Methods inherited from class java.text.AttributedCharacterIterator.Attribute |
|---|
| equals, getName, hashCode, toString |
| Methods inherited from class java.lang.Object |
|---|
| clone, finalize, getClass, notify, notifyAll, wait, wait, [wait](../../java/lang/Object.html#wait%28long, int%29) |
| 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 a Field with the specified name. calendarField is used to identify the Calendar field this attribute represents. Use -1 if this field does not have a corresponding Calendar value.
Parameters:
name - Name of the attribute
calendarField - Calendar constant
| Method Detail |
|---|
ofCalendarField
public static DateFormat.Field ofCalendarField(int calendarField)
Returns the Field constant that corresponds to the Calendar constant calendarField. If there is no direct mapping between the Calendar constant and a Field, null is returned.
Parameters:
calendarField - Calendar field constant
Returns:
Field instance representing calendarField.
Throws:
[IllegalArgumentException](../../java/lang/IllegalArgumentException.html "class in java.lang") - if calendarField is not the value of a Calendar field constant.
See Also:
getCalendarField
public int getCalendarField()
Returns the Calendar field associated with this attribute. For example, if this represents the hours field of a Calendar, this would returnCalendar.HOUR. If there is no correspondingCalendar constant, this will return -1.
Returns:
Calendar constant for this field
See Also:
readResolve
protected Object readResolve() throws InvalidObjectException
Resolves instances being deserialized to the predefined constants.
Overrides:
[readResolve](../../java/text/AttributedCharacterIterator.Attribute.html#readResolve%28%29) in class [AttributedCharacterIterator.Attribute](../../java/text/AttributedCharacterIterator.Attribute.html "class in java.text")
Returns:
resolved DateFormat.Field constant
Throws:
[InvalidObjectException](../../java/io/InvalidObjectException.html "class in java.io") - if the constant could not be resolved.
Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 2004, 2010 Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.