public static class

DateFormat.Field

extends Format.Field
java.lang.Object
   ↳java.text.AttributedCharacterIterator.Attribute
    ↳java.text.Format.Field
     ↳java.text.DateFormat.Field

Class Overview

The instances of this inner class are used as attribute keys and values in AttributedCharacterIterator that the formatToCharacterIterator(Object) method returns.

There is no public constructor in this class, the only instances are the constants defined here.

Summary

Constants
DateFormat.FieldAM_PMMarks the time indicator part of a date.
DateFormat.FieldDAY_OF_MONTHMarks the day of the month part of a date.
DateFormat.FieldDAY_OF_WEEKMarks the day of the week part of a date.
DateFormat.FieldDAY_OF_WEEK_IN_MONTHMarks the day of the week in the month part of a date.
DateFormat.FieldDAY_OF_YEARMarks the day of the year part of a date.
DateFormat.FieldERAMarks the era part of a date.
DateFormat.FieldHOUR0Marks the hour part of a date (0-11).
DateFormat.FieldHOUR1Marks the hour part of a date (1-12).
DateFormat.FieldHOUR_OF_DAY0Marks the hour of the day part of a date (0-11).
DateFormat.FieldHOUR_OF_DAY1Marks the hour of the day part of a date (1-12).
DateFormat.FieldMILLISECONDMarks the millisecond part of a time.
DateFormat.FieldMINUTEMarks the minute part of a time.
DateFormat.FieldMONTHMarks the month part of a date.
DateFormat.FieldSECONDMarks the second part of a time.
DateFormat.FieldTIME_ZONEMarks the time zone part of a date.
DateFormat.FieldWEEK_OF_MONTHMarks the week of the month part of a date.
DateFormat.FieldWEEK_OF_YEARMarks the week of the year part of a date.
DateFormat.FieldYEARMarks the year part of a date.
[Expand]
Inherited Constants
From class java.text.AttributedCharacterIterator.Attribute
Protected Constructors
DateFormat.Field(String fieldName, int calendarField)
Constructs a new instance of DateFormat.Field with the given fieldName and calendar field.
Public Methods
int getCalendarField()
Returns the Calendar field that this field represents.
static DateFormat.Field ofCalendarField(int calendarField)
Returns the DateFormat.Field instance for the given calendar field.
Protected Methods
Object readResolve()
Resolves instances that are deserialized to the constant DateFormat.Field values.
[Expand]
Inherited Methods
From class java.text.AttributedCharacterIterator.Attribute
From class java.lang.Object

Constants

public static final DateFormat.Field AM_PM

Since: API Level 1

Marks the time indicator part of a date.

public static final DateFormat.Field DAY_OF_MONTH

Since: API Level 1

Marks the day of the month part of a date.

public static final DateFormat.Field DAY_OF_WEEK

Since: API Level 1

Marks the day of the week part of a date.

public static final DateFormat.Field DAY_OF_WEEK_IN_MONTH

Since: API Level 1

Marks the day of the week in the month part of a date.

public static final DateFormat.Field DAY_OF_YEAR

Since: API Level 1

Marks the day of the year part of a date.

public static final DateFormat.Field ERA

Since: API Level 1

Marks the era part of a date.

public static final DateFormat.Field HOUR0

Since: API Level 1

Marks the hour part of a date (0-11).

public static final DateFormat.Field HOUR1

Since: API Level 1

Marks the hour part of a date (1-12).

public static final DateFormat.Field HOUR_OF_DAY0

Since: API Level 1

Marks the hour of the day part of a date (0-11).

public static final DateFormat.Field HOUR_OF_DAY1

Since: API Level 1

Marks the hour of the day part of a date (1-12).

public static final DateFormat.Field MILLISECOND

Since: API Level 1

Marks the millisecond part of a time.

public static final DateFormat.Field MINUTE

Since: API Level 1

Marks the minute part of a time.

public static final DateFormat.Field MONTH

Since: API Level 1

Marks the month part of a date.

public static final DateFormat.Field SECOND

Since: API Level 1

Marks the second part of a time.

public static final DateFormat.Field TIME_ZONE

Since: API Level 1

Marks the time zone part of a date.

public static final DateFormat.Field WEEK_OF_MONTH

Since: API Level 1

Marks the week of the month part of a date.

public static final DateFormat.Field WEEK_OF_YEAR

Since: API Level 1

Marks the week of the year part of a date.

public static final DateFormat.Field YEAR

Since: API Level 1

Marks the year part of a date.

Protected Constructors

protected DateFormat.Field (String fieldName, int calendarField)

Since: API Level 1

Constructs a new instance of DateFormat.Field with the given fieldName and calendar field.

Parameters
fieldName the field name.
calendarField the calendar field type of the field.

Public Methods

public int getCalendarField ()

Since: API Level 1

Returns the Calendar field that this field represents.

Returns
  • the calendar field.

public static DateFormat.Field ofCalendarField (int calendarField)

Since: API Level 1

Returns the DateFormat.Field instance for the given calendar field.

Parameters
calendarField a calendar field constant.
Returns
  • the DateFormat.Field corresponding to calendarField.
Throws
IllegalArgumentException if calendarField is negative or greater than the field count of Calendar.

Protected Methods

protected Object readResolve ()

Since: API Level 1

Resolves instances that are deserialized to the constant DateFormat.Field values.

Returns
  • the resolved field object.
Throws
InvalidObjectException if an error occurs while resolving the field object.