DateFormat.Field (Java Platform SE 8 ) (original) (raw)

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 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:
Calendar, Serialized Form

Field Summary

Fields

Modifier and Type	Field	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](../../java/text/AttributedCharacterIterator.Attribute.html "class in java.text")  
   `[INPUT_METHOD_SEGMENT](../../java/text/AttributedCharacterIterator.Attribute.html#INPUT%5FMETHOD%5FSEGMENT), [LANGUAGE](../../java/text/AttributedCharacterIterator.Attribute.html#LANGUAGE), [READING](../../java/text/AttributedCharacterIterator.Attribute.html#READING)`

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Field(String name, int calendarField)	Creates a Field.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods

Modifier and Type	Method	Description
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](../../java/text/AttributedCharacterIterator.Attribute.html "class in java.text")  
   `[equals](../../java/text/AttributedCharacterIterator.Attribute.html#equals-java.lang.Object-), [getName](../../java/text/AttributedCharacterIterator.Attribute.html#getName--), [hashCode](../../java/text/AttributedCharacterIterator.Attribute.html#hashCode--), [toString](../../java/text/AttributedCharacterIterator.Attribute.html#toString--)`  
   * ### Methods inherited from class java.lang.[Object](../../java/lang/Object.html "class in java.lang")  
   `[clone](../../java/lang/Object.html#clone--), [finalize](../../java/lang/Object.html#finalize--), [getClass](../../java/lang/Object.html#getClass--), [notify](../../java/lang/Object.html#notify--), [notifyAll](../../java/lang/Object.html#notifyAll--), [wait](../../java/lang/Object.html#wait--), [wait](../../java/lang/Object.html#wait-long-), [wait](../../java/lang/Object.html#wait-long-int-)`

Field Detail

 * #### ERA  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") ERA  
 Constant identifying the era field.  
 * #### YEAR  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") YEAR  
 Constant identifying the year field.  
 * #### MONTH  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") MONTH  
 Constant identifying the month field.  
 * #### DAY\_OF\_MONTH  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") DAY_OF_MONTH  
 Constant identifying the day of month field.  
 * #### HOUR\_OF\_DAY1  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") 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](../../java/text/DateFormat.Field.html "class in java.text") HOUR_OF_DAY0  
 Constant identifying the hour of day field, where the legal values are 0 to 23.  
 * #### MINUTE  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") MINUTE  
 Constant identifying the minute field.  
 * #### SECOND  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") SECOND  
 Constant identifying the second field.  
 * #### MILLISECOND  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") MILLISECOND  
 Constant identifying the millisecond field.  
 * #### DAY\_OF\_WEEK  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") DAY_OF_WEEK  
 Constant identifying the day of week field.  
 * #### DAY\_OF\_YEAR  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") DAY_OF_YEAR  
 Constant identifying the day of year field.  
 * #### DAY\_OF\_WEEK\_IN\_MONTH  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") DAY_OF_WEEK_IN_MONTH  
 Constant identifying the day of week field.  
 * #### WEEK\_OF\_YEAR  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") WEEK_OF_YEAR  
 Constant identifying the week of year field.  
 * #### WEEK\_OF\_MONTH  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") WEEK_OF_MONTH  
 Constant identifying the week of month field.  
 * #### AM\_PM  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") AM_PM  
 Constant identifying the time of day indicator (e.g. "a.m." or "p.m.") field.  
 * #### HOUR1  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") HOUR1  
 Constant identifying the hour field, where the legal values are 1 to 12.  
 * #### HOUR0  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") HOUR0  
 Constant identifying the hour field, where the legal values are 0 to 11.  
 * #### TIME\_ZONE  
 public static final [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") TIME_ZONE  
 Constant identifying the time zone field.

Constructor Detail

* #### Field  
protected Field([String](../../java/lang/String.html "class in java.lang") name,  
                int calendarField)  
Creates a `Field`.  
Parameters:  
`name` \- the name of the `Field`  
`calendarField` \- the `Calendar` constant this`Field` corresponds to; any value, even one outside the range of legal `Calendar` values may be used, but `-1` should be used for values that don't correspond to legal `Calendar` values

Method Detail

* #### ofCalendarField  
public static [DateFormat.Field](../../java/text/DateFormat.Field.html "class in java.text") 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:  
[Calendar](../../java/util/Calendar.html "class in java.util")  
* #### 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 return`Calendar.HOUR`. If there is no corresponding`Calendar` constant, this will return -1.  
Returns:  
Calendar constant for this field  
See Also:  
[Calendar](../../java/util/Calendar.html "class in java.util")  
* #### readResolve  
protected [Object](../../java/lang/Object.html "class in java.lang") readResolve()  
                      throws [InvalidObjectException](../../java/io/InvalidObjectException.html "class in java.io")  
Resolves instances being deserialized to the predefined constants.  
Overrides:  
`[readResolve](../../java/text/AttributedCharacterIterator.Attribute.html#readResolve--)` 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 SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

DateFormat.Field (Java Platform SE 8 ) (original) (raw)

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail