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 *
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
* @stable ICU 2.0
*/
protected Calendar calendar;
/**
* The number formatter that 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
* @stable ICU 2.0
*/
protected NumberFormat numberFormat;
/**
* FieldPosition selector for 'G' field alignment,
* corresponding to the {@link Calendar#ERA} field.
* @stable ICU 2.0
*/
public final static int ERA_FIELD = 0;
/**
* FieldPosition selector for 'y' field alignment,
* corresponding to the {@link Calendar#YEAR} field.
* @stable ICU 2.0
*/
public final static int YEAR_FIELD = 1;
/**
* FieldPosition selector for 'M' field alignment,
* corresponding to the {@link Calendar#MONTH} field.
* @stable ICU 2.0
*/
public final static int MONTH_FIELD = 2;
/**
* FieldPosition selector for 'd' field alignment,
* corresponding to the {@link Calendar#DATE} field.
* @stable ICU 2.0
*/
public final static int DATE_FIELD = 3;
/**
* FieldPosition selector for 'k' field alignment,
* corresponding to the {@link 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.
* @stable ICU 2.0
*/
public final static int HOUR_OF_DAY1_FIELD = 4;
/**
* FieldPosition selector for 'H' field alignment,
* corresponding to the {@link 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.
* @stable ICU 2.0
*/
public final static int HOUR_OF_DAY0_FIELD = 5;
/**
* FieldPosition selector for 'm' field alignment,
* corresponding to the {@link Calendar#MINUTE} field.
* @stable ICU 2.0
*/
public final static int MINUTE_FIELD = 6;
/**
* FieldPosition selector for 's' field alignment,
* corresponding to the {@link Calendar#SECOND} field.
* @stable ICU 2.0
*/
public final static int SECOND_FIELD = 7;
/**
* {@icu} FieldPosition selector for 'S' field alignment,
* corresponding to the {@link Calendar#MILLISECOND} field.
* @stable ICU 3.0
*/
public final static int FRACTIONAL_SECOND_FIELD = 8;
/**
* Alias for FRACTIONAL_SECOND_FIELD.
* @deprecated ICU 3.0 use FRACTIONAL_SECOND_FIELD.
*/
public final static int MILLISECOND_FIELD = FRACTIONAL_SECOND_FIELD;
/**
* FieldPosition selector for 'E' field alignment,
* corresponding to the {@link Calendar#DAY_OF_WEEK} field.
* @stable ICU 2.0
*/
public final static int DAY_OF_WEEK_FIELD = 9;
/**
* FieldPosition selector for 'D' field alignment,
* corresponding to the {@link Calendar#DAY_OF_YEAR} field.
* @stable ICU 2.0
*/
public final static int DAY_OF_YEAR_FIELD = 10;
/**
* FieldPosition selector for 'F' field alignment,
* corresponding to the {@link Calendar#DAY_OF_WEEK_IN_MONTH} field.
* @stable ICU 2.0
*/
public final static int DAY_OF_WEEK_IN_MONTH_FIELD = 11;
/**
* FieldPosition selector for 'w' field alignment,
* corresponding to the {@link Calendar#WEEK_OF_YEAR} field.
* @stable ICU 2.0
*/
public final static int WEEK_OF_YEAR_FIELD = 12;
/**
* FieldPosition selector for 'W' field alignment,
* corresponding to the {@link Calendar#WEEK_OF_MONTH} field.
* @stable ICU 2.0
*/
public final static int WEEK_OF_MONTH_FIELD = 13;
/**
* FieldPosition selector for 'a' field alignment,
* corresponding to the {@link Calendar#AM_PM} field.
* @stable ICU 2.0
*/
public final static int AM_PM_FIELD = 14;
/**
* FieldPosition selector for 'h' field alignment,
* corresponding to the {@link 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.
* @stable ICU 2.0
*/
public final static int HOUR1_FIELD = 15;
/**
* FieldPosition selector for 'K' field alignment,
* corresponding to the {@link 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.
* @stable ICU 2.0
*/
public final static int HOUR0_FIELD = 16;
/**
* FieldPosition selector for 'z' field alignment,
* corresponding to the {@link Calendar#ZONE_OFFSET} and
* {@link Calendar#DST_OFFSET} fields.
* @stable ICU 2.0
*/
public final static int TIMEZONE_FIELD = 17;
/**
* {@icu} FieldPosition selector for 'Y' field alignment,
* corresponding to the {@link Calendar#YEAR_WOY} field.
* @stable ICU 3.0
*/
public final static int YEAR_WOY_FIELD = 18;
/**
* {@icu} FieldPosition selector for 'e' field alignment,
* corresponding to the {@link Calendar#DOW_LOCAL} field.
* @stable ICU 3.0
*/
public final static int DOW_LOCAL_FIELD = 19;
/**
* {@icu} FieldPosition selector for 'u' field alignment,
* corresponding to the {@link Calendar#EXTENDED_YEAR} field.
* @stable ICU 3.0
*/
public final static int EXTENDED_YEAR_FIELD = 20;
/**
* {@icu} FieldPosition selector for 'g' field alignment,
* corresponding to the {@link Calendar#JULIAN_DAY} field.
* @stable ICU 3.0
*/
public final static int JULIAN_DAY_FIELD = 21;
/**
* {@icu} FieldPosition selector for 'A' field alignment,
* corresponding to the {@link Calendar#MILLISECONDS_IN_DAY} field.
* @stable ICU 3.0
*/
public final static int MILLISECONDS_IN_DAY_FIELD = 22;
/**
* {@icu} FieldPosition selector for 'Z' field alignment,
* corresponding to the {@link Calendar#ZONE_OFFSET} and
* {@link Calendar#DST_OFFSET} fields.
* @stable ICU 3.0
*/
public final static int TIMEZONE_RFC_FIELD = 23;
/**
* {@icu} FieldPosition selector for 'v' field alignment,
* corresponding to the {@link Calendar#ZONE_OFFSET} and
* {@link Calendar#DST_OFFSET} fields. This displays the generic zone
* name, if available.
* @stable ICU 3.4
*/
public final static int TIMEZONE_GENERIC_FIELD = 24;
/**
* {@icu} FieldPosition selector for 'c' field alignment,
* corresponding to the {@link Calendar#DAY_OF_WEEK} field.
* This displays the stand alone day name, if available.
* @stable ICU 3.4
*/
public final static int STANDALONE_DAY_FIELD = 25;
/**
* {@icu} FieldPosition selector for 'L' field alignment,
* corresponding to the {@link Calendar#MONTH} field.
* This displays the stand alone month name, if available.
* @stable ICU 3.4
*/
public final static int STANDALONE_MONTH_FIELD = 26;
/**
* {@icu} FieldPosition selector for 'Q' field alignment,
* corresponding to the {@link Calendar#MONTH} field.
* This displays the quarter.
* @stable ICU 3.6
*/
public final static int QUARTER_FIELD = 27;
/**
* {@icu} FieldPosition selector for 'q' field alignment,
* corresponding to the {@link Calendar#MONTH} field.
* This displays the stand alone quarter, if available.
* @stable ICU 3.6
*/
public final static int STANDALONE_QUARTER_FIELD = 28;
/**
* {@icu} FieldPosition selector for 'V' field alignment,
* corresponding to the {@link Calendar#ZONE_OFFSET} and
* {@link 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.
* @stable ICU 3.8
*/
public final static int TIMEZONE_SPECIAL_FIELD = 29;
/**
* {@icu} Number of FieldPosition selectors for DateFormat.
* Valid selectors range from 0 to FIELD_COUNT-1.
* @stable ICU 3.0
*/
public final static int FIELD_COUNT = 30; // must == DateFormatSymbols.patternChars.length()
// Proclaim serial compatibility with 1.1 FCS
private static final long serialVersionUID = 7218322306649953788L;
/**
* Formats a time object into a time string. Examples of time objects
* are a time value expressed in milliseconds and a Date object.
* @param obj must be a Number or a Date or a Calendar.
* @param toAppendTo the string buffer for the returning time string.
* @return the formatted time string.
* @param 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'.
* @see java.text.Format
* @stable ICU 2.0
*/
public final StringBuffer format(Object obj, StringBuffer toAppendTo,
FieldPosition fieldPosition)
{
if (obj instanceof Calendar)
return format( (Calendar)obj, toAppendTo, fieldPosition );
else if (obj instanceof Date)
return format( (Date)obj, toAppendTo, fieldPosition );
else if (obj instanceof Number)
return format( new Date(((Number)obj).longValue()),
toAppendTo, fieldPosition );
else
throw new IllegalArgumentException("Cannot format given Object (" +
obj.getClass().getName() + ") as a Date");
}
/**
* Formats a date into a date/time string.
* @param 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.
* @param toAppendTo the string buffer for the returning date/time string.
* @param 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'.
* @return the formatted date/time string.
* @stable ICU 2.0
*/
public abstract StringBuffer format(Calendar cal, StringBuffer toAppendTo,
FieldPosition fieldPosition);
/**
* Formats a Date into a date/time string.
* @param date a Date to be formatted into a date/time string.
* @param toAppendTo the string buffer for the returning date/time string.
* @param 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'.
* @return the formatted date/time string.
* @stable ICU 2.0
*/
public StringBuffer format(Date date, StringBuffer toAppendTo,
FieldPosition fieldPosition) {
// Use our Calendar object
calendar.setTime(date);
return format(calendar, toAppendTo, fieldPosition);
}
/**
* Formats a Date into a date/time string.
* @param date the time value to be formatted into a time string.
* @return the formatted time string.
* @stable ICU 2.0
*/
public final String format(Date date)
{
return format(date, new StringBuffer(64),new FieldPosition(0)).toString();
}
/**
* Parses a date/time string.
*
* @param text The date/time string to be parsed
*
* @return A Date, or null if the input could not be parsed
*
* @exception ParseException If the given string cannot be parsed as a date.
*
* @see #parse(String, ParsePosition)
* @stable ICU 2.0
*/
public Date parse(String text) throws ParseException
{
ParsePosition pos = new ParsePosition(0);
Date result = parse(text, pos);
if (pos.getIndex() == 0) // ICU4J
throw new ParseException("Unparseable date: \"" + text + "\"" ,
pos.getErrorIndex()); // ICU4J
return result;
}
/**
* Parses a date/time string according to the given parse position.
* For example, a time text "07/10/96 4:5 PM, PDT" will be parsed
* into a Calendar that is equivalent to Date(837039928046). The
* caller should clear the calendar before calling this method,
* unless existing field information is to be kept.
*
* 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). * * @see #setLenient(boolean) * * @param text The date/time string to be parsed * * @param 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. 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. * * @param 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. * @stable ICU 2.0 */ public abstract void parse(String text, Calendar cal, ParsePosition pos); /** * Parses a date/time string according to the given parse position. For * example, a time text "07/10/96 4:5 PM, PDT" will be parsed into a Date * that is equivalent to Date(837039928046). * *
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). * * @see #setLenient(boolean) * * @param text The date/time string to be parsed * * @param 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. * * @return A Date, or null if the input could not be parsed * @stable ICU 2.0 */ public Date parse(String text, ParsePosition pos) { Date result = null; int start = pos.getIndex(); TimeZone tzsav = calendar.getTimeZone(); calendar.clear(); parse(text, calendar, pos); if (pos.getIndex() != start) { try { result = calendar.getTime(); } catch (IllegalArgumentException e) { // This occurs if the calendar is non-lenient and there is // an out-of-range field. We don't know which field was // illegal so we set the error index to the start. pos.setIndex(start); pos.setErrorIndex(start); } } // Restore TimeZone calendar.setTimeZone(tzsav); return result; } /** * Parses a date/time string into an Object. This convenience method simply * calls parse(String, ParsePosition). * * @see #parse(String, ParsePosition) * @stable ICU 2.0 */ public Object parseObject (String source, ParsePosition pos) { return parse(source, pos); } /** * {@icu} Constant for empty style pattern. * @stable ICU 3.8 */ public static final int NONE = -1; /** * Constant for full style pattern. * @stable ICU 2.0 */ public static final int FULL = 0; /** * Constant for long style pattern. * @stable ICU 2.0 */ public static final int LONG = 1; /** * Constant for medium style pattern. * @stable ICU 2.0 */ public static final int MEDIUM = 2; /** * Constant for short style pattern. * @stable ICU 2.0 */ public static final int SHORT = 3; /** * Constant for default style pattern. Its value is MEDIUM. * @stable ICU 2.0 */ public static final int DEFAULT = MEDIUM; /** * {@icu} Constant for relative style mask. * @stable ICU 3.8 */ public static final int RELATIVE = (1 << 7); /** * {@icu} Constant for relative full style pattern. * @stable ICU 3.8 */ public static final int RELATIVE_FULL = RELATIVE | FULL; /** * {@icu} Constant for relative style pattern. * @stable ICU 3.8 */ public static final int RELATIVE_LONG = RELATIVE | LONG; /** * {@icu} Constant for relative style pattern. * @stable ICU 3.8 */ public static final int RELATIVE_MEDIUM = RELATIVE | MEDIUM; /** * {@icu} Constant for relative style pattern. * @stable ICU 3.8 */ public static final int RELATIVE_SHORT = RELATIVE | SHORT; /** * {@icu} Constant for relative default style pattern. * @stable ICU 3.8 */ public static final int RELATIVE_DEFAULT = RELATIVE | DEFAULT; /* Below are pre-defined skeletons * *
* A skeleton *
cal.
*
* @param cal The calendar system for which a date format is desired.
*
* @param dateStyle The type of date format desired. This can be
* {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM},
* etc.
*
* @param locale The locale for which the date format is desired.
* @stable ICU 2.0
*/
static final public DateFormat getDateInstance(Calendar cal, int dateStyle, Locale locale)
{
return getDateTimeInstance(cal, dateStyle, -1, ULocale.forLocale(locale));
}
/**
* Creates a {@link DateFormat} object that can be used to format dates in
* the calendar system specified by cal.
*
* @param cal The calendar system for which a date format is desired.
*
* @param dateStyle The type of date format desired. This can be
* {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM},
* etc.
*
* @param locale The locale for which the date format is desired.
* @stable ICU 3.2
*/
static final public DateFormat getDateInstance(Calendar cal, int dateStyle, ULocale locale)
{
return getDateTimeInstance(cal, dateStyle, -1, locale);
}
/**
* Creates a {@link 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 {@link DateFormat#getInstance}. *
* @param cal The calendar system for which a time format is desired.
*
* @param timeStyle The type of time format desired. This can be
* {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM},
* etc.
*
* @param locale The locale for which the time format is desired.
*
* @see DateFormat#getTimeInstance
* @stable ICU 2.0
*/
static final public DateFormat getTimeInstance(Calendar cal, int timeStyle, Locale locale)
{
return getDateTimeInstance(cal, -1, timeStyle, ULocale.forLocale(locale));
}
/**
* Creates a {@link 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 {@link DateFormat#getInstance}. *
* @param cal The calendar system for which a time format is desired.
*
* @param timeStyle The type of time format desired. This can be
* {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM},
* etc.
*
* @param locale The locale for which the time format is desired.
*
* @see DateFormat#getTimeInstance
* @stable ICU 3.2
*/
static final public DateFormat getTimeInstance(Calendar cal, int timeStyle, ULocale locale)
{
return getDateTimeInstance(cal, -1, timeStyle, locale);
}
/**
* Creates a {@link 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 {@link DateFormat#getInstance}. *
* @param cal The calendar system for which a date/time format is desired.
*
* @param dateStyle The type of date format desired. This can be
* {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM},
* etc.
*
* @param timeStyle The type of time format desired. This can be
* {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM},
* etc.
*
* @param locale The locale for which the date/time format is desired.
*
* @see DateFormat#getDateTimeInstance
* @stable ICU 2.0
*/
static final public DateFormat getDateTimeInstance(Calendar cal, int dateStyle,
int timeStyle, Locale locale)
{
return cal.getDateTimeFormat(dateStyle, timeStyle, ULocale.forLocale(locale));
}
/**
* Creates a {@link 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 {@link DateFormat#getInstance}. *
* @param cal The calendar system for which a date/time format is desired. * * @param dateStyle The type of date format desired. This can be * {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM}, * etc. * * @param timeStyle The type of time format desired. This can be * {@link DateFormat#SHORT}, {@link DateFormat#MEDIUM}, * etc. * * @param locale The locale for which the date/time format is desired. * * @see DateFormat#getDateTimeInstance * @stable ICU 3.2 */ static final public DateFormat getDateTimeInstance(Calendar cal, int dateStyle, int timeStyle, ULocale locale) { return cal.getDateTimeFormat(dateStyle, timeStyle, locale); } /** * Convenience overload. * @stable ICU 2.0 */ static final public DateFormat getInstance(Calendar cal, Locale locale) { return getDateTimeInstance(cal, SHORT, SHORT, ULocale.forLocale(locale)); } /** * Convenience overload. * @stable ICU 3.2 * @provisional This API might change or be removed in a future release. */ static final public DateFormat getInstance(Calendar cal, ULocale locale) { return getDateTimeInstance(cal, SHORT, SHORT, locale); } /** * Convenience overload. * @stable ICU 2.0 */ static final public DateFormat getInstance(Calendar cal) { return getInstance(cal, ULocale.getDefault()); } /** * Convenience overload. * @stable ICU 2.0 */ static final public DateFormat getDateInstance(Calendar cal, int dateStyle) { return getDateInstance(cal, dateStyle, ULocale.getDefault()); } /** * Convenience overload. * @stable ICU 2.0 */ static final public DateFormat getTimeInstance(Calendar cal, int timeStyle) { return getTimeInstance(cal, timeStyle, ULocale.getDefault()); } /** * Convenience overload. * @stable ICU 2.0 */ static final public DateFormat getDateTimeInstance(Calendar cal, int dateStyle, int timeStyle) { return getDateTimeInstance(cal, dateStyle, timeStyle, ULocale.getDefault()); } /** * {@icu} Convenience overload. * @stable ICU 4.0 */ public final static DateFormat getPatternInstance(String pattern) { return getPatternInstance(pattern, ULocale.getDefault()); } /** * {@icu} Convenience overload. * @stable ICU 4.0 */ public final static DateFormat getPatternInstance(String pattern, Locale locale) { return getPatternInstance(pattern, ULocale.forLocale(locale)); } /** * {@icu} Returns a {@link 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 {@link DateFormat#getInstance}. *
*
* @param pattern The pattern that selects the fields to be formatted. (Uses the
* {@link DateTimePatternGenerator}.) This can be {@link DateFormat#ABBR_MONTH},
* {@link DateFormat#MONTH_WEEKDAY_DAY}, etc.
*
* @param locale The locale for which the date/time format is desired.
*
* @stable ICU 4.0
*/
public final static DateFormat getPatternInstance(String pattern, ULocale locale) {
DateTimePatternGenerator generator = DateTimePatternGenerator.getInstance(locale);
final String bestPattern = generator.getBestPattern(pattern);
return new SimpleDateFormat(bestPattern, locale);
}
/**
* {@icu} Convenience overload.
* @stable ICU 4.0
*/
public final static DateFormat getPatternInstance(Calendar cal, String pattern, Locale locale) {
return getPatternInstance(cal, pattern, ULocale.forLocale(locale));
}
/**
* {@icu} Creates a {@link 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 {@link DateFormat#getInstance}. * * @param cal The calendar system for which a date/time format is desired. * * @param pattern The pattern that selects the fields to be formatted. (Uses the * {@link DateTimePatternGenerator}.) This can be * {@link DateFormat#ABBR_MONTH}, {@link DateFormat#MONTH_WEEKDAY_DAY}, * etc. * * @param locale The locale for which the date/time format is desired. * * @stable ICU 4.0 */ public final static DateFormat getPatternInstance( Calendar cal, String pattern, ULocale locale) { DateTimePatternGenerator generator = DateTimePatternGenerator.getInstance(locale); final String bestPattern = generator.getBestPattern(pattern); SimpleDateFormat format = new SimpleDateFormat(bestPattern, locale); format.setCalendar(cal); return format; } /** * The instances of this inner class are used as attribute keys and values * in AttributedCharacterIterator that * DateFormat.formatToCharacterIterator() method returns. * *
There is no public constructor to this class, the only instances are the * constants defined here. *
* @stable ICU 3.8
*/
public static class Field extends Format.Field {
private static final long serialVersionUID = -3627456821000730829L;
// Max number of calendar fields
private static final int CAL_FIELD_COUNT;
// Table for mapping calendar field number to DateFormat.Field
private static final Field[] CAL_FIELDS;
// Map for resolving DateFormat.Field by name
private static final MapDateFormat.Field with the given name and
* the Calendar field which this attribute represents. Use -1 for
* calendarField if this field does not have a corresponding
* Calendar field.
*
* @param name Name of the attribute
* @param calendarField Calendar field constant
*
* @stable ICU 3.8
*/
protected Field(String name, int calendarField) {
super(name);
this.calendarField = calendarField;
if (this.getClass() == DateFormat.Field.class) {
FIELD_NAME_MAP.put(name, this);
if (calendarField >= 0 && calendarField < CAL_FIELD_COUNT) {
CAL_FIELDS[calendarField] = this;
}
}
}
/**
* Returns the Field constant that corresponds to the
* Calendar field calendarField. If there is no
* corresponding Field is available, null is returned.
*
* @param calendarField Calendar field constant
* @return Field associated with the calendarField,
* or null if no associated Field is available.
* @throws IllegalArgumentException if calendarField is not
* a valid Calendar field constant.
*
* @stable ICU 3.8
*/
public static DateFormat.Field ofCalendarField(int calendarField) {
if (calendarField < 0 || calendarField >= CAL_FIELD_COUNT) {
throw new IllegalArgumentException("Calendar field number is out of range");
}
return CAL_FIELDS[calendarField];
}
/**
* Returns the Calendar field associated with this attribute.
* If there is no corresponding Calendar available, this will
* return -1.
*
* @return Calendar constant for this attribute.
*
* @stable ICU 3.8
*/
public int getCalendarField() {
return calendarField;
}
/**
* Resolves instances being deserialized to the predefined constants.
*
* @throws InvalidObjectException if the constant could not be resolved.
*
* @stable ICU 3.8
*/
protected Object readResolve() throws InvalidObjectException {
///CLOVER:OFF
if (this.getClass() != DateFormat.Field.class) {
throw new InvalidObjectException(
"A subclass of DateFormat.Field must implement readResolve.");
}
///CLOVER:ON
Object o = FIELD_NAME_MAP.get(this.getName());
///CLOVER:OFF
if (o == null) {
throw new InvalidObjectException("Unknown attribute name.");
}
///CLOVER:ON
return o;
}
}
}