java.text
public class: SimpleDateFormat [javadoc |
source]
java.lang.Object
java.text.Format
java.text.DateFormat
java.text.SimpleDateFormat
All Implemented Interfaces:
Cloneable, Serializable
SimpleDateFormat
is a concrete class for formatting and
parsing dates in a locale-sensitive manner. It allows for formatting
(date -> text), parsing (text -> date), and normalization.
SimpleDateFormat
allows you to start by choosing
any user-defined patterns for date-time formatting. However, you
are encouraged to create a date-time formatter with either
getTimeInstance
, getDateInstance
, or
getDateTimeInstance
in DateFormat
. Each
of these class methods can return a date/time formatter initialized
with a default format pattern. You may modify the format pattern
using the applyPattern
methods as desired.
For more information on using these methods, see
DateFormat .
Date and Time Patterns
Date and time formats are specified by date and time pattern
strings.
Within date and time pattern strings, unquoted letters from
'A'
to 'Z'
and from 'a'
to
'z'
are interpreted as pattern letters representing the
components of a date or time string.
Text can be quoted using single quotes ('
) to avoid
interpretation.
"''"
represents a single quote.
All other characters are not interpreted; they're simply copied into the
output string during formatting or matched against the input string
during parsing.
The following pattern letters are defined (all other characters from
'A'
to 'Z'
and from 'a'
to
'z'
are reserved):
Pattern letters are usually repeated, as their number determines the
exact presentation:
- Text:
For formatting, if the number of pattern letters is 4 or more,
the full form is used; otherwise a short or abbreviated form
is used if available.
For parsing, both forms are accepted, independent of the number
of pattern letters.
- Number:
For formatting, the number of pattern letters is the minimum
number of digits, and shorter numbers are zero-padded to this amount.
For parsing, the number of pattern letters is ignored unless
it's needed to separate two adjacent fields.
- Year:
If the formatter's Calendar is the Gregorian
calendar, the following rules are applied.
- For formatting, if the number of pattern letters is 2, the year
is truncated to 2 digits; otherwise it is interpreted as a
number.
- For parsing, if the number of pattern letters is more than 2,
the year is interpreted literally, regardless of the number of
digits. So using the pattern "MM/dd/yyyy", "01/11/12" parses to
Jan 11, 12 A.D.
- For parsing with the abbreviated year pattern ("y" or "yy"),
SimpleDateFormat
must interpret the abbreviated year
relative to some century. It does this by adjusting dates to be
within 80 years before and 20 years after the time the SimpleDateFormat
instance is created. For example, using a pattern of "MM/dd/yy" and a
SimpleDateFormat
instance created on Jan 1, 1997, the string
"01/11/12" would be interpreted as Jan 11, 2012 while the string "05/04/64"
would be interpreted as May 4, 1964.
During parsing, only strings consisting of exactly two digits, as defined by
Character#isDigit(char) , will be parsed into the default century.
Any other numeric string, such as a one digit string, a three or more digit
string, or a two digit string that isn't all digits (for example, "-1"), is
interpreted literally. So "01/02/3" or "01/02/003" are parsed, using the
same pattern, as Jan 2, 3 AD. Likewise, "01/02/-3" is parsed as Jan 2, 4 BC.
Otherwise, calendar system specific forms are applied.
For both formatting and parsing, if the number of pattern
letters is 4 or more, a calendar specific {@linkplain
Calendar#LONG long form} is used. Otherwise, a calendar
specific {@linkplain Calendar#SHORT short or abbreviated form}
is used.
If week year {@code 'Y'} is specified and the {@linkplain
#getCalendar() calendar} doesn't support any week
years, the calendar year ({@code 'y'}) is used instead. The
support of week years can be tested with a call to getCalendar() .isWeekDateSupported() .
- Month:
If the number of pattern letters is 3 or more, the month is
interpreted as text; otherwise,
it is interpreted as a number.
- General time zone:
Time zones are interpreted as text if they have
names. For time zones representing a GMT offset value, the
following syntax is used:
GMTOffsetTimeZone:
GMT
Sign Hours :
Minutes
Sign: one of
+ -
Hours:
Digit
Digit Digit
Minutes:
Digit Digit
Digit: one of
0 1 2 3 4 5 6 7 8 9
Hours must be between 0 and 23, and Minutes must be between
00 and 59. The format is locale independent and digits must be taken
from the Basic Latin block of the Unicode standard.
For parsing, RFC 822 time zones are also
accepted.
- RFC 822 time zone:
For formatting, the RFC 822 4-digit time zone format is used:
RFC822TimeZone:
Sign TwoDigitHours Minutes
TwoDigitHours:
Digit Digit
TwoDigitHours must be between 00 and 23. Other definitions
are as for general time zones.
For parsing, general time zones are also
accepted.
- ISO 8601 Time zone:
The number of pattern letters designates the format for both formatting
and parsing as follows:
ISO8601TimeZone:
OneLetterISO8601TimeZone
TwoLetterISO8601TimeZone
ThreeLetterISO8601TimeZone
OneLetterISO8601TimeZone:
Sign TwoDigitHours
{@code Z}
TwoLetterISO8601TimeZone:
Sign TwoDigitHours Minutes
{@code Z}
ThreeLetterISO8601TimeZone:
Sign TwoDigitHours {@code :} Minutes
{@code Z}
Other definitions are as for general time zones or
RFC 822 time zones.
For formatting, if the offset value from GMT is 0, {@code "Z"} is
produced. If the number of pattern letters is 1, any fraction of an hour
is ignored. For example, if the pattern is {@code "X"} and the time zone is
{@code "GMT+05:30"}, {@code "+05"} is produced.
For parsing, {@code "Z"} is parsed as the UTC time zone designator.
General time zones are not accepted.
If the number of pattern letters is 4 or more, IllegalArgumentException is thrown when constructing a {@code
SimpleDateFormat} or {@linkplain #applyPattern(String) applying a
pattern}.
SimpleDateFormat
also supports
localized date and time
pattern strings. In these strings, the pattern letters described above
may be replaced with other, locale dependent, pattern letters.
SimpleDateFormat
does not deal with the localization of text
other than the pattern letters; that's up to the client of the class.
Examples
The following examples show how date and time patterns are interpreted in
the U.S. locale. The given date and time are 2001-07-04 12:08:56 local time
in the U.S. Pacific Time time zone.
Date and Time Pattern
| Result
|
"yyyy.MM.dd G 'at' HH:mm:ss z"
| 2001.07.04 AD at 12:08:56 PDT
|
"EEE, MMM d, ''yy"
| Wed, Jul 4, '01
|
"h:mm a"
| 12:08 PM
|
"hh 'o''clock' a, zzzz"
| 12 o'clock PM, Pacific Daylight Time
|
"K:mm a, z"
| 0:08 PM, PDT
|
"yyyyy.MMMMM.dd GGG hh:mm aaa"
| 02001.July.04 AD 12:08 PM
|
"EEE, d MMM yyyy HH:mm:ss Z"
| Wed, 4 Jul 2001 12:08:56 -0700
|
"yyMMddHHmmssZ"
| 010704120856-0700
|
"yyyy-MM-dd'T'HH:mm:ss.SSSZ"
| 2001-07-04T12:08:56.235-0700
|
"yyyy-MM-dd'T'HH:mm:ss.SSSXXX"
| 2001-07-04T12:08:56.235-07:00
|
"YYYY-'W'ww-u"
| 2001-W27-3
|
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.
Field Summary |
---|
static final long | serialVersionUID | |
static final int | currentSerialVersion | |
transient boolean | useDateFormatSymbols | Indicates whether this SimpleDateFormat should use
the DateFormatSymbols. If true, the format and parse methods
use the DateFormatSymbols values. If false, the format and
parse methods call Calendar.getDisplayName or
Calendar.getDisplayNames. |
Fields inherited from java.text.DateFormat: |
---|
calendar, numberFormat, ERA_FIELD, YEAR_FIELD, MONTH_FIELD, DATE_FIELD, HOUR_OF_DAY1_FIELD, HOUR_OF_DAY0_FIELD, MINUTE_FIELD, SECOND_FIELD, MILLISECOND_FIELD, DAY_OF_WEEK_FIELD, DAY_OF_YEAR_FIELD, DAY_OF_WEEK_IN_MONTH_FIELD, WEEK_OF_YEAR_FIELD, WEEK_OF_MONTH_FIELD, AM_PM_FIELD, HOUR1_FIELD, HOUR0_FIELD, TIMEZONE_FIELD, FULL, LONG, MEDIUM, SHORT, DEFAULT |
Constructor: |
public SimpleDateFormat() {
this(SHORT, SHORT, Locale.getDefault(Locale.Category.FORMAT));
}
Constructs a SimpleDateFormat using the default pattern and
date format symbols for the default locale.
Note: This constructor may not support all locales.
For full coverage, use the factory methods in the DateFormat
class. |
public SimpleDateFormat(String pattern) {
this(pattern, Locale.getDefault(Locale.Category.FORMAT));
}
Constructs a SimpleDateFormat using the given pattern and
the default date format symbols for the default locale.
Note: This constructor may not support all locales.
For full coverage, use the factory methods in the DateFormat
class. Parameters:
pattern - the pattern describing the date and time format
Throws:
NullPointerException - if the given pattern is null
IllegalArgumentException - if the given pattern is invalid
- exception:
NullPointerException - if the given pattern is null
- exception:
IllegalArgumentException - if the given pattern is invalid
|
public SimpleDateFormat(String pattern,
Locale locale) {
if (pattern == null || locale == null) {
throw new NullPointerException();
}
initializeCalendar(locale);
this.pattern = pattern;
this.formatData = DateFormatSymbols.getInstanceRef(locale);
this.locale = locale;
initialize(locale);
}
Constructs a SimpleDateFormat using the given pattern and
the default date format symbols for the given locale.
Note: This constructor may not support all locales.
For full coverage, use the factory methods in the DateFormat
class. Parameters:
pattern - the pattern describing the date and time format
locale - the locale whose date format symbols should be used
Throws:
NullPointerException - if the given pattern or locale is null
IllegalArgumentException - if the given pattern is invalid
- exception:
NullPointerException - if the given pattern or locale is null
- exception:
IllegalArgumentException - if the given pattern is invalid
|
public SimpleDateFormat(String pattern,
DateFormatSymbols formatSymbols) {
if (pattern == null || formatSymbols == null) {
throw new NullPointerException();
}
this.pattern = pattern;
this.formatData = (DateFormatSymbols) formatSymbols.clone();
this.locale = Locale.getDefault(Locale.Category.FORMAT);
initializeCalendar(this.locale);
initialize(this.locale);
useDateFormatSymbols = true;
}
Constructs a SimpleDateFormat using the given pattern and
date format symbols. Parameters:
pattern - the pattern describing the date and time format
formatSymbols - the date format symbols to be used for formatting
Throws:
NullPointerException - if the given pattern or formatSymbols is null
IllegalArgumentException - if the given pattern is invalid
- exception:
NullPointerException - if the given pattern or formatSymbols is null
- exception:
IllegalArgumentException - if the given pattern is invalid
|
SimpleDateFormat(int timeStyle,
int dateStyle,
Locale loc) {
if (loc == null) {
throw new NullPointerException();
}
this.locale = loc;
// initialize calendar and related fields
initializeCalendar(loc);
/* try the cache first */
String[] dateTimePatterns = cachedLocaleData.get(loc);
if (dateTimePatterns == null) { /* cache miss */
ResourceBundle r = LocaleData.getDateFormatData(loc);
if (!isGregorianCalendar()) {
try {
dateTimePatterns = r.getStringArray(getCalendarName() + ".DateTimePatterns");
} catch (MissingResourceException e) {
}
}
if (dateTimePatterns == null) {
dateTimePatterns = r.getStringArray("DateTimePatterns");
}
/* update cache */
cachedLocaleData.putIfAbsent(loc, dateTimePatterns);
}
formatData = DateFormatSymbols.getInstanceRef(loc);
if ((timeStyle >= 0) && (dateStyle >= 0)) {
Object[] dateTimeArgs = {dateTimePatterns[timeStyle],
dateTimePatterns[dateStyle + 4]};
pattern = MessageFormat.format(dateTimePatterns[8], dateTimeArgs);
}
else if (timeStyle >= 0) {
pattern = dateTimePatterns[timeStyle];
}
else if (dateStyle >= 0) {
pattern = dateTimePatterns[dateStyle + 4];
}
else {
throw new IllegalArgumentException("No date or time style specified");
}
initialize(loc);
}
|
Method from java.text.SimpleDateFormat Summary: |
---|
applyLocalizedPattern, applyPattern, clone, equals, format, formatToCharacterIterator, get2DigitYearStart, getDateFormatSymbols, hashCode, parse, set2DigitYearStart, setDateFormatSymbols, toLocalizedPattern, toPattern |
Methods from java.text.DateFormat: |
---|
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.lang.Object: |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method from java.text.SimpleDateFormat Detail: |
public void applyLocalizedPattern(String pattern) {
String p = translatePattern(pattern,
formatData.getLocalPatternChars(),
DateFormatSymbols.patternChars);
compiledPattern = compile(p);
this.pattern = p;
}
Applies the given localized pattern string to this date format. |
public void applyPattern(String pattern) {
compiledPattern = compile(pattern);
this.pattern = pattern;
}
Applies the given pattern string to this date format. |
public Object clone() {
SimpleDateFormat other = (SimpleDateFormat) super.clone();
other.formatData = (DateFormatSymbols) formatData.clone();
return other;
}
Creates a copy of this SimpleDateFormat . This also
clones the format's date format symbols. |
public boolean equals(Object obj) {
if (!super.equals(obj)) return false; // super does class check
SimpleDateFormat that = (SimpleDateFormat) obj;
return (pattern.equals(that.pattern)
&& formatData.equals(that.formatData));
}
Compares the given object with this SimpleDateFormat for
equality. |
public StringBuffer format(Date date,
StringBuffer toAppendTo,
FieldPosition pos) {
pos.beginIndex = pos.endIndex = 0;
return format(date, toAppendTo, pos.getFieldDelegate());
}
Formats the given Date into a date/time string and appends
the result to the given StringBuffer . |
public AttributedCharacterIterator formatToCharacterIterator(Object obj) {
StringBuffer sb = new StringBuffer();
CharacterIteratorFieldDelegate delegate = new
CharacterIteratorFieldDelegate();
if (obj instanceof Date) {
format((Date)obj, sb, delegate);
}
else if (obj instanceof Number) {
format(new Date(((Number)obj).longValue()), sb, delegate);
}
else if (obj == null) {
throw new NullPointerException(
"formatToCharacterIterator must be passed non-null object");
}
else {
throw new IllegalArgumentException(
"Cannot format given Object as a Date");
}
return delegate.getIterator(sb.toString());
}
Formats an Object producing an AttributedCharacterIterator .
You can use the returned AttributedCharacterIterator
to build the resulting String, as well as to determine information
about the resulting String.
Each attribute key of the AttributedCharacterIterator will be of type
DateFormat.Field , with the corresponding attribute value
being the same as the attribute key. |
public Date get2DigitYearStart() {
return (Date) defaultCenturyStart.clone();
}
Returns the beginning date of the 100-year period 2-digit years are interpreted
as being within. |
public DateFormatSymbols getDateFormatSymbols() {
return (DateFormatSymbols)formatData.clone();
}
Gets a copy of the date and time format symbols of this date format. |
public int hashCode() {
return pattern.hashCode();
// just enough fields for a reasonable distribution
}
Returns the hash code value for this SimpleDateFormat object. |
public Date parse(String text,
ParsePosition pos) {
checkNegativeNumberExpression();
int start = pos.index;
int oldStart = start;
int textLength = text.length();
boolean[] ambiguousYear = {false};
CalendarBuilder calb = new CalendarBuilder();
for (int i = 0; i < compiledPattern.length; ) {
int tag = compiledPattern[i] > > > 8;
int count = compiledPattern[i++] & 0xff;
if (count == 255) {
count = compiledPattern[i++] < < 16;
count |= compiledPattern[i++];
}
switch (tag) {
case TAG_QUOTE_ASCII_CHAR:
if (start >= textLength || text.charAt(start) != (char)count) {
pos.index = oldStart;
pos.errorIndex = start;
return null;
}
start++;
break;
case TAG_QUOTE_CHARS:
while (count-- > 0) {
if (start >= textLength || text.charAt(start) != compiledPattern[i++]) {
pos.index = oldStart;
pos.errorIndex = start;
return null;
}
start++;
}
break;
default:
// Peek the next pattern to determine if we need to
// obey the number of pattern letters for
// parsing. It's required when parsing contiguous
// digit text (e.g., "20010704") with a pattern which
// has no delimiters between fields, like "yyyyMMdd".
boolean obeyCount = false;
// In Arabic, a minus sign for a negative number is put after
// the number. Even in another locale, a minus sign can be
// put after a number using DateFormat.setNumberFormat().
// If both the minus sign and the field-delimiter are '-',
// subParse() needs to determine whether a '-' after a number
// in the given text is a delimiter or is a minus sign for the
// preceding number. We give subParse() a clue based on the
// information in compiledPattern.
boolean useFollowingMinusSignAsDelimiter = false;
if (i < compiledPattern.length) {
int nextTag = compiledPattern[i] > > > 8;
if (!(nextTag == TAG_QUOTE_ASCII_CHAR ||
nextTag == TAG_QUOTE_CHARS)) {
obeyCount = true;
}
if (hasFollowingMinusSign &&
(nextTag == TAG_QUOTE_ASCII_CHAR ||
nextTag == TAG_QUOTE_CHARS)) {
int c;
if (nextTag == TAG_QUOTE_ASCII_CHAR) {
c = compiledPattern[i] & 0xff;
} else {
c = compiledPattern[i+1];
}
if (c == minusSign) {
useFollowingMinusSignAsDelimiter = true;
}
}
}
start = subParse(text, start, tag, count, obeyCount,
ambiguousYear, pos,
useFollowingMinusSignAsDelimiter, calb);
if (start < 0) {
pos.index = oldStart;
return null;
}
}
}
// At this point the fields of Calendar have been set. Calendar
// will fill in default values for missing fields when the time
// is computed.
pos.index = start;
Date parsedDate;
try {
parsedDate = calb.establish(calendar).getTime();
// If the year value is ambiguous,
// then the two-digit year == the default start year
if (ambiguousYear[0]) {
if (parsedDate.before(defaultCenturyStart)) {
parsedDate = calb.addYear(100).establish(calendar).getTime();
}
}
}
// An IllegalArgumentException will be thrown by Calendar.getTime()
// if any fields are out of range, e.g., MONTH == 17.
catch (IllegalArgumentException e) {
pos.errorIndex = start;
pos.index = oldStart;
return null;
}
return parsedDate;
}
Parses text from a string to produce a Date .
The method attempts to parse text starting at the index given by
pos .
If parsing succeeds, then the index of pos is updated
to the index after the last character used (parsing does not necessarily
use all characters up to the end of the string), and the parsed
date is returned. The updated pos can be used to
indicate the starting point for the next call to this method.
If an error occurs, then the index of pos is not
changed, the error index of pos is set to the index of
the character where the error occurred, and null is returned.
This parsing operation uses the
calendar to produce a {@code Date}. All of the {@code
calendar}'s date-time fields are {@linkplain Calendar#clear()
cleared} before parsing, and the {@code calendar}'s default
values of the date-time fields are used for any missing
date-time information. For example, the year value of the
parsed {@code Date} is 1970 with GregorianCalendar if
no year value is given from the parsing operation. The {@code
TimeZone} value may be overwritten, depending on the given
pattern and the time zone value in {@code text}. Any {@code
TimeZone} value that has previously been set by a call to
setTimeZone may need
to be restored for further operations. |
public void set2DigitYearStart(Date startDate) {
parseAmbiguousDatesAsAfter(new Date(startDate.getTime()));
}
Sets the 100-year period 2-digit years will be interpreted as being in
to begin on the date the user specifies. |
public void setDateFormatSymbols(DateFormatSymbols newFormatSymbols) {
this.formatData = (DateFormatSymbols)newFormatSymbols.clone();
useDateFormatSymbols = true;
}
Sets the date and time format symbols of this date format. |
public String toLocalizedPattern() {
return translatePattern(pattern,
DateFormatSymbols.patternChars,
formatData.getLocalPatternChars());
}
Returns a localized pattern string describing this date format. |
public String toPattern() {
return pattern;
}
Returns a pattern string describing this date format. |