DateFormat.Field

public static class DateFormat.Field extends Format.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

Field Summary

public static final DateFormat.Field	AM_PM	Constant identifying the time of day indicator (e.g.
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 Field Summary

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 Constructor Summary

Field(String name, int calendarField) Creates a Field.

Public Method Summary

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 Method Summary

Object

readResolve() Resolves instances being deserialized to the predefined constants.

Inherited Method Summary

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) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

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.

Protected Constructors

protected Field (String 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

Public Methods

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

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	Calendar field constant

Returns

• Field instance representing calendarField.

Throws

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

See Also

• Calendar

Protected Methods

protected Object readResolve ()

Resolves instances being deserialized to the predefined constants.

Returns

• resolved DateFormat.Field constant

Throws

InvalidObjectException	if the constant could not be resolved.