/*
* Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* (C) Copyright Taligent, Inc. 1996 - All Rights Reserved
* (C) Copyright IBM Corp. 1996-1998 - All Rights Reserved
*
* The original version of this source code and documentation is copyrighted
* and owned by Taligent, Inc., a wholly-owned subsidiary of IBM. These
* materials are provided under terms of a License Agreement between Taligent
* and Sun. This technology is protected by multiple US and International
* patents. This notice and attribution to Taligent may not be removed.
* Taligent is a registered trademark of Taligent, Inc.
*
*/
package java.text;
import java.io.IOException;
import java.io.InvalidObjectException;
import java.io.ObjectInputStream;
import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.Locale;
import java.util.Map;
import java.util.MissingResourceException;
import java.util.ResourceBundle;
import java.util.SimpleTimeZone;
import java.util.TimeZone;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import sun.util.calendar.CalendarUtils;
import sun.util.calendar.ZoneInfoFile;
import sun.util.resources.LocaleData;
import static java.text.DateFormatSymbols.*;
/**
* 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
* {@link DateFormat}.
*
*
* 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: **
** Letter * Date or Time Component * Presentation * Examples * * G
*Era designator * Text * AD
** y
*Year * Year * 1996
;96
** Y
*Week year * Year * 2009
;09
** M
*Month in year * Month * July
;Jul
;07
** w
*Week in year * Number * 27
** W
*Week in month * Number * 2
** D
*Day in year * Number * 189
** d
*Day in month * Number * 10
** F
*Day of week in month * Number * 2
** E
*Day name in week * Text * Tuesday
;Tue
** u
*Day number of week (1 = Monday, ..., 7 = Sunday) * Number * 1
** a
*Am/pm marker * Text * PM
** H
*Hour in day (0-23) * Number * 0
** k
*Hour in day (1-24) * Number * 24
** K
*Hour in am/pm (0-11) * Number * 0
** h
*Hour in am/pm (1-12) * Number * 12
** m
*Minute in hour * Number * 30
** s
*Second in minute * Number * 55
** S
*Millisecond * Number * 978
** z
*Time zone * General time zone * Pacific Standard Time
;PST
;GMT-08:00
** Z
*Time zone * RFC 822 time zone * -0800
** X
*Time zone * ISO 8601 time zone * -08
;-0800
;-08:00
*
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
* {@link 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.
* * GMTOffsetTimeZone: ** 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. *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
For parsing, RFC 822 time zones are also
* accepted.
* 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. *
* 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, {@link * 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.
* * *
** **
** 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. * * @see Java Tutorial * @see java.util.Calendar * @see java.util.TimeZone * @see DateFormat * @see DateFormatSymbols * @author Mark Davis, Chen-Lieh Huang, Alan Liu */ public class SimpleDateFormat extends DateFormat { // the official serial version ID which says cryptically // which version we're compatible with static final long serialVersionUID = 4774881970558875024L; // the internal serial version which says which version was written // - 0 (default) for version up to JDK 1.1.3 // - 1 for version from JDK 1.1.4, which includes a new field static final int currentSerialVersion = 1; /** * The version of the serialized data on the stream. Possible values: *
defaultCenturyStart
on stream.
* defaultCenturyStart
.
* serialVersionOnStream
* is written.
* @serial
* @since JDK1.1.4
*/
private int serialVersionOnStream = currentSerialVersion;
/**
* The pattern string of this formatter. This is always a non-localized
* pattern. May not be null. See class documentation for details.
* @serial
*/
private String pattern;
/**
* Saved numberFormat and pattern.
* @see SimpleDateFormat#checkNegativeNumberExpression
*/
transient private NumberFormat originalNumberFormat;
transient private String originalNumberPattern;
/**
* The minus sign to be used with format and parse.
*/
transient private char minusSign = '-';
/**
* True when a negative sign follows a number.
* (True as default in Arabic.)
*/
transient private boolean hasFollowingMinusSign = false;
/**
* The compiled pattern.
*/
transient private char[] compiledPattern;
/**
* Tags for the compiled pattern.
*/
private final static int TAG_QUOTE_ASCII_CHAR = 100;
private final static int TAG_QUOTE_CHARS = 101;
/**
* Locale dependent digit zero.
* @see #zeroPaddingNumber
* @see java.text.DecimalFormatSymbols#getZeroDigit
*/
transient private char zeroDigit;
/**
* The symbols used by this formatter for week names, month names,
* etc. May not be null.
* @serial
* @see java.text.DateFormatSymbols
*/
private DateFormatSymbols formatData;
/**
* We map dates with two-digit years into the century starting at
* defaultCenturyStart
, which may be any date. May
* not be null.
* @serial
* @since JDK1.1.4
*/
private Date defaultCenturyStart;
transient private int defaultCenturyStartYear;
private static final int MILLIS_PER_MINUTE = 60 * 1000;
// For time zones that have no names, use strings GMT+minutes and
// GMT-minutes. For instance, in France the time zone is GMT+60.
private static final String GMT = "GMT";
/**
* Cache to hold the DateTimePatterns of a Locale.
*/
private static final ConcurrentMapSimpleDateFormat
. The value may be null if this object
* has been created by an older SimpleDateFormat
and
* deserialized.
*
* @serial
* @since 1.6
*/
private Locale locale;
/**
* 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.
*/
transient boolean useDateFormatSymbols;
/**
* 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 {@link DateFormat}
* class.
*/
public SimpleDateFormat() {
this(SHORT, SHORT, 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 {@link DateFormat}
* class.
*
* @param pattern the pattern describing the date and time format
* @exception NullPointerException if the given pattern is null
* @exception IllegalArgumentException if the given pattern is invalid
*/
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 given locale.
* Note: This constructor may not support all locales.
* For full coverage, use the factory methods in the {@link DateFormat}
* class.
*
* @param pattern the pattern describing the date and time format
* @param locale the locale whose date format symbols should be used
* @exception NullPointerException if the given pattern or locale 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
* date format symbols.
*
* @param pattern the pattern describing the date and time format
* @param formatSymbols the date format symbols to be used for formatting
* @exception NullPointerException if the given pattern or formatSymbols 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;
}
/* Package-private, called by DateFormat factory methods */
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);
}
/* Initialize compiledPattern and numberFormat fields */
private void initialize(Locale loc) {
// Verify and compile the given pattern.
compiledPattern = compile(pattern);
/* try the cache first */
numberFormat = cachedNumberFormatData.get(loc);
if (numberFormat == null) { /* cache miss */
numberFormat = NumberFormat.getIntegerInstance(loc);
numberFormat.setGroupingUsed(false);
/* update cache */
cachedNumberFormatData.putIfAbsent(loc, numberFormat);
}
numberFormat = (NumberFormat) numberFormat.clone();
initializeDefaultCentury();
}
private void initializeCalendar(Locale loc) {
if (calendar == null) {
assert loc != null;
// The format object must be constructed using the symbols for this zone.
// However, the calendar should use the current default TimeZone.
// If this is not contained in the locale zone strings, then the zone
// will be formatted using generic GMT+/-H:MM nomenclature.
calendar = Calendar.getInstance(TimeZone.getDefault(), loc);
}
}
/**
* Returns the compiled form of the given pattern. The syntax of
* the compiled pattern is:
* * CompiledPattern: * EntryList * EntryList: * Entry * EntryList Entry * Entry: * TagField * TagField data * TagField: * Tag Length * TaggedData * Tag: * pattern_char_index * TAG_QUOTE_CHARS * Length: * short_length * long_length * TaggedData: * TAG_QUOTE_ASCII_CHAR ascii_char * ** * where `short_length' is an 8-bit unsigned integer between 0 and * 254. `long_length' is a sequence of an 8-bit integer 255 and a * 32-bit signed integer value which is split into upper and lower * 16-bit fields in two char's. `pattern_char_index' is an 8-bit * integer between 0 and 18. `ascii_char' is an 7-bit ASCII * character value. `data' depends on its Tag value. *
* If Length is short_length, Tag and short_length are packed in a * single char, as illustrated below. *
* char[0] = (Tag << 8) | short_length; ** * If Length is long_length, Tag and 255 are packed in the first * char and a 32-bit integer, as illustrated below. *
* char[0] = (Tag << 8) | 255; * char[1] = (char) (long_length >>> 16); * char[2] = (char) (long_length & 0xffff); **
* If Tag is a pattern_char_index, its Length is the number of * pattern characters. For example, if the given pattern is * "yyyy", Tag is 1 and Length is 4, followed by no data. *
* If Tag is TAG_QUOTE_CHARS, its Length is the number of char's
* following the TagField. For example, if the given pattern is
* "'o''clock'", Length is 7 followed by a char sequence of
* o&nbs;'&nbs;c&nbs;l&nbs;o&nbs;c&nbs;k
.
*
* TAG_QUOTE_ASCII_CHAR is a special tag and has an ASCII
* character in place of Length. For example, if the given pattern
* is "'o'", the TaggedData entry is
* ((TAG_QUOTE_ASCII_CHAR&nbs;<<&nbs;8)&nbs;|&nbs;'o')
.
*
* @exception NullPointerException if the given pattern is null
* @exception IllegalArgumentException if the given pattern is invalid
*/
private char[] compile(String pattern) {
int length = pattern.length();
boolean inQuote = false;
StringBuilder compiledPattern = new StringBuilder(length * 2);
StringBuilder tmpBuffer = null;
int count = 0;
int lastTag = -1;
for (int i = 0; i < length; i++) {
char c = pattern.charAt(i);
if (c == '\'') {
// '' is treated as a single quote regardless of being
// in a quoted section.
if ((i + 1) < length) {
c = pattern.charAt(i + 1);
if (c == '\'') {
i++;
if (count != 0) {
encode(lastTag, count, compiledPattern);
lastTag = -1;
count = 0;
}
if (inQuote) {
tmpBuffer.append(c);
} else {
compiledPattern.append((char)(TAG_QUOTE_ASCII_CHAR << 8 | c));
}
continue;
}
}
if (!inQuote) {
if (count != 0) {
encode(lastTag, count, compiledPattern);
lastTag = -1;
count = 0;
}
if (tmpBuffer == null) {
tmpBuffer = new StringBuilder(length);
} else {
tmpBuffer.setLength(0);
}
inQuote = true;
} else {
int len = tmpBuffer.length();
if (len == 1) {
char ch = tmpBuffer.charAt(0);
if (ch < 128) {
compiledPattern.append((char)(TAG_QUOTE_ASCII_CHAR << 8 | ch));
} else {
compiledPattern.append((char)(TAG_QUOTE_CHARS << 8 | 1));
compiledPattern.append(ch);
}
} else {
encode(TAG_QUOTE_CHARS, len, compiledPattern);
compiledPattern.append(tmpBuffer);
}
inQuote = false;
}
continue;
}
if (inQuote) {
tmpBuffer.append(c);
continue;
}
if (!(c >= 'a' && c <= 'z' || c >= 'A' && c <= 'Z')) {
if (count != 0) {
encode(lastTag, count, compiledPattern);
lastTag = -1;
count = 0;
}
if (c < 128) {
// In most cases, c would be a delimiter, such as ':'.
compiledPattern.append((char)(TAG_QUOTE_ASCII_CHAR << 8 | c));
} else {
// Take any contiguous non-ASCII alphabet characters and
// put them in a single TAG_QUOTE_CHARS.
int j;
for (j = i + 1; j < length; j++) {
char d = pattern.charAt(j);
if (d == '\'' || (d >= 'a' && d <= 'z' || d >= 'A' && d <= 'Z')) {
break;
}
}
compiledPattern.append((char)(TAG_QUOTE_CHARS << 8 | (j - i)));
for (; i < j; i++) {
compiledPattern.append(pattern.charAt(i));
}
i--;
}
continue;
}
int tag;
if ((tag = DateFormatSymbols.patternChars.indexOf(c)) == -1) {
throw new IllegalArgumentException("Illegal pattern character " +
"'" + c + "'");
}
if (lastTag == -1 || lastTag == tag) {
lastTag = tag;
count++;
continue;
}
encode(lastTag, count, compiledPattern);
lastTag = tag;
count = 1;
}
if (inQuote) {
throw new IllegalArgumentException("Unterminated quote");
}
if (count != 0) {
encode(lastTag, count, compiledPattern);
}
// Copy the compiled pattern to a char array
int len = compiledPattern.length();
char[] r = new char[len];
compiledPattern.getChars(0, len, r, 0);
return r;
}
/**
* Encodes the given tag and length and puts encoded char(s) into buffer.
*/
private static final void encode(int tag, int length, StringBuilder buffer) {
if (tag == PATTERN_ISO_ZONE && length >= 4) {
throw new IllegalArgumentException("invalid ISO 8601 format: length=" + length);
}
if (length < 255) {
buffer.append((char)(tag << 8 | length));
} else {
buffer.append((char)((tag << 8) | 0xff));
buffer.append((char)(length >>> 16));
buffer.append((char)(length & 0xffff));
}
}
/* Initialize the fields we use to disambiguate ambiguous years. Separate
* so we can call it from readObject().
*/
private void initializeDefaultCentury() {
calendar.setTimeInMillis(System.currentTimeMillis());
calendar.add( Calendar.YEAR, -80 );
parseAmbiguousDatesAsAfter(calendar.getTime());
}
/* Define one-century window into which to disambiguate dates using
* two-digit years.
*/
private void parseAmbiguousDatesAsAfter(Date startDate) {
defaultCenturyStart = startDate;
calendar.setTime(startDate);
defaultCenturyStartYear = calendar.get(Calendar.YEAR);
}
/**
* Sets the 100-year period 2-digit years will be interpreted as being in
* to begin on the date the user specifies.
*
* @param startDate During parsing, two digit years will be placed in the range
* startDate
to startDate + 100 years
.
* @see #get2DigitYearStart
* @since 1.2
*/
public void set2DigitYearStart(Date startDate) {
parseAmbiguousDatesAsAfter(new Date(startDate.getTime()));
}
/**
* Returns the beginning date of the 100-year period 2-digit years are interpreted
* as being within.
*
* @return the start of the 100-year period into which two digit years are
* parsed
* @see #set2DigitYearStart
* @since 1.2
*/
public Date get2DigitYearStart() {
return (Date) defaultCenturyStart.clone();
}
/**
* Formats the given Date
into a date/time string and appends
* the result to the given StringBuffer
.
*
* @param date the date-time value to be formatted into a date-time string.
* @param toAppendTo where the new date-time text is to be appended.
* @param pos the formatting position. On input: an alignment field,
* if desired. On output: the offsets of the alignment field.
* @return the formatted date-time string.
* @exception NullPointerException if the given {@code date} is {@code null}.
*/
public StringBuffer format(Date date, StringBuffer toAppendTo,
FieldPosition pos)
{
pos.beginIndex = pos.endIndex = 0;
return format(date, toAppendTo, pos.getFieldDelegate());
}
// Called from Format after creating a FieldDelegate
private StringBuffer format(Date date, StringBuffer toAppendTo,
FieldDelegate delegate) {
// Convert input date to time field list
calendar.setTime(date);
boolean useDateFormatSymbols = useDateFormatSymbols();
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:
toAppendTo.append((char)count);
break;
case TAG_QUOTE_CHARS:
toAppendTo.append(compiledPattern, i, count);
i += count;
break;
default:
subFormat(tag, count, delegate, toAppendTo, useDateFormatSymbols);
break;
}
}
return toAppendTo;
}
/**
* 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.
*
* @exception NullPointerException if obj is null.
* @exception IllegalArgumentException if the Format cannot format the
* given object, or if the Format's pattern string is invalid.
* @param obj The object to format
* @return AttributedCharacterIterator describing the formatted value.
* @since 1.4
*/
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());
}
// Map index into pattern character string to Calendar field number
private static final int[] PATTERN_INDEX_TO_CALENDAR_FIELD =
{
Calendar.ERA, Calendar.YEAR, Calendar.MONTH, Calendar.DATE,
Calendar.HOUR_OF_DAY, Calendar.HOUR_OF_DAY, Calendar.MINUTE,
Calendar.SECOND, Calendar.MILLISECOND, Calendar.DAY_OF_WEEK,
Calendar.DAY_OF_YEAR, Calendar.DAY_OF_WEEK_IN_MONTH,
Calendar.WEEK_OF_YEAR, Calendar.WEEK_OF_MONTH,
Calendar.AM_PM, Calendar.HOUR, Calendar.HOUR, Calendar.ZONE_OFFSET,
Calendar.ZONE_OFFSET,
// Pseudo Calendar fields
CalendarBuilder.WEEK_YEAR,
CalendarBuilder.ISO_DAY_OF_WEEK,
Calendar.ZONE_OFFSET
};
// Map index into pattern character string to DateFormat field number
private static final int[] PATTERN_INDEX_TO_DATE_FORMAT_FIELD = {
DateFormat.ERA_FIELD, DateFormat.YEAR_FIELD, DateFormat.MONTH_FIELD,
DateFormat.DATE_FIELD, DateFormat.HOUR_OF_DAY1_FIELD,
DateFormat.HOUR_OF_DAY0_FIELD, DateFormat.MINUTE_FIELD,
DateFormat.SECOND_FIELD, DateFormat.MILLISECOND_FIELD,
DateFormat.DAY_OF_WEEK_FIELD, DateFormat.DAY_OF_YEAR_FIELD,
DateFormat.DAY_OF_WEEK_IN_MONTH_FIELD, DateFormat.WEEK_OF_YEAR_FIELD,
DateFormat.WEEK_OF_MONTH_FIELD, DateFormat.AM_PM_FIELD,
DateFormat.HOUR1_FIELD, DateFormat.HOUR0_FIELD,
DateFormat.TIMEZONE_FIELD, DateFormat.TIMEZONE_FIELD,
DateFormat.YEAR_FIELD, DateFormat.DAY_OF_WEEK_FIELD,
DateFormat.TIMEZONE_FIELD
};
// Maps from DecimalFormatSymbols index to Field constant
private static final Field[] PATTERN_INDEX_TO_DATE_FORMAT_FIELD_ID = {
Field.ERA, Field.YEAR, Field.MONTH, Field.DAY_OF_MONTH,
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.TIME_ZONE,
Field.TIME_ZONE,
Field.YEAR, Field.DAY_OF_WEEK,
Field.TIME_ZONE
};
/**
* Private member function that does the real date/time formatting.
*/
private void subFormat(int patternCharIndex, int count,
FieldDelegate delegate, StringBuffer buffer,
boolean useDateFormatSymbols)
{
int maxIntCount = Integer.MAX_VALUE;
String current = null;
int beginOffset = buffer.length();
int field = PATTERN_INDEX_TO_CALENDAR_FIELD[patternCharIndex];
int value;
if (field == CalendarBuilder.WEEK_YEAR) {
if (calendar.isWeekDateSupported()) {
value = calendar.getWeekYear();
} else {
// use calendar year 'y' instead
patternCharIndex = PATTERN_YEAR;
field = PATTERN_INDEX_TO_CALENDAR_FIELD[patternCharIndex];
value = calendar.get(field);
}
} else if (field == CalendarBuilder.ISO_DAY_OF_WEEK) {
value = CalendarBuilder.toISODayOfWeek(calendar.get(Calendar.DAY_OF_WEEK));
} else {
value = calendar.get(field);
}
int style = (count >= 4) ? Calendar.LONG : Calendar.SHORT;
if (!useDateFormatSymbols && field != CalendarBuilder.ISO_DAY_OF_WEEK) {
current = calendar.getDisplayName(field, style, locale);
}
// Note: zeroPaddingNumber() assumes that maxDigits is either
// 2 or maxIntCount. If we make any changes to this,
// zeroPaddingNumber() must be fixed.
switch (patternCharIndex) {
case PATTERN_ERA: // 'G'
if (useDateFormatSymbols) {
String[] eras = formatData.getEras();
if (value < eras.length)
current = eras[value];
}
if (current == null)
current = "";
break;
case PATTERN_WEEK_YEAR: // 'Y'
case PATTERN_YEAR: // 'y'
if (calendar instanceof GregorianCalendar) {
if (count != 2)
zeroPaddingNumber(value, count, maxIntCount, buffer);
else // count == 2
zeroPaddingNumber(value, 2, 2, buffer); // clip 1996 to 96
} else {
if (current == null) {
zeroPaddingNumber(value, style == Calendar.LONG ? 1 : count,
maxIntCount, buffer);
}
}
break;
case PATTERN_MONTH: // 'M'
if (useDateFormatSymbols) {
String[] months;
if (count >= 4) {
months = formatData.getMonths();
current = months[value];
} else if (count == 3) {
months = formatData.getShortMonths();
current = months[value];
}
} else {
if (count < 3) {
current = null;
}
}
if (current == null) {
zeroPaddingNumber(value+1, count, maxIntCount, buffer);
}
break;
case PATTERN_HOUR_OF_DAY1: // 'k' 1-based. eg, 23:59 + 1 hour =>> 24:59
if (current == null) {
if (value == 0)
zeroPaddingNumber(calendar.getMaximum(Calendar.HOUR_OF_DAY)+1,
count, maxIntCount, buffer);
else
zeroPaddingNumber(value, count, maxIntCount, buffer);
}
break;
case PATTERN_DAY_OF_WEEK: // 'E'
if (useDateFormatSymbols) {
String[] weekdays;
if (count >= 4) {
weekdays = formatData.getWeekdays();
current = weekdays[value];
} else { // count < 4, use abbreviated form if exists
weekdays = formatData.getShortWeekdays();
current = weekdays[value];
}
}
break;
case PATTERN_AM_PM: // 'a'
if (useDateFormatSymbols) {
String[] ampm = formatData.getAmPmStrings();
current = ampm[value];
}
break;
case PATTERN_HOUR1: // 'h' 1-based. eg, 11PM + 1 hour =>> 12 AM
if (current == null) {
if (value == 0)
zeroPaddingNumber(calendar.getLeastMaximum(Calendar.HOUR)+1,
count, maxIntCount, buffer);
else
zeroPaddingNumber(value, count, maxIntCount, buffer);
}
break;
case PATTERN_ZONE_NAME: // 'z'
if (current == null) {
if (formatData.locale == null || formatData.isZoneStringsSet) {
int zoneIndex =
formatData.getZoneIndex(calendar.getTimeZone().getID());
if (zoneIndex == -1) {
value = calendar.get(Calendar.ZONE_OFFSET) +
calendar.get(Calendar.DST_OFFSET);
buffer.append(ZoneInfoFile.toCustomID(value));
} else {
int index = (calendar.get(Calendar.DST_OFFSET) == 0) ? 1: 3;
if (count < 4) {
// Use the short name
index++;
}
String[][] zoneStrings = formatData.getZoneStringsWrapper();
buffer.append(zoneStrings[zoneIndex][index]);
}
} else {
TimeZone tz = calendar.getTimeZone();
boolean daylight = (calendar.get(Calendar.DST_OFFSET) != 0);
int tzstyle = (count < 4 ? TimeZone.SHORT : TimeZone.LONG);
buffer.append(tz.getDisplayName(daylight, tzstyle, formatData.locale));
}
}
break;
case PATTERN_ZONE_VALUE: // 'Z' ("-/+hhmm" form)
value = (calendar.get(Calendar.ZONE_OFFSET) +
calendar.get(Calendar.DST_OFFSET)) / 60000;
int width = 4;
if (value >= 0) {
buffer.append('+');
} else {
width++;
}
int num = (value / 60) * 100 + (value % 60);
CalendarUtils.sprintf0d(buffer, num, width);
break;
case PATTERN_ISO_ZONE: // 'X'
value = calendar.get(Calendar.ZONE_OFFSET)
+ calendar.get(Calendar.DST_OFFSET);
if (value == 0) {
buffer.append('Z');
break;
}
value /= 60000;
if (value >= 0) {
buffer.append('+');
} else {
buffer.append('-');
value = -value;
}
CalendarUtils.sprintf0d(buffer, value / 60, 2);
if (count == 1) {
break;
}
if (count == 3) {
buffer.append(':');
}
CalendarUtils.sprintf0d(buffer, value % 60, 2);
break;
default:
// case PATTERN_DAY_OF_MONTH: // 'd'
// case PATTERN_HOUR_OF_DAY0: // 'H' 0-based. eg, 23:59 + 1 hour =>> 00:59
// case PATTERN_MINUTE: // 'm'
// case PATTERN_SECOND: // 's'
// case PATTERN_MILLISECOND: // 'S'
// case PATTERN_DAY_OF_YEAR: // 'D'
// case PATTERN_DAY_OF_WEEK_IN_MONTH: // 'F'
// case PATTERN_WEEK_OF_YEAR: // 'w'
// case PATTERN_WEEK_OF_MONTH: // 'W'
// case PATTERN_HOUR0: // 'K' eg, 11PM + 1 hour =>> 0 AM
// case PATTERN_ISO_DAY_OF_WEEK: // 'u' pseudo field, Monday = 1, ..., Sunday = 7
if (current == null) {
zeroPaddingNumber(value, count, maxIntCount, buffer);
}
break;
} // switch (patternCharIndex)
if (current != null) {
buffer.append(current);
}
int fieldID = PATTERN_INDEX_TO_DATE_FORMAT_FIELD[patternCharIndex];
Field f = PATTERN_INDEX_TO_DATE_FORMAT_FIELD_ID[patternCharIndex];
delegate.formatted(fieldID, f, f, beginOffset, buffer.length(), buffer);
}
/**
* Formats a number with the specified minimum and maximum number of digits.
*/
private final void zeroPaddingNumber(int value, int minDigits, int maxDigits, StringBuffer buffer)
{
// Optimization for 1, 2 and 4 digit numbers. This should
// cover most cases of formatting date/time related items.
// Note: This optimization code assumes that maxDigits is
// either 2 or Integer.MAX_VALUE (maxIntCount in format()).
try {
if (zeroDigit == 0) {
zeroDigit = ((DecimalFormat)numberFormat).getDecimalFormatSymbols().getZeroDigit();
}
if (value >= 0) {
if (value < 100 && minDigits >= 1 && minDigits <= 2) {
if (value < 10) {
if (minDigits == 2) {
buffer.append(zeroDigit);
}
buffer.append((char)(zeroDigit + value));
} else {
buffer.append((char)(zeroDigit + value / 10));
buffer.append((char)(zeroDigit + value % 10));
}
return;
} else if (value >= 1000 && value < 10000) {
if (minDigits == 4) {
buffer.append((char)(zeroDigit + value / 1000));
value %= 1000;
buffer.append((char)(zeroDigit + value / 100));
value %= 100;
buffer.append((char)(zeroDigit + value / 10));
buffer.append((char)(zeroDigit + value % 10));
return;
}
if (minDigits == 2 && maxDigits == 2) {
zeroPaddingNumber(value % 100, 2, 2, buffer);
return;
}
}
}
} catch (Exception e) {
}
numberFormat.setMinimumIntegerDigits(minDigits);
numberFormat.setMaximumIntegerDigits(maxDigits);
numberFormat.format((long)value, buffer, DontCareFieldPosition.INSTANCE);
}
/**
* 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 {@link DateFormat#calendar
* 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 {@link 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
* {@link #setTimeZone(java.util.TimeZone) setTimeZone} may need
* to be restored for further operations.
*
* @param text A
* @exception InvalidObjectException if the pattern is invalid
*/
private void readObject(ObjectInputStream stream)
throws IOException, ClassNotFoundException {
stream.defaultReadObject();
try {
compiledPattern = compile(pattern);
} catch (Exception e) {
throw new InvalidObjectException("invalid pattern");
}
if (serialVersionOnStream < 1) {
// didn't have defaultCenturyStart field
initializeDefaultCentury();
}
else {
// fill in dependent transient field
parseAmbiguousDatesAsAfter(defaultCenturyStart);
}
serialVersionOnStream = currentSerialVersion;
// If the deserialized object has a SimpleTimeZone, try
// to replace it with a ZoneInfo equivalent in order to
// be compatible with the SimpleTimeZone-based
// implementation as much as possible.
TimeZone tz = getTimeZone();
if (tz instanceof SimpleTimeZone) {
String id = tz.getID();
TimeZone zi = TimeZone.getTimeZone(id);
if (zi != null && zi.hasSameRules(tz) && zi.getID().equals(id)) {
setTimeZone(zi);
}
}
}
/**
* Analyze the negative subpattern of DecimalFormat and set/update values
* as necessary.
*/
private void checkNegativeNumberExpression() {
if ((numberFormat instanceof DecimalFormat) &&
!numberFormat.equals(originalNumberFormat)) {
String numberPattern = ((DecimalFormat)numberFormat).toPattern();
if (!numberPattern.equals(originalNumberPattern)) {
hasFollowingMinusSign = false;
int separatorIndex = numberPattern.indexOf(';');
// If the negative subpattern is not absent, we have to analayze
// it in order to check if it has a following minus sign.
if (separatorIndex > -1) {
int minusIndex = numberPattern.indexOf('-', separatorIndex);
if ((minusIndex > numberPattern.lastIndexOf('0')) &&
(minusIndex > numberPattern.lastIndexOf('#'))) {
hasFollowingMinusSign = true;
minusSign = ((DecimalFormat)numberFormat).getDecimalFormatSymbols().getMinusSign();
}
}
originalNumberPattern = numberPattern;
}
originalNumberFormat = numberFormat;
}
}
}
String
, part of which should be parsed.
* @param pos A ParsePosition
object with index and error
* index information as described above.
* @return A Date
parsed from the string. In case of
* error, returns null.
* @exception NullPointerException if text
or pos
is null.
*/
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;
}
/**
* Private code-size reduction function used by subParse.
* @param text the time text being parsed.
* @param start where to start parsing.
* @param field the date field being parsed.
* @param data the string array to parsed.
* @return the new start position if matching succeeded; a negative number
* indicating matching failure, otherwise.
*/
private int matchString(String text, int start, int field, String[] data, CalendarBuilder calb)
{
int i = 0;
int count = data.length;
if (field == Calendar.DAY_OF_WEEK) i = 1;
// There may be multiple strings in the data[] array which begin with
// the same prefix (e.g., Cerven and Cervenec (June and July) in Czech).
// We keep track of the longest match, and return that. Note that this
// unfortunately requires us to test all array elements.
int bestMatchLength = 0, bestMatch = -1;
for (; iSimpleDateFormat
. This also
* clones the format's date format symbols.
*
* @return a clone of this SimpleDateFormat
*/
public Object clone() {
SimpleDateFormat other = (SimpleDateFormat) super.clone();
other.formatData = (DateFormatSymbols) formatData.clone();
return other;
}
/**
* Returns the hash code value for this SimpleDateFormat
object.
*
* @return the hash code value for this SimpleDateFormat
object.
*/
public int hashCode()
{
return pattern.hashCode();
// just enough fields for a reasonable distribution
}
/**
* Compares the given object with this SimpleDateFormat
for
* equality.
*
* @return true if the given object is equal to this
* SimpleDateFormat
*/
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));
}
/**
* After reading an object from the input stream, the format
* pattern in the object is verified.
*