|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.text.Format
com.ibm.icu.text.UFormat
com.ibm.icu.text.DateFormat
public abstract class DateFormat
[icu enhancement] ICU's replacement for java.text.DateFormat
. Methods, fields, and other functionality specific to ICU are labeled '[icu]'.
DateFormat is an abstract class for date/time formatting subclasses which
formats and parses dates or time in a language-independent manner.
The date/time formatting subclass, such as SimpleDateFormat, allows for
formatting (i.e., date -> text), parsing (text -> date), and
normalization. The date is represented as a 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 locale 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
UFormat
,
NumberFormat
,
SimpleDateFormat
,
Calendar
,
GregorianCalendar
,
TimeZone
,
Serialized FormNested Class Summary | |
---|---|
static class |
DateFormat.Field
The instances of this inner class are used as attribute keys and values in AttributedCharacterIterator that DateFormat.formatToCharacterIterator() method returns. |
Field Summary | |
---|---|
static String |
ABBR_MONTH
[icu] Constant for date pattern with abbreviated month. |
static String |
ABBR_MONTH_DAY
[icu] Constant for date pattern with abbreviated month and day. |
static String |
ABBR_MONTH_WEEKDAY_DAY
[icu] Constant for date pattern with abbreviated month, weekday, and day. |
static String |
ABBR_STANDALONE_MONTH
[icu] Constant for date pattern with standalone abbreviated month. |
static int |
AM_PM_FIELD
FieldPosition selector for 'a' field alignment, corresponding to the 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 Calendar.DATE field. |
static String |
DAY
[icu] Constant for date pattern with day. |
static int |
DAY_OF_WEEK_FIELD
FieldPosition selector for 'E' field alignment, corresponding to the Calendar.DAY_OF_WEEK field. |
static int |
DAY_OF_WEEK_IN_MONTH_FIELD
FieldPosition selector for 'F' field alignment, corresponding to the Calendar.DAY_OF_WEEK_IN_MONTH field. |
static int |
DAY_OF_YEAR_FIELD
FieldPosition selector for 'D' field alignment, corresponding to the Calendar.DAY_OF_YEAR field. |
static int |
DEFAULT
Constant for default style pattern. |
static int |
DOW_LOCAL_FIELD
[icu] FieldPosition selector for 'e' field alignment, corresponding to the Calendar.DOW_LOCAL field. |
static int |
ERA_FIELD
FieldPosition selector for 'G' field alignment, corresponding to the Calendar.ERA field. |
static int |
EXTENDED_YEAR_FIELD
[icu] FieldPosition selector for 'u' field alignment, corresponding to the Calendar.EXTENDED_YEAR field. |
static int |
FIELD_COUNT
[icu] Number of FieldPosition selectors for DateFormat. |
static int |
FRACTIONAL_SECOND_FIELD
[icu] FieldPosition selector for 'S' field alignment, corresponding to the Calendar.MILLISECOND field. |
static int |
FULL
Constant for full style pattern. |
static String |
HOUR
[icu] Constant for date pattern with hour. |
static String |
HOUR_GENERIC_TZ
[icu] Constant for date pattern with hour and generic timezone. |
static String |
HOUR_MINUTE
[icu] Constant for date pattern with hour and minute. |
static String |
HOUR_MINUTE_GENERIC_TZ
[icu] Constant for date pattern with hour, minute, and generic timezone. |
static String |
HOUR_MINUTE_SECOND
[icu] Constant for date pattern with hour, minute, and second. |
static String |
HOUR_MINUTE_TZ
[icu] Constant for date pattern with hour, minute, and timezone. |
static int |
HOUR_OF_DAY0_FIELD
FieldPosition selector for 'H' field alignment, corresponding to the Calendar.HOUR_OF_DAY field. |
static int |
HOUR_OF_DAY1_FIELD
FieldPosition selector for 'k' field alignment, corresponding to the Calendar.HOUR_OF_DAY field. |
static String |
HOUR_TZ
[icu] Constant for date pattern with hour and timezone. |
static int |
HOUR0_FIELD
FieldPosition selector for 'K' field alignment, corresponding to the Calendar.HOUR field. |
static int |
HOUR1_FIELD
FieldPosition selector for 'h' field alignment, corresponding to the Calendar.HOUR field. |
static String |
HOUR24_MINUTE
[icu] Constant for date pattern with hour and minute in 24-hour presentation. |
static String |
HOUR24_MINUTE_SECOND
[icu] Constant for date pattern with hour, minute, and second in 24-hour presentation. |
static int |
JULIAN_DAY_FIELD
[icu] FieldPosition selector for 'g' field alignment, corresponding to the Calendar.JULIAN_DAY field. |
static int |
LONG
Constant for long style pattern. |
static int |
MEDIUM
Constant for medium style pattern. |
static int |
MILLISECOND_FIELD
Deprecated. ICU 3.0 use FRACTIONAL_SECOND_FIELD. |
static int |
MILLISECONDS_IN_DAY_FIELD
[icu] FieldPosition selector for 'A' field alignment, corresponding to the Calendar.MILLISECONDS_IN_DAY field. |
static int |
MINUTE_FIELD
FieldPosition selector for 'm' field alignment, corresponding to the Calendar.MINUTE field. |
static String |
MINUTE_SECOND
[icu] Constant for date pattern with minute and second. |
static String |
MONTH
[icu] Constant for date pattern with month. |
static String |
MONTH_DAY
[icu] Constant for date pattern having month and day. |
static int |
MONTH_FIELD
FieldPosition selector for 'M' field alignment, corresponding to the Calendar.MONTH field. |
static String |
MONTH_WEEKDAY_DAY
[icu] Constant for date pattern with month, weekday, and day. |
static int |
NONE
[icu] Constant for empty style pattern. |
static String |
NUM_MONTH
[icu] Constant for date pattern with numeric month. |
static String |
NUM_MONTH_DAY
[icu] Constant for date pattern with numeric month and day. |
static String |
NUM_MONTH_WEEKDAY_DAY
[icu] Constant for date pattern with numeric month, weekday, and day. |
protected NumberFormat |
numberFormat
The number formatter that DateFormat uses to format numbers
in dates and times. |
static int |
QUARTER_FIELD
[icu] FieldPosition selector for 'Q' field alignment, corresponding to the Calendar.MONTH field. |
static int |
RELATIVE
[icu] Constant for relative style mask. |
static int |
RELATIVE_DEFAULT
[icu] Constant for relative default style pattern. |
static int |
RELATIVE_FULL
[icu] Constant for relative full style pattern. |
static int |
RELATIVE_LONG
[icu] Constant for relative style pattern. |
static int |
RELATIVE_MEDIUM
[icu] Constant for relative style pattern. |
static int |
RELATIVE_SHORT
[icu] Constant for relative style pattern. |
static int |
SECOND_FIELD
FieldPosition selector for 's' field alignment, corresponding to the Calendar.SECOND field. |
static int |
SHORT
Constant for short style pattern. |
static int |
STANDALONE_DAY_FIELD
[icu] FieldPosition selector for 'c' field alignment, corresponding to the Calendar.DAY_OF_WEEK field. |
static String |
STANDALONE_MONTH
[icu] Constant for date pattern with standalone month. |
static int |
STANDALONE_MONTH_FIELD
[icu] FieldPosition selector for 'L' field alignment, corresponding to the Calendar.MONTH field. |
static int |
STANDALONE_QUARTER_FIELD
[icu] FieldPosition selector for 'q' field alignment, corresponding to the Calendar.MONTH field. |
static int |
TIMEZONE_FIELD
FieldPosition selector for 'z' field alignment, corresponding to the Calendar.ZONE_OFFSET and
Calendar.DST_OFFSET fields. |
static int |
TIMEZONE_GENERIC_FIELD
[icu] FieldPosition selector for 'v' field alignment, corresponding to the Calendar.ZONE_OFFSET and
Calendar.DST_OFFSET fields. |
static int |
TIMEZONE_RFC_FIELD
[icu] FieldPosition selector for 'Z' field alignment, corresponding to the Calendar.ZONE_OFFSET and
Calendar.DST_OFFSET fields. |
static int |
TIMEZONE_SPECIAL_FIELD
[icu] FieldPosition selector for 'V' field alignment, corresponding to the Calendar.ZONE_OFFSET and
Calendar.DST_OFFSET fields. |
static int |
WEEK_OF_MONTH_FIELD
FieldPosition selector for 'W' field alignment, corresponding to the Calendar.WEEK_OF_MONTH field. |
static int |
WEEK_OF_YEAR_FIELD
FieldPosition selector for 'w' field alignment, corresponding to the Calendar.WEEK_OF_YEAR field. |
static String |
YEAR
[icu] Constant for date pattern with year. |
static String |
YEAR_ABBR_MONTH
[icu] Constant for date pattern with year and abbreviated month. |
static String |
YEAR_ABBR_MONTH_DAY
[icu] Constant for date pattern with year, abbreviated month, and day. |
static String |
YEAR_ABBR_MONTH_WEEKDAY_DAY
[icu] Constant for date pattern with year, abbreviated month, weekday, and day. |
static String |
YEAR_ABBR_QUARTER
[icu] Constant for date pattern with year and abbreviated quarter. |
static int |
YEAR_FIELD
FieldPosition selector for 'y' field alignment, corresponding to the Calendar.YEAR field. |
static String |
YEAR_MONTH
[icu] Constant for date pattern with year and month. |
static String |
YEAR_MONTH_DAY
[icu] Constant for date pattern with year, month, and day. |
static String |
YEAR_MONTH_WEEKDAY_DAY
[icu] Constant for date pattern with year, month, weekday, and day. |
static String |
YEAR_NUM_MONTH
[icu] Constant for date pattern with year and numeric month. |
static String |
YEAR_NUM_MONTH_DAY
[icu] Constant for date pattern with year, numeric month, and day. |
static String |
YEAR_NUM_MONTH_WEEKDAY_DAY
[icu] Constant for date pattern with year, numeric month, weekday, and day. |
static String |
YEAR_QUARTER
[icu] Constant for date pattern with year and quarter. |
static int |
YEAR_WOY_FIELD
[icu] FieldPosition selector for 'Y' field alignment, corresponding to the Calendar.YEAR_WOY field. |
Constructor Summary | |
---|---|
protected |
DateFormat()
Creates a new date format. |
Method Summary | |
---|---|
Object |
clone()
Overrides clone. |
boolean |
equals(Object obj)
Overrides equals. |
abstract StringBuffer |
format(Calendar cal,
StringBuffer toAppendTo,
FieldPosition fieldPosition)
Formats a date into a date/time string. |
String |
format(Date date)
Formats a Date into a date/time string. |
StringBuffer |
format(Date date,
StringBuffer toAppendTo,
FieldPosition fieldPosition)
Formats a Date into a date/time string. |
StringBuffer |
format(Object obj,
StringBuffer toAppendTo,
FieldPosition fieldPosition)
Formats a time object into a time string. |
static Locale[] |
getAvailableLocales()
Returns the set of locales for which DateFormats are installed. |
static ULocale[] |
getAvailableULocales()
[icu] Returns the set of locales for which DateFormats are installed. |
Calendar |
getCalendar()
Returns the calendar associated with this date/time formatter. |
static DateFormat |
getDateInstance()
Returns the date formatter with the default formatting style for the default locale. |
static DateFormat |
getDateInstance(Calendar cal,
int dateStyle)
Convenience overload. |
static DateFormat |
getDateInstance(Calendar cal,
int dateStyle,
Locale locale)
Creates a 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)
Creates a DateFormat object that can be used to format dates in
the calendar system specified by cal . |
static DateFormat |
getDateInstance(int style)
Returns the date formatter with the given formatting style for the default locale. |
static DateFormat |
getDateInstance(int style,
Locale aLocale)
Returns the date formatter with the given formatting style for the given locale. |
static DateFormat |
getDateInstance(int style,
ULocale locale)
Returns the date formatter with the given formatting style for the given locale. |
static DateFormat |
getDateTimeInstance()
Returns the date/time formatter with the default formatting style for the default locale. |
static DateFormat |
getDateTimeInstance(Calendar cal,
int dateStyle,
int timeStyle)
Convenience overload. |
static DateFormat |
getDateTimeInstance(Calendar cal,
int dateStyle,
int timeStyle,
Locale locale)
Creates a 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)
Creates a DateFormat object that can be used to format dates and times in
the calendar system specified by cal . |
static DateFormat |
getDateTimeInstance(int dateStyle,
int timeStyle)
Returns 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)
Returns the date/time formatter with the given formatting styles for the given locale. |
static DateFormat |
getDateTimeInstance(int dateStyle,
int timeStyle,
ULocale locale)
Returns the date/time formatter with the given formatting styles for the given locale. |
static DateFormat |
getInstance()
Returns a default date/time formatter that uses the SHORT style for both the date and the time. |
static DateFormat |
getInstance(Calendar cal)
Convenience overload. |
static DateFormat |
getInstance(Calendar cal,
Locale locale)
Convenience overload. |
static DateFormat |
getInstance(Calendar cal,
ULocale locale)
Convenience overload. |
NumberFormat |
getNumberFormat()
Returns the number formatter which this date/time formatter uses to format and parse a time. |
static DateFormat |
getPatternInstance(Calendar cal,
String pattern,
Locale locale)
[icu] Convenience overload. |
static DateFormat |
getPatternInstance(Calendar cal,
String pattern,
ULocale locale)
[icu] Creates a DateFormat object that can be used to format dates and
times in the calendar system specified by cal . |
static DateFormat |
getPatternInstance(String pattern)
[icu] Convenience overload. |
static DateFormat |
getPatternInstance(String pattern,
Locale locale)
[icu] Convenience overload. |
static DateFormat |
getPatternInstance(String pattern,
ULocale locale)
[icu] Returns a DateFormat object that can be used to format dates and times in
the given locale. |
static DateFormat |
getTimeInstance()
Gets the time formatter with the default formatting style for the default locale. |
static DateFormat |
getTimeInstance(Calendar cal,
int timeStyle)
Convenience overload. |
static DateFormat |
getTimeInstance(Calendar cal,
int timeStyle,
Locale locale)
Creates a 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)
Creates a DateFormat object that can be used to format times in
the calendar system specified by cal . |
static DateFormat |
getTimeInstance(int style)
Returns the time formatter with the given formatting style for the default locale. |
static DateFormat |
getTimeInstance(int style,
Locale aLocale)
Returns the time formatter with the given formatting style for the given locale. |
static DateFormat |
getTimeInstance(int style,
ULocale locale)
Returns the time formatter with the given formatting style for the given locale. |
TimeZone |
getTimeZone()
Returns the time zone. |
int |
hashCode()
Overrides hashCode. |
boolean |
isLenient()
Returns whether date/time parsing is lenient. |
Date |
parse(String text)
Parses a date/time string. |
abstract void |
parse(String text,
Calendar cal,
ParsePosition pos)
Parses a date/time string according to the given parse position. |
Date |
parse(String text,
ParsePosition pos)
Parses a date/time string according to the given parse position. |
Object |
parseObject(String source,
ParsePosition pos)
Parses a date/time string into an Object. |
void |
setCalendar(Calendar newCalendar)
Sets the calendar to be used by this date format. |
void |
setLenient(boolean lenient)
Specifies whether date/time parsing is to be lenient. |
void |
setNumberFormat(NumberFormat newNumberFormat)
Sets the number formatter. |
void |
setTimeZone(TimeZone zone)
Sets the time zone for the calendar of this DateFormat object. |
Methods inherited from class com.ibm.icu.text.UFormat |
---|
getLocale |
Methods inherited from class java.text.Format |
---|
format, formatToCharacterIterator, parseObject |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected Calendar calendar
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
.
protected NumberFormat numberFormat
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
.
public static final int ERA_FIELD
Calendar.ERA
field.
public static final int YEAR_FIELD
Calendar.YEAR
field.
public static final int MONTH_FIELD
Calendar.MONTH
field.
public static final int DATE_FIELD
Calendar.DATE
field.
public static final int HOUR_OF_DAY1_FIELD
Calendar.HOUR_OF_DAY
field.
HOUR_OF_DAY1_FIELD is used for the one-based 24-hour clock.
For example, 23:59 + 01:00 results in 24:59.
public static final int HOUR_OF_DAY0_FIELD
Calendar.HOUR_OF_DAY
field.
HOUR_OF_DAY0_FIELD is used for the zero-based 24-hour clock.
For example, 23:59 + 01:00 results in 00:59.
public static final int MINUTE_FIELD
Calendar.MINUTE
field.
public static final int SECOND_FIELD
Calendar.SECOND
field.
public static final int FRACTIONAL_SECOND_FIELD
Calendar.MILLISECOND
field.
public static final int MILLISECOND_FIELD
public static final int DAY_OF_WEEK_FIELD
Calendar.DAY_OF_WEEK
field.
public static final int DAY_OF_YEAR_FIELD
Calendar.DAY_OF_YEAR
field.
public static final int DAY_OF_WEEK_IN_MONTH_FIELD
Calendar.DAY_OF_WEEK_IN_MONTH
field.
public static final int WEEK_OF_YEAR_FIELD
Calendar.WEEK_OF_YEAR
field.
public static final int WEEK_OF_MONTH_FIELD
Calendar.WEEK_OF_MONTH
field.
public static final int AM_PM_FIELD
Calendar.AM_PM
field.
public static final int HOUR1_FIELD
Calendar.HOUR
field.
HOUR1_FIELD is used for the one-based 12-hour clock.
For example, 11:30 PM + 1 hour results in 12:30 AM.
public static final int HOUR0_FIELD
Calendar.HOUR
field.
HOUR0_FIELD is used for the zero-based 12-hour clock.
For example, 11:30 PM + 1 hour results in 00:30 AM.
public static final int TIMEZONE_FIELD
Calendar.ZONE_OFFSET
and
Calendar.DST_OFFSET
fields.
public static final int YEAR_WOY_FIELD
Calendar.YEAR_WOY
field.
public static final int DOW_LOCAL_FIELD
Calendar.DOW_LOCAL
field.
public static final int EXTENDED_YEAR_FIELD
Calendar.EXTENDED_YEAR
field.
public static final int JULIAN_DAY_FIELD
Calendar.JULIAN_DAY
field.
public static final int MILLISECONDS_IN_DAY_FIELD
Calendar.MILLISECONDS_IN_DAY
field.
public static final int TIMEZONE_RFC_FIELD
Calendar.ZONE_OFFSET
and
Calendar.DST_OFFSET
fields.
public static final int TIMEZONE_GENERIC_FIELD
Calendar.ZONE_OFFSET
and
Calendar.DST_OFFSET
fields. This displays the generic zone
name, if available.
public static final int STANDALONE_DAY_FIELD
Calendar.DAY_OF_WEEK
field.
This displays the stand alone day name, if available.
public static final int STANDALONE_MONTH_FIELD
Calendar.MONTH
field.
This displays the stand alone month name, if available.
public static final int QUARTER_FIELD
Calendar.MONTH
field.
This displays the quarter.
public static final int STANDALONE_QUARTER_FIELD
Calendar.MONTH
field.
This displays the stand alone quarter, if available.
public static final int TIMEZONE_SPECIAL_FIELD
Calendar.ZONE_OFFSET
and
Calendar.DST_OFFSET
fields. This displays the fallback timezone
name when VVVV is specified, and the short standard or daylight
timezone name ignoring commonlyUsed when a single V is specified.
public static final int FIELD_COUNT
public static final int NONE
public static final int FULL
public static final int LONG
public static final int MEDIUM
public static final int SHORT
public static final int DEFAULT
public static final int RELATIVE
public static final int RELATIVE_FULL
public static final int RELATIVE_LONG
public static final int RELATIVE_MEDIUM
public static final int RELATIVE_SHORT
public static final int RELATIVE_DEFAULT
public static final String MINUTE_SECOND
public static final String HOUR24_MINUTE
public static final String HOUR24_MINUTE_SECOND
public static final String HOUR_MINUTE_SECOND
public static final String STANDALONE_MONTH
public static final String ABBR_STANDALONE_MONTH
public static final String YEAR_QUARTER
public static final String YEAR_ABBR_QUARTER
public static final String HOUR_MINUTE
public static final String YEAR
public static final String DAY
public static final String NUM_MONTH_WEEKDAY_DAY
public static final String YEAR_NUM_MONTH
public static final String NUM_MONTH_DAY
public static final String YEAR_NUM_MONTH_WEEKDAY_DAY
public static final String ABBR_MONTH_WEEKDAY_DAY
public static final String YEAR_MONTH
public static final String YEAR_ABBR_MONTH
public static final String MONTH_DAY
public static final String ABBR_MONTH_DAY
public static final String MONTH_WEEKDAY_DAY
public static final String YEAR_ABBR_MONTH_WEEKDAY_DAY
public static final String YEAR_MONTH_WEEKDAY_DAY
public static final String YEAR_MONTH_DAY
public static final String YEAR_ABBR_MONTH_DAY
public static final String YEAR_NUM_MONTH_DAY
public static final String NUM_MONTH
public static final String ABBR_MONTH
public static final String MONTH
public static final String HOUR_MINUTE_GENERIC_TZ
public static final String HOUR_MINUTE_TZ
public static final String HOUR
public static final String HOUR_GENERIC_TZ
public static final String HOUR_TZ
Constructor Detail |
---|
protected DateFormat()
Method Detail |
---|
public final StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition fieldPosition)
format
in class Format
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
occurrence 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 occurrence of the timezone
pattern character 'z'.
Format
public abstract StringBuffer format(Calendar cal, StringBuffer toAppendTo, FieldPosition fieldPosition)
cal
- a Calendar set to the date and time to be formatted
into a date/time string. When the calendar type is different from
the internal calendar held by this DateFormat instance, the date
and the time zone will be inherited from the input calendar, but
other calendar field values will be calculated by the internal calendar.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
occurrence 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 occurrence of the timezone
pattern character 'z'.
public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition)
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
occurrence 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 occurrence of the timezone
pattern character 'z'.
public final String format(Date date)
date
- the time value to be formatted into a time string.
public Date parse(String text) throws ParseException
text
- The date/time string to be parsed
ParseException
- If the given string cannot be parsed as a date.parse(String, ParsePosition)
public abstract void parse(String text, Calendar cal, ParsePosition pos)
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).
text
- The date/time string to be parsedcal
- 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. When the calendar type is different
from the internal calendar held by this DateFormat
instance, calendar field values will be parsed based
on the internal calendar initialized with the time and
the time zone taken from this calendar, then the
parse result (time in milliseconds and time zone) will
be set back to this calendar.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.setLenient(boolean)
public Date parse(String text, ParsePosition pos)
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).
text
- The date/time string to be parsedpos
- 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.
setLenient(boolean)
public Object parseObject(String source, ParsePosition pos)
parseObject
in class Format
parse(String, ParsePosition)
public static final DateFormat getTimeInstance()
public static final DateFormat getTimeInstance(int style)
style
- the given formatting style. For example,
SHORT for "h:mm a" in the US locale.
public static final DateFormat getTimeInstance(int style, Locale aLocale)
style
- the given formatting style. For example,
SHORT for "h:mm a" in the US locale.aLocale
- the given locale.
public static final DateFormat getTimeInstance(int style, ULocale locale)
style
- the given formatting style. For example,
SHORT for "h:mm a" in the US locale.locale
- the given ulocale.
public static final DateFormat getDateInstance()
public static final DateFormat getDateInstance(int style)
style
- the given formatting style. For example,
SHORT for "M/d/yy" in the US locale.
public static final DateFormat getDateInstance(int style, Locale aLocale)
style
- the given formatting style. For example,
SHORT for "M/d/yy" in the US locale.aLocale
- the given locale.
public static final DateFormat getDateInstance(int style, ULocale locale)
style
- the given formatting style. For example,
SHORT for "M/d/yy" in the US locale.locale
- the given ulocale.
public static final DateFormat getDateTimeInstance()
public static final DateFormat getDateTimeInstance(int dateStyle, int timeStyle)
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.
public static final DateFormat getDateTimeInstance(int dateStyle, int timeStyle, Locale aLocale)
dateStyle
- the given date formatting style.timeStyle
- the given time formatting style.aLocale
- the given locale.
public static final DateFormat getDateTimeInstance(int dateStyle, int timeStyle, ULocale locale)
dateStyle
- the given date formatting style.timeStyle
- the given time formatting style.locale
- the given ulocale.
public static final DateFormat getInstance()
public static Locale[] getAvailableLocales()
public static ULocale[] getAvailableULocales()
public void setCalendar(Calendar newCalendar)
newCalendar
- the new Calendar to be used by the date formatpublic Calendar getCalendar()
public void setNumberFormat(NumberFormat newNumberFormat)
newNumberFormat
- the given new NumberFormat.public NumberFormat getNumberFormat()
public void setTimeZone(TimeZone zone)
zone
- the given new time zone.public TimeZone getTimeZone()
public void setLenient(boolean lenient)
lenient
- when true, parsing is lenientCalendar.setLenient(boolean)
public boolean isLenient()
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
public Object clone()
clone
in class Format
public static final DateFormat getDateInstance(Calendar cal, int dateStyle, Locale locale)
DateFormat
object that can be used to format dates in
the calendar system specified by cal
.
cal
- The calendar system for which a date format is desired.dateStyle
- The type of date format desired. This can be
SHORT
, MEDIUM
,
etc.locale
- The locale for which the date format is desired.public static final DateFormat getDateInstance(Calendar cal, int dateStyle, ULocale locale)
DateFormat
object that can be used to format dates in
the calendar system specified by cal
.
cal
- The calendar system for which a date format is desired.dateStyle
- The type of date format desired. This can be
SHORT
, MEDIUM
,
etc.locale
- The locale for which the date format is desired.public static final DateFormat getTimeInstance(Calendar cal, int timeStyle, Locale locale)
DateFormat
object that can be used to format times in
the calendar system specified by cal
.
Note: When this functionality is moved into the core JDK, this method
will probably be replaced by a new overload of getInstance()
.
cal
- The calendar system for which a time format is desired.timeStyle
- The type of time format desired. This can be
SHORT
, MEDIUM
,
etc.locale
- The locale for which the time format is desired.getTimeInstance()
public static final DateFormat getTimeInstance(Calendar cal, int timeStyle, ULocale locale)
DateFormat
object that can be used to format times in
the calendar system specified by cal
.
Note: When this functionality is moved into the core JDK, this method
will probably be replaced by a new overload of getInstance()
.
cal
- The calendar system for which a time format is desired.timeStyle
- The type of time format desired. This can be
SHORT
, MEDIUM
,
etc.locale
- The locale for which the time format is desired.getTimeInstance()
public static final DateFormat getDateTimeInstance(Calendar cal, int dateStyle, int timeStyle, Locale locale)
DateFormat
object that can be used to format dates and times in
the calendar system specified by cal
.
Note: When this functionality is moved into the core JDK, this method
will probably be replaced by a new overload of getInstance()
.
cal
- The calendar system for which a date/time format is desired.dateStyle
- The type of date format desired. This can be
SHORT
, MEDIUM
,
etc.timeStyle
- The type of time format desired. This can be
SHORT
, MEDIUM
,
etc.locale
- The locale for which the date/time format is desired.getDateTimeInstance()
public static final DateFormat getDateTimeInstance(Calendar cal, int dateStyle, int timeStyle, ULocale locale)
DateFormat
object that can be used to format dates and times in
the calendar system specified by cal
.
Note: When this functionality is moved into the core JDK, this method
will probably be replaced by a new overload of getInstance()
.
cal
- The calendar system for which a date/time format is desired.dateStyle
- The type of date format desired. This can be
SHORT
, MEDIUM
,
etc.timeStyle
- The type of time format desired. This can be
SHORT
, MEDIUM
,
etc.locale
- The locale for which the date/time format is desired.getDateTimeInstance()
public static final DateFormat getInstance(Calendar cal, Locale locale)
public static final DateFormat getInstance(Calendar cal, ULocale locale)
public static final DateFormat getInstance(Calendar cal)
public static final DateFormat getDateInstance(Calendar cal, int dateStyle)
public static final DateFormat getTimeInstance(Calendar cal, int timeStyle)
public static final DateFormat getDateTimeInstance(Calendar cal, int dateStyle, int timeStyle)
public static final DateFormat getPatternInstance(String pattern)
public static final DateFormat getPatternInstance(String pattern, Locale locale)
public static final DateFormat getPatternInstance(String pattern, ULocale locale)
DateFormat
object that can be used to format dates and times in
the given locale.
Note: When this functionality is moved into the core JDK, this method
will probably be replaced by a new overload of getInstance()
.
pattern
- The pattern that selects the fields to be formatted. (Uses the
DateTimePatternGenerator
.) This can be ABBR_MONTH
,
MONTH_WEEKDAY_DAY
, etc.locale
- The locale for which the date/time format is desired.public static final DateFormat getPatternInstance(Calendar cal, String pattern, Locale locale)
public static final DateFormat getPatternInstance(Calendar cal, String pattern, ULocale locale)
DateFormat
object that can be used to format dates and
times in the calendar system specified by cal
.
Note: When this functionality is moved into the core JDK, this method
will probably be replaced by a new overload of getInstance()
.
cal
- The calendar system for which a date/time format is desired.pattern
- The pattern that selects the fields to be formatted. (Uses the
DateTimePatternGenerator
.) This can be
ABBR_MONTH
, MONTH_WEEKDAY_DAY
,
etc.locale
- The locale for which the date/time format is desired.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |