com.ibm.icu.text
public abstract class DateFormat extends UFormat
Date
object or
as the milliseconds since January 1, 1970, 00:00:00 GMT.
DateFormat provides many class methods for obtaining default date/time formatters based on the default or a given loacle and a number of formatting styles. The formatting styles include FULL, LONG, MEDIUM, and SHORT. More detail and examples of using these styles are provided in the method descriptions.
DateFormat helps you to format and parse dates for any locale. Your code can be completely independent of the locale conventions for months, days of the week, or even the calendar format: lunar vs. solar.
To format a date for the current Locale, use one of the static factory methods:
myString = DateFormat.getDateInstance().format(myDate);
If you are formatting multiple numbers, it is more efficient to get the format and use it multiple times so that the system doesn't have to fetch the information about the local language and country conventions multiple times.
DateFormat df = DateFormat.getDateInstance(); for (int i = 0; i < a.length; ++i) { output.println(df.format(myDate[i]) + "; "); }
To format a number for a different Locale, specify it in the call to getDateInstance().
DateFormat df = DateFormat.getDateInstance(DateFormat.LONG, Locale.FRANCE);
You can use a DateFormat to parse also.
myDate = df.parse(myString);
Use getDateInstance to get the normal date format for that country. There are other static factory methods available. Use getTimeInstance to get the time format for that country. Use getDateTimeInstance to get a date and time format. You can pass in different options to these factory methods to control the length of the result; from SHORT to MEDIUM to LONG to FULL. The exact result depends on the locale, but generally:
You can also set the time zone on the format if you wish. If you want even more control over the format or parsing, (or want to give your users more control), you can try casting the DateFormat you get from the factory methods to a SimpleDateFormat. This will work for the majority of countries; just remember to put it in a try block in case you encounter an unusual one.
You can also use forms of the parse and format methods with ParsePosition and FieldPosition to allow you to
See Also: UFormat NumberFormat SimpleDateFormat Calendar GregorianCalendar TimeZone
UNKNOWN: ICU 2.0
Field Summary | |
---|---|
static int | AM_PM_FIELD
FieldPosition selector for 'a' field alignment,
corresponding to the {@link Calendar#AM_PM} field. |
protected Calendar | calendar
The calendar that DateFormat uses to produce the time field
values needed to implement date and time formatting. |
static int | DATE_FIELD
FieldPosition selector for 'd' field alignment,
corresponding to the {@link Calendar#DATE} field. |
static int | DAY_OF_WEEK_FIELD
FieldPosition selector for 'E' field alignment,
corresponding to the {@link Calendar#DAY_OF_WEEK} field. |
static int | DAY_OF_WEEK_IN_MONTH_FIELD
FieldPosition selector for 'F' field alignment,
corresponding to the {@link Calendar#DAY_OF_WEEK_IN_MONTH} field. |
static int | DAY_OF_YEAR_FIELD
FieldPosition selector for 'D' field alignment,
corresponding to the {@link Calendar#DAY_OF_YEAR} field. |
static int | DEFAULT
Constant for default style pattern. |
static int | DOW_LOCAL_FIELD
FieldPosition selector for 'e' field alignment,
corresponding to the {@link Calendar#DOW_LOCAL} field. |
static int | ERA_FIELD
FieldPosition selector for 'G' field alignment,
corresponding to the {@link Calendar#ERA} field. |
static int | EXTENDED_YEAR_FIELD
FieldPosition selector for 'u' field alignment,
corresponding to the {@link Calendar#EXTENDED_YEAR} field. |
static int | FIELD_COUNT
Number of FieldPosition selectors for DateFormat.
|
static int | FRACTIONAL_SECOND_FIELD
FieldPosition selector for 'S' field alignment,
corresponding to the {@link Calendar#MILLISECOND} field. |
static int | FULL
Constant for full style pattern. |
static int | HOUR0_FIELD
FieldPosition selector for 'K' field alignment,
corresponding to the {@link Calendar#HOUR} field.
|
static int | HOUR1_FIELD
FieldPosition selector for 'h' field alignment,
corresponding to the {@link Calendar#HOUR} field.
|
static int | HOUR_OF_DAY0_FIELD
FieldPosition selector for 'H' field alignment,
corresponding to the {@link Calendar#HOUR_OF_DAY} field.
|
static int | HOUR_OF_DAY1_FIELD
FieldPosition selector for 'k' field alignment,
corresponding to the {@link Calendar#HOUR_OF_DAY} field.
|
static int | JULIAN_DAY_FIELD
FieldPosition selector for 'g' field alignment,
corresponding to the {@link Calendar#JULIAN_DAY} field. |
static int | LONG
Constant for long style pattern. |
static int | MEDIUM
Constant for medium style pattern. |
static int | MILLISECONDS_IN_DAY_FIELD
FieldPosition selector for 'A' field alignment,
corresponding to the {@link Calendar#MILLISECONDS_IN_DAY} field. |
static int | MILLISECOND_FIELD
Alias for FRACTIONAL_SECOND_FIELD. |
static int | MINUTE_FIELD
FieldPosition selector for 'm' field alignment,
corresponding to the {@link Calendar#MINUTE} field. |
static int | MONTH_FIELD
FieldPosition selector for 'M' field alignment,
corresponding to the {@link Calendar#MONTH} field. |
protected NumberFormat | numberFormat
The number formatter that DateFormat uses to format numbers
in dates and times. |
static int | QUARTER_FIELD
FieldPosition selector for 'Q' field alignment,
corresponding to the {@link Calendar#MONTH} field.
|
static int | SECOND_FIELD
FieldPosition selector for 's' field alignment,
corresponding to the {@link Calendar#SECOND} field. |
static int | SHORT
Constant for short style pattern. |
static int | STANDALONE_DAY_FIELD
FieldPosition selector for 'c' field alignment,
corresponding to the {@link Calendar#DAY_OF_WEEK} field.
|
static int | STANDALONE_MONTH_FIELD
FieldPosition selector for 'L' field alignment,
corresponding to the {@link Calendar#MONTH} field.
|
static int | STANDALONE_QUARTER_FIELD
FieldPosition selector for 'q' field alignment,
corresponding to the {@link Calendar#MONTH} field.
|
static int | TIMEZONE_FIELD
FieldPosition selector for 'z' field alignment,
corresponding to the {@link Calendar#ZONE_OFFSET} and
{@link Calendar#DST_OFFSET} fields. |
static int | TIMEZONE_GENERIC_FIELD
FieldPosition selector for 'v' field alignment,
corresponding to the {@link Calendar#ZONE_OFFSET} and
{@link Calendar#DST_OFFSET} fields. |
static int | TIMEZONE_RFC_FIELD
FieldPosition selector for 'Z' field alignment,
corresponding to the {@link Calendar#ZONE_OFFSET} and
{@link Calendar#DST_OFFSET} fields. |
static int | WEEK_OF_MONTH_FIELD
FieldPosition selector for 'W' field alignment,
corresponding to the {@link Calendar#WEEK_OF_MONTH} field. |
static int | WEEK_OF_YEAR_FIELD
FieldPosition selector for 'w' field alignment,
corresponding to the {@link Calendar#WEEK_OF_YEAR} field. |
static int | YEAR_FIELD
FieldPosition selector for 'y' field alignment,
corresponding to the {@link Calendar#YEAR} field. |
static int | YEAR_WOY_FIELD
FieldPosition selector for 'Y' field alignment,
corresponding to the {@link Calendar#YEAR_WOY} field. |
Constructor Summary | |
---|---|
protected | DateFormat()
Create a new date format. |
Method Summary | |
---|---|
Object | clone()
Overrides Cloneable |
boolean | equals(Object obj)
Overrides equals |
StringBuffer | format(Object obj, StringBuffer toAppendTo, FieldPosition fieldPosition)
Overrides Format.
|
abstract StringBuffer | format(Calendar cal, StringBuffer toAppendTo, FieldPosition fieldPosition)
Formats a date into a date/time string. |
StringBuffer | format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition)
Formats a Date into a date/time string. |
String | format(Date date)
Formats a Date into a date/time string. |
static Locale[] | getAvailableLocales()
Gets the set of locales for which DateFormats are installed. |
static ULocale[] | getAvailableULocales()
Gets the set of locales for which DateFormats are installed. |
Calendar | getCalendar()
Gets the calendar associated with this date/time formatter. |
static DateFormat | getDateInstance()
Gets the date formatter with the default formatting style
for the default locale. |
static DateFormat | getDateInstance(int style)
Gets the date formatter with the given formatting style
for the default locale. |
static DateFormat | getDateInstance(int style, Locale aLocale)
Gets the date formatter with the given formatting style
for the given locale. |
static DateFormat | getDateInstance(int style, ULocale locale)
Gets the date formatter with the given formatting style
for the given locale. |
static DateFormat | getDateInstance(Calendar cal, int dateStyle, Locale locale)
Create a {@link DateFormat} object that can be used to format dates in
the calendar system specified by cal .
|
static DateFormat | getDateInstance(Calendar cal, int dateStyle, ULocale locale)
Create a {@link DateFormat} object that can be used to format dates in
the calendar system specified by cal .
|
static DateFormat | getDateInstance(Calendar cal, int dateStyle)
Convenience overload |
static DateFormat | getDateTimeInstance()
Gets the date/time formatter with the default formatting style
for the default locale. |
static DateFormat | getDateTimeInstance(int dateStyle, int timeStyle)
Gets the date/time formatter with the given date and time
formatting styles for the default locale. |
static DateFormat | getDateTimeInstance(int dateStyle, int timeStyle, Locale aLocale)
Gets the date/time formatter with the given formatting styles
for the given locale. |
static DateFormat | getDateTimeInstance(int dateStyle, int timeStyle, ULocale locale)
Gets the date/time formatter with the given formatting styles
for the given locale. |
static DateFormat | getDateTimeInstance(Calendar cal, int dateStyle, int timeStyle, Locale locale)
Create a {@link DateFormat} object that can be used to format dates and times in
the calendar system specified by cal .
|
static DateFormat | getDateTimeInstance(Calendar cal, int dateStyle, int timeStyle, ULocale locale)
Create a {@link DateFormat} object that can be used to format dates and times in
the calendar system specified by cal .
|
static DateFormat | getDateTimeInstance(Calendar cal, int dateStyle, int timeStyle)
Convenience overload |
static DateFormat | getInstance()
Get a default date/time formatter that uses the SHORT style for both the
date and the time. |
static DateFormat | getInstance(Calendar cal, Locale locale)
Convenience overload |
static DateFormat | getInstance(Calendar cal, ULocale locale)
Convenience overload |
static DateFormat | getInstance(Calendar cal)
Convenience overload |
NumberFormat | getNumberFormat()
Gets the number formatter which this date/time formatter uses to
format and parse a time. |
static DateFormat | getTimeInstance()
Gets the time formatter with the default formatting style
for the default locale. |
static DateFormat | getTimeInstance(int style)
Gets the time formatter with the given formatting style
for the default locale. |
static DateFormat | getTimeInstance(int style, Locale aLocale)
Gets the time formatter with the given formatting style
for the given locale. |
static DateFormat | getTimeInstance(int style, ULocale locale)
Gets the time formatter with the given formatting style
for the given locale. |
static DateFormat | getTimeInstance(Calendar cal, int timeStyle, Locale locale)
Create a {@link DateFormat} object that can be used to format times in
the calendar system specified by cal .
|
static DateFormat | getTimeInstance(Calendar cal, int timeStyle, ULocale locale)
Create a {@link DateFormat} object that can be used to format times in
the calendar system specified by cal .
|
static DateFormat | getTimeInstance(Calendar cal, int timeStyle)
Convenience overload |
TimeZone | getTimeZone()
Gets the time zone. |
int | hashCode()
Overrides hashCode |
boolean | isLenient()
Tell whether date/time parsing is to be lenient. |
Date | parse(String text)
Parse a date/time string.
|
abstract void | parse(String text, Calendar cal, ParsePosition pos)
Parse a date/time string according to the given parse position.
|
Date | parse(String text, ParsePosition pos)
Parse a date/time string according to the given parse position. |
Object | parseObject(String source, ParsePosition pos)
Parse a date/time string into an Object. |
void | setCalendar(Calendar newCalendar)
Set the calendar to be used by this date format. |
void | setLenient(boolean lenient)
Specify whether or not date/time parsing is to be lenient. |
void | setNumberFormat(NumberFormat newNumberFormat)
Allows you to set the number formatter. |
void | setTimeZone(TimeZone zone)
Sets the time zone for the calendar of this DateFormat object. |
UNKNOWN: ICU 2.0
DateFormat
uses to produce the time field
values needed to implement date and time formatting. Subclasses should
initialize this to a calendar appropriate for the locale associated with
this DateFormat
.Serial:
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 3.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 3.0
UNKNOWN: ICU 3.0
UNKNOWN: ICU 3.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 3.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 3.0
Deprecated: ICU 3.0 use FRACTIONAL_SECOND_FIELD.
Alias for FRACTIONAL_SECOND_FIELD.UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
DateFormat
uses to format numbers
in dates and times. Subclasses should initialize this to a number format
appropriate for the locale associated with this DateFormat
.Serial:
UNKNOWN: ICU 2.0
UNKNOWN: ICU 3.6 This API might change or be removed in a future release.
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 3.4 This API might change or be removed in a future release.
UNKNOWN: ICU 3.4 This API might change or be removed in a future release.
UNKNOWN: ICU 3.6 This API might change or be removed in a future release.
UNKNOWN: ICU 2.0
UNKNOWN: ICU 3.4 This API might change or be removed in a future release.
UNKNOWN: ICU 3.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 3.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
Parameters: obj must be a Number or a Date or a Calendar. toAppendTo the string buffer for the returning time string. fieldPosition keeps track of the position of the field within the returned string. On input: an alignment field, if desired. On output: the offsets of the alignment field. For example, given a time text "1996.07.10 AD at 15:08:56 PDT", if the given fieldPosition is DateFormat.YEAR_FIELD, the begin index and end index of fieldPosition will be set to 0 and 4, respectively. Notice that if the same time field appears more than once in a pattern, the fieldPosition will be set for the first occurence of that time field. For instance, formatting a Date to the time string "1 PM PDT (Pacific Daylight Time)" using the pattern "h a z (zzzz)" and the alignment field DateFormat.TIMEZONE_FIELD, the begin index and end index of fieldPosition will be set to 5 and 8, respectively, for the first occurence of the timezone pattern character 'z'.
Returns: the formatted time string.
See Also: java.text.Format
UNKNOWN: ICU 2.0
Parameters: cal a Calendar set to the date and time to be formatted into a date/time string. toAppendTo the string buffer for the returning date/time string. fieldPosition keeps track of the position of the field within the returned string. On input: an alignment field, if desired. On output: the offsets of the alignment field. For example, given a time text "1996.07.10 AD at 15:08:56 PDT", if the given fieldPosition is DateFormat.YEAR_FIELD, the begin index and end index of fieldPosition will be set to 0 and 4, respectively. Notice that if the same time field appears more than once in a pattern, the fieldPosition will be set for the first occurence of that time field. For instance, formatting a Date to the time string "1 PM PDT (Pacific Daylight Time)" using the pattern "h a z (zzzz)" and the alignment field DateFormat.TIMEZONE_FIELD, the begin index and end index of fieldPosition will be set to 5 and 8, respectively, for the first occurence of the timezone pattern character 'z'.
Returns: the formatted date/time string.
UNKNOWN: ICU 2.0
Parameters: date a Date to be formatted into a date/time string. toAppendTo the string buffer for the returning date/time string. fieldPosition keeps track of the position of the field within the returned string. On input: an alignment field, if desired. On output: the offsets of the alignment field. For example, given a time text "1996.07.10 AD at 15:08:56 PDT", if the given fieldPosition is DateFormat.YEAR_FIELD, the begin index and end index of fieldPosition will be set to 0 and 4, respectively. Notice that if the same time field appears more than once in a pattern, the fieldPosition will be set for the first occurence of that time field. For instance, formatting a Date to the time string "1 PM PDT (Pacific Daylight Time)" using the pattern "h a z (zzzz)" and the alignment field DateFormat.TIMEZONE_FIELD, the begin index and end index of fieldPosition will be set to 5 and 8, respectively, for the first occurence of the timezone pattern character 'z'.
Returns: the formatted date/time string.
UNKNOWN: ICU 2.0
Parameters: date the time value to be formatted into a time string.
Returns: the formatted time string.
UNKNOWN: ICU 2.0
Returns: the set of locales for which DateFormats are installed.
UNKNOWN: ICU 2.0
Returns: the set of locales for which DateFormats are installed.
UNKNOWN: ICU 3.2 This API might change or be removed in a future release.
Returns: the calendar associated with this date/time formatter.
UNKNOWN: ICU 2.0
Returns: a date formatter.
UNKNOWN: ICU 2.0
Parameters: style the given formatting style. For example, SHORT for "M/d/yy" in the US locale.
Returns: a date formatter.
UNKNOWN: ICU 2.0
Parameters: style the given formatting style. For example, SHORT for "M/d/yy" in the US locale. aLocale the given locale.
Returns: a date formatter.
UNKNOWN: ICU 2.0
Parameters: style the given formatting style. For example, SHORT for "M/d/yy" in the US locale. locale the given ulocale.
Returns: a date formatter.
UNKNOWN: ICU 3.2 This API might change or be removed in a future release.
cal
.
Parameters: cal The calendar system for which a date format is desired. dateStyle The type of date format desired. This can be {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM}, etc. locale The locale for which the date format is desired.
UNKNOWN: ICU 2.0
cal
.
Parameters: cal The calendar system for which a date format is desired. dateStyle The type of date format desired. This can be {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM}, etc. locale The locale for which the date format is desired.
UNKNOWN: ICU 3.2 This API might change or be removed in a future release.
UNKNOWN: ICU 2.0
Returns: a date/time formatter.
UNKNOWN: ICU 2.0
Parameters: dateStyle the given date formatting style. For example, SHORT for "M/d/yy" in the US locale. timeStyle the given time formatting style. For example, SHORT for "h:mm a" in the US locale.
Returns: a date/time formatter.
UNKNOWN: ICU 2.0
Parameters: dateStyle the given date formatting style. timeStyle the given time formatting style. aLocale the given locale.
Returns: a date/time formatter.
UNKNOWN: ICU 2.0
Parameters: dateStyle the given date formatting style. timeStyle the given time formatting style. locale the given ulocale.
Returns: a date/time formatter.
UNKNOWN: ICU 3.2 This API might change or be removed in a future release.
cal
.
Note: When this functionality is moved into the core JDK, this method will probably be replaced by a new overload of {@link DateFormat#getInstance}.
Parameters: cal The calendar system for which a date/time format is desired. dateStyle The type of date format desired. This can be {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM}, etc. timeStyle The type of time format desired. This can be {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM}, etc. locale The locale for which the date/time format is desired.
See Also: DateFormat
UNKNOWN: ICU 2.0
cal
.
Note: When this functionality is moved into the core JDK, this method will probably be replaced by a new overload of {@link DateFormat#getInstance}.
Parameters: cal The calendar system for which a date/time format is desired. dateStyle The type of date format desired. This can be {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM}, etc. timeStyle The type of time format desired. This can be {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM}, etc. locale The locale for which the date/time format is desired.
See Also: DateFormat
UNKNOWN: ICU 3.2 This API might change or be removed in a future release.
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 3.2 This API might change or be removed in a future release.
UNKNOWN: ICU 2.0
Returns: the number formatter which this date/time formatter uses.
UNKNOWN: ICU 2.0
Returns: a time formatter.
UNKNOWN: ICU 2.0
Parameters: style the given formatting style. For example, SHORT for "h:mm a" in the US locale.
Returns: a time formatter.
UNKNOWN: ICU 2.0
Parameters: style the given formatting style. For example, SHORT for "h:mm a" in the US locale. aLocale the given locale.
Returns: a time formatter.
UNKNOWN: ICU 2.0
Parameters: style the given formatting style. For example, SHORT for "h:mm a" in the US locale. locale the given ulocale.
Returns: a time formatter.
UNKNOWN: ICU 3.2 This API might change or be removed in a future release.
cal
.
Note: When this functionality is moved into the core JDK, this method will probably be replaced by a new overload of {@link DateFormat#getInstance}.
Parameters: cal The calendar system for which a time format is desired. timeStyle The type of time format desired. This can be {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM}, etc. locale The locale for which the time format is desired.
See Also: DateFormat
UNKNOWN: ICU 2.0
cal
.
Note: When this functionality is moved into the core JDK, this method will probably be replaced by a new overload of {@link DateFormat#getInstance}.
Parameters: cal The calendar system for which a time format is desired. timeStyle The type of time format desired. This can be {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM}, etc. locale The locale for which the time format is desired.
See Also: DateFormat
UNKNOWN: ICU 3.2 This API might change or be removed in a future release.
UNKNOWN: ICU 2.0
Returns: the time zone associated with the calendar of DateFormat.
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
UNKNOWN: ICU 2.0
Parameters: text The date/time string to be parsed
Returns: A Date, or null if the input could not be parsed
Throws: ParseException If the given string cannot be parsed as a date.
See Also: DateFormat
UNKNOWN: ICU 2.0
By default, parsing is lenient: If the input is not in the form used by this object's format method but can still be parsed as a date, then the parse succeeds. Clients may insist on strict adherence to the format by calling setLenient(false).
Parameters: text The date/time string to be parsed cal The calendar into which parsed data will be stored. In general, this should be cleared before calling this method. If this parse fails, the calendar may still have been modified. pos On input, the position at which to start parsing; on output, the position at which parsing terminated, or the start position if the parse failed.
UNKNOWN: ICU 2.0
By default, parsing is lenient: If the input is not in the form used by this object's format method but can still be parsed as a date, then the parse succeeds. Clients may insist on strict adherence to the format by calling setLenient(false).
Parameters: text The date/time string to be parsed pos On input, the position at which to start parsing; on output, the position at which parsing terminated, or the start position if the parse failed.
Returns: A Date, or null if the input could not be parsed
UNKNOWN: ICU 2.0
See Also: DateFormat
UNKNOWN: ICU 2.0
Parameters: newCalendar the new Calendar to be used by the date format
UNKNOWN: ICU 2.0
Parameters: lenient when true, parsing is lenient
See Also: Calendar
UNKNOWN: ICU 2.0
Parameters: newNumberFormat the given new NumberFormat.
UNKNOWN: ICU 2.0
Parameters: zone the given new time zone.
UNKNOWN: ICU 2.0