Added in API level 1

DateFormat.Field

public static class DateFormat.Field
extends Format.Field

java.lang.Object
↳	java.text.AttributedCharacterIterator.Attribute
	↳	java.text.Format.Field
		↳	java.text.DateFormat.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.

See also:

Calendar

Summary

Fields
`public static final DateFormat.Field`	`AM_PM` Constant identifying the time of day indicator (e.g. "a.m." or "p.m.") field.
`public static final DateFormat.Field`	`DAY_OF_MONTH` Constant identifying the day of month field.
`public static final DateFormat.Field`	`DAY_OF_WEEK` Constant identifying the day of week field.
`public static final DateFormat.Field`	`DAY_OF_WEEK_IN_MONTH` Constant identifying the day of week field.
`public static final DateFormat.Field`	`DAY_OF_YEAR` Constant identifying the day of year field.
`public static final DateFormat.Field`	`ERA` Constant identifying the era field.
`public static final DateFormat.Field`	`HOUR0` Constant identifying the hour field, where the legal values are 0 to 11.
`public static final DateFormat.Field`	`HOUR1` Constant identifying the hour field, where the legal values are 1 to 12.
`public static final DateFormat.Field`	`HOUR_OF_DAY0` Constant identifying the hour of day field, where the legal values are 0 to 23.
`public static final DateFormat.Field`	`HOUR_OF_DAY1` Constant identifying the hour of day field, where the legal values are 1 to 24.
`public static final DateFormat.Field`	`MILLISECOND` Constant identifying the millisecond field.
`public static final DateFormat.Field`	`MINUTE` Constant identifying the minute field.
`public static final DateFormat.Field`	`MONTH` Constant identifying the month field.
`public static final DateFormat.Field`	`SECOND` Constant identifying the second field.
`public static final DateFormat.Field`	`TIME_ZONE` Constant identifying the time zone field.
`public static final DateFormat.Field`	`WEEK_OF_MONTH` Constant identifying the week of month field.
`public static final DateFormat.Field`	`WEEK_OF_YEAR` Constant identifying the week of year field.
`public static final DateFormat.Field`	`YEAR` Constant identifying the year field.

Inherited fields

From class java.text.AttributedCharacterIterator.Attribute

`public static final AttributedCharacterIterator.Attribute`	`INPUT_METHOD_SEGMENT` Attribute key for input method segments.
`public static final AttributedCharacterIterator.Attribute`	`LANGUAGE` Attribute key for the language of some text.
`public static final AttributedCharacterIterator.Attribute`	`READING` Attribute key for the reading of some text.

Protected constructors
`Field(String name, int calendarField)` Creates a `Field`.

Public methods
`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 methods
`Object`	`readResolve()` Resolves instances being deserialized to the predefined constants.

Inherited methods

From class


        
          java.text.AttributedCharacterIterator.Attribute

`final boolean`	`equals(Object obj)` Compares two objects for equality.
`String`	`getName()` Returns the name of the attribute.
`final int`	`hashCode()` Returns a hash code value for the object.
`Object`	`readResolve()` Resolves instances being deserialized to the predefined constants.
`String`	`toString()` Returns a string representation of the object.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Fields

AM_PM

Added in API level 1

public static final DateFormat.Field AM_PM

Constant identifying the time of day indicator (e.g. "a.m." or "p.m.") field.

DAY_OF_MONTH

Added in API level 1

public static final DateFormat.Field DAY_OF_MONTH

Constant identifying the day of month field.

DAY_OF_WEEK

Added in API level 1

public static final DateFormat.Field DAY_OF_WEEK

Constant identifying the day of week field.

DAY_OF_WEEK_IN_MONTH

Added in API level 1

public static final DateFormat.Field DAY_OF_WEEK_IN_MONTH

Constant identifying the day of week field.

DAY_OF_YEAR

Added in API level 1

public static final DateFormat.Field DAY_OF_YEAR

Constant identifying the day of year field.

ERA

Added in API level 1

public static final DateFormat.Field ERA

Constant identifying the era field.

HOUR0

Added in API level 1

public static final DateFormat.Field HOUR0

Constant identifying the hour field, where the legal values are 0 to 11.

HOUR1

Added in API level 1

public static final DateFormat.Field HOUR1

Constant identifying the hour field, where the legal values are 1 to 12.

HOUR_OF_DAY0

Added in API level 1

public static final DateFormat.Field HOUR_OF_DAY0

Constant identifying the hour of day field, where the legal values are 0 to 23.

HOUR_OF_DAY1

Added in API level 1

public static final DateFormat.Field HOUR_OF_DAY1

Constant identifying the hour of day field, where the legal values are 1 to 24.

MILLISECOND

Added in API level 1

public static final DateFormat.Field MILLISECOND

Constant identifying the millisecond field.

MINUTE

Added in API level 1

public static final DateFormat.Field MINUTE

Constant identifying the minute field.

MONTH

Added in API level 1

public static final DateFormat.Field MONTH

Constant identifying the month field.

SECOND

Added in API level 1

public static final DateFormat.Field SECOND

Constant identifying the second field.

TIME_ZONE

Added in API level 1

public static final DateFormat.Field TIME_ZONE

Constant identifying the time zone field.

WEEK_OF_MONTH

Added in API level 1

public static final DateFormat.Field WEEK_OF_MONTH

Constant identifying the week of month field.

WEEK_OF_YEAR

Added in API level 1

public static final DateFormat.Field WEEK_OF_YEAR

Constant identifying the week of year field.

YEAR

Added in API level 1

public static final DateFormat.Field YEAR

Constant identifying the year field.

Protected constructors

Field

Added in API level 1

protected Field (String name, 
                int calendarField)

Creates a Field.

Parameters
`name`	`String`: the name of the `Field`
`calendarField`	`int`: 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

Public methods

getCalendarField

Added in API level 1

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
`int`	Calendar constant for this field

See also:

Calendar

ofCalendarField

Added in API level 1

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`	`int`: Calendar field constant

Returns
`DateFormat.Field`	Field instance representing calendarField.

Throws
`IllegalArgumentException`	if `calendarField` is not the value of a `Calendar` field constant.

See also:

Calendar

Protected methods

readResolve

Added in API level 1

protected Object readResolve ()

Resolves instances being deserialized to the predefined constants.

Returns
`Object`	resolved DateFormat.Field constant

Throws
`InvalidObjectException`	if the constant could not be resolved.