Package java.text

Class DateFormat.Field

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
The instances of this inner class are used as attribute keys and values in AttributedCharacterIterator that the SimpleDateFormat.formatToCharacterIterator(Object) method returns.

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

See Also:
Serialized Form

  • Field Details

    • ERA

      public static final DateFormat.Field ERA
      Marks the era part of a date.

    • YEAR

      public static final DateFormat.Field YEAR
      Marks the year part of a date.

    • MONTH

      public static final DateFormat.Field MONTH
      Marks the month part of a date.

    • HOUR_OF_DAY0

      public static final DateFormat.Field HOUR_OF_DAY0
      Marks the hour of the day part of a date (0-11).

    • HOUR_OF_DAY1

      public static final DateFormat.Field HOUR_OF_DAY1
      Marks the hour of the day part of a date (1-12).

    • MINUTE

      public static final DateFormat.Field MINUTE
      Marks the minute part of a time.

    • SECOND

      public static final DateFormat.Field SECOND
      Marks the second part of a time.

    • MILLISECOND

      public static final DateFormat.Field MILLISECOND
      Marks the millisecond part of a time.

    • DAY_OF_WEEK

      public static final DateFormat.Field DAY_OF_WEEK
      Marks the day of the week part of a date.

    • DAY_OF_MONTH

      public static final DateFormat.Field DAY_OF_MONTH
      Marks the day of the month part of a date.

    • DAY_OF_YEAR

      public static final DateFormat.Field DAY_OF_YEAR
      Marks the day of the year part of a date.

    • DAY_OF_WEEK_IN_MONTH

      public static final DateFormat.Field DAY_OF_WEEK_IN_MONTH
      Marks the day of the week in the month part of a date.

    • WEEK_OF_YEAR

      public static final DateFormat.Field WEEK_OF_YEAR
      Marks the week of the year part of a date.

    • WEEK_OF_MONTH

      public static final DateFormat.Field WEEK_OF_MONTH
      Marks the week of the month part of a date.

    • AM_PM

      public static final DateFormat.Field AM_PM
      Marks the time indicator part of a date.

    • HOUR0

      public static final DateFormat.Field HOUR0
      Marks the hour part of a date (0-11).

    • HOUR1

      public static final DateFormat.Field HOUR1
      Marks the hour part of a date (1-12).

    • TIME_ZONE

      public static final DateFormat.Field TIME_ZONE
      Marks the time zone part of a date.

  • Constructor Details

    • Field

      protected Field​(String fieldName, int calendarField)
      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.

  • Method Details

    • getCalendarField

      public int getCalendarField()
      Returns the Calendar field that this field represents.
      Returns:
      the calendar field.

    • ofCalendarField

      public static DateFormat.Field ofCalendarField​(int calendarField)
      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.