java.text
Class DateFormat.Field

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.text.AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.Attribute 
      extended by java.text.Format.Field sample code for java.text.Format.Field definition code for java.text.Format.Field 
          extended by java.text.DateFormat.Field
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable
Enclosing class:
DateFormat sample code for java.text.DateFormat definition code for java.text.DateFormat

public static class DateFormat.Field
extends Format.Field sample code for java.text.Format.Field definition code for java.text.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.

Since:
1.4
See Also:
Calendar sample code for java.util.Calendar definition code for java.util.Calendar , Serialized Form

Field Summary
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field AM_PM sample code for java.text.DateFormat.Field.AM_PM definition code for java.text.DateFormat.Field.AM_PM
          Constant identifying the time of day indicator (e.g.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field DAY_OF_MONTH sample code for java.text.DateFormat.Field.DAY_OF_MONTH definition code for java.text.DateFormat.Field.DAY_OF_MONTH
          Constant identifying the day of month field.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field DAY_OF_WEEK sample code for java.text.DateFormat.Field.DAY_OF_WEEK definition code for java.text.DateFormat.Field.DAY_OF_WEEK
          Constant identifying the day of week field.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field DAY_OF_WEEK_IN_MONTH sample code for java.text.DateFormat.Field.DAY_OF_WEEK_IN_MONTH definition code for java.text.DateFormat.Field.DAY_OF_WEEK_IN_MONTH
          Constant identifying the day of week field.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field DAY_OF_YEAR sample code for java.text.DateFormat.Field.DAY_OF_YEAR definition code for java.text.DateFormat.Field.DAY_OF_YEAR
          Constant identifying the day of year field.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field ERA sample code for java.text.DateFormat.Field.ERA definition code for java.text.DateFormat.Field.ERA
          Constant identifying the era field.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field HOUR_OF_DAY0 sample code for java.text.DateFormat.Field.HOUR_OF_DAY0 definition code for java.text.DateFormat.Field.HOUR_OF_DAY0
          Constant identifying the hour of day field, where the legal values are 0 to 23.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field HOUR_OF_DAY1 sample code for java.text.DateFormat.Field.HOUR_OF_DAY1 definition code for java.text.DateFormat.Field.HOUR_OF_DAY1
          Constant identifying the hour of day field, where the legal values are 1 to 24.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field HOUR0 sample code for java.text.DateFormat.Field.HOUR0 definition code for java.text.DateFormat.Field.HOUR0
          Constant identifying the hour field, where the legal values are 0 to 11.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field HOUR1 sample code for java.text.DateFormat.Field.HOUR1 definition code for java.text.DateFormat.Field.HOUR1
          Constant identifying the hour field, where the legal values are 1 to 12.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field MILLISECOND sample code for java.text.DateFormat.Field.MILLISECOND definition code for java.text.DateFormat.Field.MILLISECOND
          Constant identifying the millisecond field.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field MINUTE sample code for java.text.DateFormat.Field.MINUTE definition code for java.text.DateFormat.Field.MINUTE
          Constant identifying the minute field.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field MONTH sample code for java.text.DateFormat.Field.MONTH definition code for java.text.DateFormat.Field.MONTH
          Constant identifying the month field.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field SECOND sample code for java.text.DateFormat.Field.SECOND definition code for java.text.DateFormat.Field.SECOND
          Constant identifying the second field.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field TIME_ZONE sample code for java.text.DateFormat.Field.TIME_ZONE definition code for java.text.DateFormat.Field.TIME_ZONE
          Constant identifying the time zone field.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field WEEK_OF_MONTH sample code for java.text.DateFormat.Field.WEEK_OF_MONTH definition code for java.text.DateFormat.Field.WEEK_OF_MONTH
          Constant identifying the week of month field.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field WEEK_OF_YEAR sample code for java.text.DateFormat.Field.WEEK_OF_YEAR definition code for java.text.DateFormat.Field.WEEK_OF_YEAR
          Constant identifying the week of year field.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field YEAR sample code for java.text.DateFormat.Field.YEAR definition code for java.text.DateFormat.Field.YEAR
          Constant identifying the year field.
 
Fields inherited from class java.text.AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.Attribute
INPUT_METHOD_SEGMENT sample code for java.text.AttributedCharacterIterator.Attribute.INPUT_METHOD_SEGMENT definition code for java.text.AttributedCharacterIterator.Attribute.INPUT_METHOD_SEGMENT , LANGUAGE sample code for java.text.AttributedCharacterIterator.Attribute.LANGUAGE definition code for java.text.AttributedCharacterIterator.Attribute.LANGUAGE , READING sample code for java.text.AttributedCharacterIterator.Attribute.READING definition code for java.text.AttributedCharacterIterator.Attribute.READING
 
Constructor Summary
protected DateFormat.Field sample code for java.text.DateFormat.Field.DateFormat.Field(java.lang.String, int) definition code for java.text.DateFormat.Field.DateFormat.Field(java.lang.String, int) (String sample code for java.lang.String definition code for java.lang.String  name, int calendarField)
          Creates a Field with the specified name.
 
Method Summary
 int getCalendarField sample code for java.text.DateFormat.Field.getCalendarField() definition code for java.text.DateFormat.Field.getCalendarField() ()
          Returns the Calendar field associated with this attribute.
static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field ofCalendarField sample code for java.text.DateFormat.Field.ofCalendarField(int) definition code for java.text.DateFormat.Field.ofCalendarField(int) (int calendarField)
          Returns the Field constant that corresponds to the Calendar constant calendarField.
protected  Object sample code for java.lang.Object definition code for java.lang.Object readResolve sample code for java.text.DateFormat.Field.readResolve() definition code for java.text.DateFormat.Field.readResolve() ()
          Resolves instances being deserialized to the predefined constants.
 
Methods inherited from class java.text.AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.Attribute
equals sample code for java.text.AttributedCharacterIterator.Attribute.equals(java.lang.Object) definition code for java.text.AttributedCharacterIterator.Attribute.equals(java.lang.Object) , getName sample code for java.text.AttributedCharacterIterator.Attribute.getName() definition code for java.text.AttributedCharacterIterator.Attribute.getName() , hashCode sample code for java.text.AttributedCharacterIterator.Attribute.hashCode() definition code for java.text.AttributedCharacterIterator.Attribute.hashCode() , toString sample code for java.text.AttributedCharacterIterator.Attribute.toString() definition code for java.text.AttributedCharacterIterator.Attribute.toString()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

ERA sample code for java.text.DateFormat.Field.ERA

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  ERA
Constant identifying the era field.


YEAR sample code for java.text.DateFormat.Field.YEAR

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  YEAR
Constant identifying the year field.


MONTH sample code for java.text.DateFormat.Field.MONTH

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  MONTH
Constant identifying the month field.


DAY_OF_MONTH sample code for java.text.DateFormat.Field.DAY_OF_MONTH

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  DAY_OF_MONTH
Constant identifying the day of month field.


HOUR_OF_DAY1 sample code for java.text.DateFormat.Field.HOUR_OF_DAY1

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  HOUR_OF_DAY1
Constant identifying the hour of day field, where the legal values are 1 to 24.


HOUR_OF_DAY0 sample code for java.text.DateFormat.Field.HOUR_OF_DAY0

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  HOUR_OF_DAY0
Constant identifying the hour of day field, where the legal values are 0 to 23.


MINUTE sample code for java.text.DateFormat.Field.MINUTE

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  MINUTE
Constant identifying the minute field.


SECOND sample code for java.text.DateFormat.Field.SECOND

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  SECOND
Constant identifying the second field.


MILLISECOND sample code for java.text.DateFormat.Field.MILLISECOND

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  MILLISECOND
Constant identifying the millisecond field.


DAY_OF_WEEK sample code for java.text.DateFormat.Field.DAY_OF_WEEK

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  DAY_OF_WEEK
Constant identifying the day of week field.


DAY_OF_YEAR sample code for java.text.DateFormat.Field.DAY_OF_YEAR

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  DAY_OF_YEAR
Constant identifying the day of year field.


DAY_OF_WEEK_IN_MONTH sample code for java.text.DateFormat.Field.DAY_OF_WEEK_IN_MONTH

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  DAY_OF_WEEK_IN_MONTH
Constant identifying the day of week field.


WEEK_OF_YEAR sample code for java.text.DateFormat.Field.WEEK_OF_YEAR

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  WEEK_OF_YEAR
Constant identifying the week of year field.


WEEK_OF_MONTH sample code for java.text.DateFormat.Field.WEEK_OF_MONTH

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  WEEK_OF_MONTH
Constant identifying the week of month field.


AM_PM sample code for java.text.DateFormat.Field.AM_PM

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  AM_PM
Constant identifying the time of day indicator (e.g. "a.m." or "p.m.") field.


HOUR1 sample code for java.text.DateFormat.Field.HOUR1

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  HOUR1
Constant identifying the hour field, where the legal values are 1 to 12.


HOUR0 sample code for java.text.DateFormat.Field.HOUR0

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  HOUR0
Constant identifying the hour field, where the legal values are 0 to 11.


TIME_ZONE sample code for java.text.DateFormat.Field.TIME_ZONE

public static final DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.DateFormat.Field  TIME_ZONE
Constant identifying the time zone field.

Constructor Detail

DateFormat.Field sample code for java.text.DateFormat.Field(java.lang.String, int) definition code for java.text.DateFormat.Field(java.lang.String, int)

protected DateFormat.Field(String sample code for java.lang.String definition code for java.lang.String  name,
                           int calendarField)
Creates a Field with the specified name. calendarField is used to identify the Calendar field this attribute represents. Use -1 if this field does not have a corresponding Calendar value.

Parameters:
name - Name of the attribute
calendarField - Calendar constant
Method Detail

ofCalendarField sample code for java.text.DateFormat.Field.ofCalendarField(int) definition code for java.text.DateFormat.Field.ofCalendarField(int)

public static DateFormat.Field sample code for java.text.DateFormat.Field definition code for java.text.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 sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if calendarField is not the value of a Calendar field constant.
See Also:
Calendar sample code for java.util.Calendar definition code for java.util.Calendar

getCalendarField sample code for java.text.DateFormat.Field.getCalendarField() definition code for java.text.DateFormat.Field.getCalendarField()

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 sample code for java.util.Calendar definition code for java.util.Calendar

readResolve sample code for java.text.DateFormat.Field.readResolve() definition code for java.text.DateFormat.Field.readResolve()

protected Object sample code for java.lang.Object definition code for java.lang.Object  readResolve()
                      throws InvalidObjectException sample code for java.io.InvalidObjectException definition code for java.io.InvalidObjectException 
Resolves instances being deserialized to the predefined constants.

Overrides:
readResolve sample code for java.text.AttributedCharacterIterator.Attribute.readResolve() definition code for java.text.AttributedCharacterIterator.Attribute.readResolve() in class AttributedCharacterIterator.Attribute sample code for java.text.AttributedCharacterIterator.Attribute definition code for java.text.AttributedCharacterIterator.Attribute
Returns:
resolved DateFormat.Field constant
Throws:
InvalidObjectException sample code for java.io.InvalidObjectException definition code for java.io.InvalidObjectException - if the constant could not be resolved.