This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

java.text
class DateFormat.Field

java.lang.Object extended by java.text.AttributedCharacterIterator.Attribute extended by java.text.Format.Field extended by java.text.DateFormat.Field
All Implemented Interfaces:
Serializable
Enclosing class:
DateFormat
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.

Field Summary
static DateFormat.Field AM_PM
          Constant identifying the time of day indicator (e.g.
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.
 
Fields inherited from class java.text.AttributedCharacterIterator.Attribute
INPUT_METHOD_SEGMENT, LANGUAGE, READING
 
Constructor Summary
protected
DateFormat.Field(String name, int calendarField)

          Creates a Field.
 
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 Object
readResolve()

          Resolves instances being deserialized to the predefined constants.
 
Methods inherited from class java.text.AttributedCharacterIterator.Attribute
equals, getName, hashCode, readResolve, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

AM_PM

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

DAY_OF_MONTH

public static final DateFormat.Field DAY_OF_MONTH
Constant identifying the day of month field.

DAY_OF_WEEK

public static final DateFormat.Field DAY_OF_WEEK
Constant identifying the day of week field.

DAY_OF_WEEK_IN_MONTH

public static final DateFormat.Field DAY_OF_WEEK_IN_MONTH
Constant identifying the day of week field.

DAY_OF_YEAR

public static final DateFormat.Field DAY_OF_YEAR
Constant identifying the day of year field.

ERA

public static final DateFormat.Field ERA
Constant identifying the era field.

HOUR0

public static final DateFormat.Field HOUR0
Constant identifying the hour field, where the legal values are 0 to 11.

HOUR1

public static final DateFormat.Field HOUR1
Constant identifying the hour field, where the legal values are 1 to 12.

HOUR_OF_DAY0

public static final DateFormat.Field HOUR_OF_DAY0
Constant identifying the hour of day field, where the legal values are 0 to 23.

HOUR_OF_DAY1

public static final DateFormat.Field HOUR_OF_DAY1
Constant identifying the hour of day field, where the legal values are 1 to 24.

MILLISECOND

public static final DateFormat.Field MILLISECOND
Constant identifying the millisecond field.

MINUTE

public static final DateFormat.Field MINUTE
Constant identifying the minute field.

MONTH

public static final DateFormat.Field MONTH
Constant identifying the month field.

SECOND

public static final DateFormat.Field SECOND
Constant identifying the second field.

TIME_ZONE

public static final DateFormat.Field TIME_ZONE
Constant identifying the time zone field.

WEEK_OF_MONTH

public static final DateFormat.Field WEEK_OF_MONTH
Constant identifying the week of month field.

WEEK_OF_YEAR

public static final DateFormat.Field WEEK_OF_YEAR
Constant identifying the week of year field.

YEAR

public static final DateFormat.Field YEAR
Constant identifying the year field.
Constructor Detail

DateFormat.Field

protected DateFormat.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
Method Detail

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

ofCalendarField

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.

readResolve

protected Object readResolve()
                      throws InvalidObjectException
Resolves instances being deserialized to the predefined constants.

Overrides:
readResolve in class AttributedCharacterIterator.Attribute
Returns:
resolved DateFormat.Field constant
Throws:
InvalidObjectException - if the constant could not be resolved.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.