java.lang.Objectjava.text.Format
java.text.DateFormat
All Implemented Interfaces:
Cloneable, Serializable
Direct Known Subclasses:
SimpleDateFormat
Date
object or
as the milliseconds since January 1, 1970, 00:00:00 GMT.
{@code 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.
{@code 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 dates, 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 < myDate.length; ++i) { output.println(df.format(myDate[i]) + "; "); }
To format a date 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 {@code getDateInstance} to get the normal date format for that country. There are other static factory methods available. Use {@code getTimeInstance} to get the time format for that country. Use {@code 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 {@code 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 {@code 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
Date formats are not synchronized. It is recommended to create separate format instances for each thread. If multiple threads access a format concurrently, it must be synchronized externally.
Mark
- Davis, Chen-Lieh Huang, Alan LiuNested Class Summary: | ||
---|---|---|
public static class | DateFormat.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 | ||
---|---|---|
protected Calendar | calendar | The Calendar instance used for calculating the date-time fields
and the instant of time. This field is used for both formatting and
parsing.
Subclasses should initialize this field to a Calendar
appropriate for the Locale associated with this
|
protected NumberFormat | numberFormat | 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 .
|
public static final int | ERA_FIELD | Useful constant for ERA field alignment. Used in FieldPosition of date/time formatting. |
public static final int | YEAR_FIELD | Useful constant for YEAR field alignment. Used in FieldPosition of date/time formatting. |
public static final int | MONTH_FIELD | Useful constant for MONTH field alignment. Used in FieldPosition of date/time formatting. |
public static final int | DATE_FIELD | Useful constant for DATE field alignment. Used in FieldPosition of date/time formatting. |
public static final int | HOUR_OF_DAY1_FIELD | Useful constant for one-based HOUR_OF_DAY field alignment. Used in FieldPosition of date/time formatting. 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 | Useful constant for zero-based HOUR_OF_DAY field alignment. Used in FieldPosition of date/time formatting. 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 | Useful constant for MINUTE field alignment. Used in FieldPosition of date/time formatting. |
public static final int | SECOND_FIELD | Useful constant for SECOND field alignment. Used in FieldPosition of date/time formatting. |
public static final int | MILLISECOND_FIELD | Useful constant for MILLISECOND field alignment. Used in FieldPosition of date/time formatting. |
public static final int | DAY_OF_WEEK_FIELD | Useful constant for DAY_OF_WEEK field alignment. Used in FieldPosition of date/time formatting. |
public static final int | DAY_OF_YEAR_FIELD | Useful constant for DAY_OF_YEAR field alignment. Used in FieldPosition of date/time formatting. |
public static final int | DAY_OF_WEEK_IN_MONTH_FIELD | Useful constant for DAY_OF_WEEK_IN_MONTH field alignment. Used in FieldPosition of date/time formatting. |
public static final int | WEEK_OF_YEAR_FIELD | Useful constant for WEEK_OF_YEAR field alignment. Used in FieldPosition of date/time formatting. |
public static final int | WEEK_OF_MONTH_FIELD | Useful constant for WEEK_OF_MONTH field alignment. Used in FieldPosition of date/time formatting. |
public static final int | AM_PM_FIELD | Useful constant for AM_PM field alignment. Used in FieldPosition of date/time formatting. |
public static final int | HOUR1_FIELD | Useful constant for one-based HOUR field alignment. Used in FieldPosition of date/time formatting. 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 | Useful constant for zero-based HOUR field alignment. Used in FieldPosition of date/time formatting. 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 | Useful constant for TIMEZONE field alignment. Used in FieldPosition of date/time formatting. |
public static final int | FULL | Constant for full style pattern. |
public static final int | LONG | Constant for long style pattern. |
public static final int | MEDIUM | Constant for medium style pattern. |
public static final int | SHORT | Constant for short style pattern. |
public static final int | DEFAULT | Constant for default style pattern. Its value is MEDIUM. |
Constructor: |
---|
|
Method from java.text.DateFormat Summary: |
---|
clone, equals, format, format, format, getAvailableLocales, getCalendar, getDateInstance, getDateInstance, getDateInstance, getDateTimeInstance, getDateTimeInstance, getDateTimeInstance, getInstance, getNumberFormat, getTimeInstance, getTimeInstance, getTimeInstance, getTimeZone, hashCode, isLenient, parse, parse, parseObject, setCalendar, setLenient, setNumberFormat, setTimeZone |
Methods from java.text.Format: |
---|
clone, createAttributedCharacterIterator, createAttributedCharacterIterator, createAttributedCharacterIterator, createAttributedCharacterIterator, format, format, formatToCharacterIterator, parseObject, parseObject |
Methods from java.lang.Object: |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method from java.text.DateFormat Detail: |
---|
|
|
|
|
|
get*Instance methods of this class can return
localized instances.
The returned array represents the union of locales supported by the Java
runtime and by installed
DateFormatProvider implementations.
It must contain at least a Locale instance equal to
Locale.US . |
|
|
|
|
|
|
|
|
|
|
|
|
getCalendar().getTimeZone() |
|
getCalendar().isLenient() |
See the #parse(String, ParsePosition) method for more information on date parsing. |
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) . This parsing operation uses the #calendar to produce a {@code Date}. As a result, the {@code calendar}'s date-time fields and the {@code TimeZone} value may have been overwritten, depending on subclass implementations. Any {@code TimeZone} value that has previously been set by a call to setTimeZone may need to be restored for further operations. |
Date .
The method attempts to parse text starting at the index given by
See the #parse(String, ParsePosition) method for more information on date parsing. |
Any TimeZone and {@linkplain #isLenient() leniency} values that have previously been set are overwritten by {@code newCalendar}'s values. |
This method is equivalent to the following call. getCalendar().setLenient(lenient) This leniency value is overwritten by a call to setCalendar() . |
|
getCalendar().setTimeZone(zone) The {@code TimeZone} set by this method is overwritten by a setCalendar call. The {@code TimeZone} set by this method may be overwritten as a result of a call to the parse method. |