DateFormat.Field | API reference

open class Field : Format.Field

kotlin.Any
↳	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.

Summary

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

Public methods

Public methods
open Int	`getCalendarField()` Returns the `Calendar` field associated with this attribute.
open static DateFormat.Field	`ofCalendarField(calendarField: Int)` Returns the `Field` constant that corresponds to the `Calendar` constant `calendarField`.

open Int

getCalendarField()

Returns the Calendar field associated with this attribute.

open static DateFormat.Field

ofCalendarField(calendarField: Int)

Returns the Field constant that corresponds to the Calendar constant calendarField.

Protected methods
open Any	`readResolve()` Resolves instances being deserialized to the predefined constants.

Properties
static DateFormat.Field	`AM_PM` Constant identifying the time of day indicator (e.g. "a.m." or "p.m.") field.
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	`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	`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	`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.

Protected constructors

Field

protected Field(
    name: String, 
    calendarField: Int)

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

open fun getCalendarField(): Int

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.

Return
`Int`	Calendar constant for this field

ofCalendarField

open static fun ofCalendarField(calendarField: Int): DateFormat.Field

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

Return
`DateFormat.Field`	Field instance representing calendarField.

Exceptions
`java.lang.IllegalArgumentException`	if `calendarField` is not the value of a `Calendar` field constant.

Protected methods

readResolve

protected open fun readResolve(): Any

Resolves instances being deserialized to the predefined constants.

Return
`Any`	resolved DateFormat.Field constant

Exceptions
`java.io.InvalidObjectException`	if the constant could not be resolved.

Properties

AM_PM

static val AM_PM: DateFormat.Field

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

DAY_OF_MONTH

static val DAY_OF_MONTH: DateFormat.Field

Constant identifying the day of month field.

DAY_OF_WEEK

static val DAY_OF_WEEK: DateFormat.Field

Constant identifying the day of week field.

DAY_OF_WEEK_IN_MONTH

static val DAY_OF_WEEK_IN_MONTH: DateFormat.Field

Constant identifying the day of week field.

DAY_OF_YEAR

static val DAY_OF_YEAR: DateFormat.Field

Constant identifying the day of year field.

HOUR0

static val HOUR0: DateFormat.Field

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

HOUR1

static val HOUR1: DateFormat.Field

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

HOUR_OF_DAY0

static val HOUR_OF_DAY0: DateFormat.Field

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

HOUR_OF_DAY1

static val HOUR_OF_DAY1: DateFormat.Field

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

MILLISECOND

static val MILLISECOND: DateFormat.Field

Constant identifying the millisecond field.

MINUTE

static val MINUTE: DateFormat.Field

Constant identifying the minute field.

SECOND

static val SECOND: DateFormat.Field

Constant identifying the second field.

TIME_ZONE

static val TIME_ZONE: DateFormat.Field

Constant identifying the time zone field.

WEEK_OF_MONTH

static val WEEK_OF_MONTH: DateFormat.Field

Constant identifying the week of month field.

WEEK_OF_YEAR

static val WEEK_OF_YEAR: DateFormat.Field

Constant identifying the week of year field.

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.