java.text
Class SimpleDateFormat

java.lang.Object
  extended byjava.text.Format
      extended byjava.text.DateFormat
          extended byjava.text.SimpleDateFormat
All Implemented Interfaces:
Cloneable, Serializable

public class SimpleDateFormat
extends DateFormat

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):

Letter Date or Time Component Presentation Examples
G Era designator Text AD
y Year Year 1996; 96
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 in week Text Tuesday; Tue
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
Pattern letters are usually repeated, as their number determines the exact presentation: 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

Synchronization

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.

Author:
Mark Davis, Chen-Lieh Huang, Alan Liu
See Also:
Java Tutorial, Calendar, TimeZone, DateFormat, DateFormatSymbols, Serialized Form

Nested Class Summary
 
Nested classes inherited from class java.text.DateFormat
DateFormat.Field
 
Nested classes inherited from class java.text.Format
Format.FieldDelegate
 
Field Summary
private static Hashtable cachedLocaleData
          Cache to hold the DateTimePatterns of a Locale.
private static Hashtable cachedNumberFormatData
          Cache NumberFormat instances with Locale key.
private  char[] compiledPattern
          The compiled pattern.
(package private) static int currentSerialVersion
           
private  Date defaultCenturyStart
          We map dates with two-digit years into the century starting at defaultCenturyStart, which may be any date.
private  int defaultCenturyStartYear
           
private  DateFormatSymbols formatData
          The symbols used by this formatter for week names, month names, etc.
private static String GMT
           
private static String GMT_MINUS
           
private static String GMT_PLUS
           
private static int millisPerHour
           
private static int millisPerMinute
           
private  String pattern
          The pattern string of this formatter.
private static int[] PATTERN_INDEX_TO_CALENDAR_FIELD
           
private static int[] PATTERN_INDEX_TO_DATE_FORMAT_FIELD
           
private static DateFormat.Field[] PATTERN_INDEX_TO_DATE_FORMAT_FIELD_ID
           
private  int serialVersionOnStream
          The version of the serialized data on the stream.
(package private) static long serialVersionUID
           
private static int TAG_QUOTE_ASCII_CHAR
          Tags for the compiled pattern.
private static int TAG_QUOTE_CHARS
           
private  char zeroDigit
          Locale dependent digit zero.
 
Fields inherited from class java.text.DateFormat
AM_PM_FIELD, calendar, DATE_FIELD, DAY_OF_WEEK_FIELD, DAY_OF_WEEK_IN_MONTH_FIELD, DAY_OF_YEAR_FIELD, DEFAULT, ERA_FIELD, FULL, HOUR_OF_DAY0_FIELD, HOUR_OF_DAY1_FIELD, HOUR0_FIELD, HOUR1_FIELD, LONG, MEDIUM, MILLISECOND_FIELD, MINUTE_FIELD, MONTH_FIELD, numberFormat, SECOND_FIELD, SHORT, TIMEZONE_FIELD, WEEK_OF_MONTH_FIELD, WEEK_OF_YEAR_FIELD, YEAR_FIELD
 
Constructor Summary
  SimpleDateFormat()
          Constructs a SimpleDateFormat using the default pattern and date format symbols for the default locale.
(package private) SimpleDateFormat(int timeStyle, int dateStyle, Locale loc)
           
  SimpleDateFormat(String pattern)
          Constructs a SimpleDateFormat using the given pattern and the default date format symbols for the default locale.
  SimpleDateFormat(String pattern, DateFormatSymbols formatSymbols)
          Constructs a SimpleDateFormat using the given pattern and date format symbols.
  SimpleDateFormat(String pattern, Locale locale)
          Constructs a SimpleDateFormat using the given pattern and the default date format symbols for the given locale.
 
Method Summary
 void applyLocalizedPattern(String pattern)
          Applies the given localized pattern string to this date format.
 void applyPattern(String pattern)
          Applies the given pattern string to this date format.
 Object clone()
          Creates a copy of this SimpleDateFormat.
private  char[] compile(String pattern)
          Returns the compiled form of the given pattern.
private static void encode(int tag, int length, StringBuffer buffer)
          Encodes the given tag and length and puts encoded char(s) into buffer.
 boolean equals(Object obj)
          Compares the given object with this SimpleDateFormat for equality.
 StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition pos)
          Formats the given Date into a date/time string and appends the result to the given StringBuffer.
private  StringBuffer format(Date date, StringBuffer toAppendTo, Format.FieldDelegate delegate)
           
 AttributedCharacterIterator formatToCharacterIterator(Object obj)
          Formats an Object producing an AttributedCharacterIterator.
 Date get2DigitYearStart()
          Returns the beginning date of the 100-year period 2-digit years are interpreted as being within.
 DateFormatSymbols getDateFormatSymbols()
          Gets a copy of the date and time format symbols of this date format.
 int hashCode()
          Returns the hash code value for this SimpleDateFormat object.
private  void initialize(Locale loc)
           
private  void initializeDefaultCentury()
           
private  int matchString(String text, int start, int field, String[] data)
          Private code-size reduction function used by subParse.
private  int matchZoneString(String text, int start, int zoneIndex)
           
 Date parse(String text, ParsePosition pos)
          Parses text from a string to produce a Date.
private  void parseAmbiguousDatesAsAfter(Date startDate)
           
private  void readObject(ObjectInputStream stream)
          After reading an object from the input stream, the format pattern in the object is verified.
 void set2DigitYearStart(Date startDate)
          Sets the 100-year period 2-digit years will be interpreted as being in to begin on the date the user specifies.
 void setDateFormatSymbols(DateFormatSymbols newFormatSymbols)
          Sets the date and time format symbols of this date format.
private  void subFormat(int patternCharIndex, int count, Format.FieldDelegate delegate, StringBuffer buffer)
          Private member function that does the real date/time formatting.
private  int subParse(String text, int start, int patternCharIndex, int count, boolean obeyCount, boolean[] ambiguousYear, ParsePosition origPos)
          Private member function that converts the parsed date strings into timeFields.
private  int subParseZoneString(String text, int start)
          find time zone 'text' matched zoneStrings and set to internal calendar.
 String toLocalizedPattern()
          Returns a localized pattern string describing this date format.
 String toPattern()
          Returns a pattern string describing this date format.
private  String translatePattern(String pattern, String from, String to)
          Translates a pattern, mapping each character in the from string to the corresponding character in the to string.
private  void zeroPaddingNumber(int value, int minDigits, int maxDigits, StringBuffer buffer)
          Formats a number with the specified minimum and maximum number of digits.
 
Methods inherited from class java.text.DateFormat
format, format, getAvailableLocales, getCalendar, getDateInstance, getDateInstance, getDateInstance, getDateTimeInstance, getDateTimeInstance, getDateTimeInstance, getInstance, getNumberFormat, getTimeInstance, getTimeInstance, getTimeInstance, getTimeZone, isLenient, parse, parseObject, setCalendar, setLenient, setNumberFormat, setTimeZone
 
Methods inherited from class java.text.Format
createAttributedCharacterIterator, createAttributedCharacterIterator, createAttributedCharacterIterator, createAttributedCharacterIterator, format, parseObject
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

static final long serialVersionUID
See Also:
Constant Field Values

currentSerialVersion

static final int currentSerialVersion
See Also:
Constant Field Values

serialVersionOnStream

private int serialVersionOnStream
The version of the serialized data on the stream. Possible values: When streaming out this class, the most recent format and the highest allowable serialVersionOnStream is written.

Since:
JDK1.1.4

pattern

private String pattern
The pattern string of this formatter. This is always a non-localized pattern. May not be null. See class documentation for details.


compiledPattern

private transient char[] compiledPattern
The compiled pattern.


TAG_QUOTE_ASCII_CHAR

private static final int TAG_QUOTE_ASCII_CHAR
Tags for the compiled pattern.

See Also:
Constant Field Values

TAG_QUOTE_CHARS

private static final int TAG_QUOTE_CHARS
See Also:
Constant Field Values

zeroDigit

private transient char zeroDigit
Locale dependent digit zero.

See Also:
zeroPaddingNumber(int, int, int, java.lang.StringBuffer), DecimalFormatSymbols.getZeroDigit()

formatData

private DateFormatSymbols formatData
The symbols used by this formatter for week names, month names, etc. May not be null.

See Also:
DateFormatSymbols

defaultCenturyStart

private Date defaultCenturyStart
We map dates with two-digit years into the century starting at defaultCenturyStart, which may be any date. May not be null.

Since:
JDK1.1.4

defaultCenturyStartYear

private transient int defaultCenturyStartYear

millisPerHour

private static final int millisPerHour
See Also:
Constant Field Values

millisPerMinute

private static final int millisPerMinute
See Also:
Constant Field Values

GMT_PLUS

private static final String GMT_PLUS
See Also:
Constant Field Values

GMT_MINUS

private static final String GMT_MINUS
See Also:
Constant Field Values

GMT

private static final String GMT
See Also:
Constant Field Values

cachedLocaleData

private static Hashtable cachedLocaleData
Cache to hold the DateTimePatterns of a Locale.


cachedNumberFormatData

private static Hashtable cachedNumberFormatData
Cache NumberFormat instances with Locale key.


PATTERN_INDEX_TO_CALENDAR_FIELD

private static final int[] PATTERN_INDEX_TO_CALENDAR_FIELD

PATTERN_INDEX_TO_DATE_FORMAT_FIELD

private static final int[] PATTERN_INDEX_TO_DATE_FORMAT_FIELD

PATTERN_INDEX_TO_DATE_FORMAT_FIELD_ID

private static final DateFormat.Field[] PATTERN_INDEX_TO_DATE_FORMAT_FIELD_ID
Constructor Detail

SimpleDateFormat

public SimpleDateFormat()
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.


SimpleDateFormat

public SimpleDateFormat(String pattern)
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

SimpleDateFormat

public SimpleDateFormat(String pattern,
                        Locale 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 is null
IllegalArgumentException - if the given pattern is invalid

SimpleDateFormat

public SimpleDateFormat(String pattern,
                        DateFormatSymbols formatSymbols)
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

SimpleDateFormat

SimpleDateFormat(int timeStyle,
                 int dateStyle,
                 Locale loc)
Method Detail

initialize

private void initialize(Locale loc)

compile

private char[] compile(String pattern)
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').

Throws:
NullPointerException - if the given pattern is null
IllegalArgumentException - if the given pattern is invalid

encode

private static final void encode(int tag,
                                 int length,
                                 StringBuffer buffer)
Encodes the given tag and length and puts encoded char(s) into buffer.


initializeDefaultCentury

private void initializeDefaultCentury()

parseAmbiguousDatesAsAfter

private void parseAmbiguousDatesAsAfter(Date startDate)

set2DigitYearStart

public void set2DigitYearStart(Date startDate)
Sets the 100-year period 2-digit years will be interpreted as being in to begin on the date the user specifies.

Parameters:
startDate - During parsing, two digit years will be placed in the range startDate to startDate + 100 years.
Since:
1.2
See Also:
get2DigitYearStart()

get2DigitYearStart

public Date get2DigitYearStart()
Returns the beginning date of the 100-year period 2-digit years are interpreted as being within.

Returns:
the start of the 100-year period into which two digit years are parsed
Since:
1.2
See Also:
set2DigitYearStart(java.util.Date)

format

public StringBuffer format(Date date,
                           StringBuffer toAppendTo,
                           FieldPosition pos)
Formats the given Date into a date/time string and appends the result to the given StringBuffer.

Specified by:
format in class DateFormat
Parameters:
date - the date-time value to be formatted into a date-time string.
toAppendTo - where the new date-time text is to be appended.
pos - the formatting position. On input: an alignment field, if desired. On output: the offsets of the alignment field.
Returns:
the formatted date-time string.
Throws:
NullPointerException - if the given date is null

format

private StringBuffer format(Date date,
                            StringBuffer toAppendTo,
                            Format.FieldDelegate delegate)

formatToCharacterIterator

public AttributedCharacterIterator formatToCharacterIterator(Object obj)
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.

Overrides:
formatToCharacterIterator in class Format
Parameters:
obj - The object to format
Returns:
AttributedCharacterIterator describing the formatted value.
Throws:
NullPointerException - if obj is null.
IllegalArgumentException - if the Format cannot format the given object, or if the Format's pattern string is invalid.
Since:
1.4

subFormat

private void subFormat(int patternCharIndex,
                       int count,
                       Format.FieldDelegate delegate,
                       StringBuffer buffer)
Private member function that does the real date/time formatting.


zeroPaddingNumber

private final void zeroPaddingNumber(int value,
                                     int minDigits,
                                     int maxDigits,
                                     StringBuffer buffer)
Formats a number with the specified minimum and maximum number of digits.


parse

public Date parse(String text,
                  ParsePosition pos)
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.

Specified by:
parse in class DateFormat
Parameters:
text - A String, part of which should be parsed.
pos - A ParsePosition object with index and error index information as described above.
Returns:
A Date parsed from the string. In case of error, returns null.
Throws:
NullPointerException - if text or pos is null.
See Also:
DateFormat.setLenient(boolean)

matchString

private int matchString(String text,
                        int start,
                        int field,
                        String[] data)
Private code-size reduction function used by subParse.

Parameters:
text - the time text being parsed.
start - where to start parsing.
field - the date field being parsed.
data - the string array to parsed.
Returns:
the new start position if matching succeeded; a negative number indicating matching failure, otherwise.

matchZoneString

private int matchZoneString(String text,
                            int start,
                            int zoneIndex)

subParseZoneString

private int subParseZoneString(String text,
                               int start)
find time zone 'text' matched zoneStrings and set to internal calendar.


subParse

private int subParse(String text,
                     int start,
                     int patternCharIndex,
                     int count,
                     boolean obeyCount,
                     boolean[] ambiguousYear,
                     ParsePosition origPos)
Private member function that converts the parsed date strings into timeFields. Returns -start (for ParsePosition) if failed.

Parameters:
text - the time text to be parsed.
start - where to start parsing.
count - the count of a pattern character.
obeyCount - if true, then the next field directly abuts this one, and we should use the count to know when to stop parsing.
ambiguousYear - return parameter; upon return, if ambiguousYear[0] is true, then a two-digit year was parsed and may need to be readjusted.
origPos - origPos.errorIndex is used to return an error index at which a parse error occurred, if matching failure occurs.
Returns:
the new start position if matching succeeded; -1 indicating matching failure, otherwise. In case matching failure occurred, an error index is set to origPos.errorIndex.

translatePattern

private String translatePattern(String pattern,
                                String from,
                                String to)
Translates a pattern, mapping each character in the from string to the corresponding character in the to string.

Throws:
IllegalArgumentException - if the given pattern is invalid

toPattern

public String toPattern()
Returns a pattern string describing this date format.

Returns:
a pattern string describing this date format.

toLocalizedPattern

public String toLocalizedPattern()
Returns a localized pattern string describing this date format.

Returns:
a localized pattern string describing this date format.

applyPattern

public void applyPattern(String pattern)
Applies the given pattern string to this date format.

Parameters:
pattern - the new date and time pattern for this date format
Throws:
NullPointerException - if the given pattern is null
IllegalArgumentException - if the given pattern is invalid

applyLocalizedPattern

public void applyLocalizedPattern(String pattern)
Applies the given localized pattern string to this date format.

Parameters:
pattern - a String to be mapped to the new date and time format pattern for this format
Throws:
NullPointerException - if the given pattern is null
IllegalArgumentException - if the given pattern is invalid

getDateFormatSymbols

public DateFormatSymbols getDateFormatSymbols()
Gets a copy of the date and time format symbols of this date format.

Returns:
the date and time format symbols of this date format
See Also:
setDateFormatSymbols(java.text.DateFormatSymbols)

setDateFormatSymbols

public void setDateFormatSymbols(DateFormatSymbols newFormatSymbols)
Sets the date and time format symbols of this date format.

Parameters:
newFormatSymbols - the new date and time format symbols
Throws:
NullPointerException - if the given newFormatSymbols is null
See Also:
getDateFormatSymbols()

clone

public Object clone()
Creates a copy of this SimpleDateFormat. This also clones the format's date format symbols.

Overrides:
clone in class DateFormat
Returns:
a clone of this SimpleDateFormat

hashCode

public int hashCode()
Returns the hash code value for this SimpleDateFormat object.

Overrides:
hashCode in class DateFormat
Returns:
the hash code value for this SimpleDateFormat object.

equals

public boolean equals(Object obj)
Compares the given object with this SimpleDateFormat for equality.

Overrides:
equals in class DateFormat
Returns:
true if the given object is equal to this SimpleDateFormat

readObject

private void readObject(ObjectInputStream stream)
                 throws IOException,
                        ClassNotFoundException
After reading an object from the input stream, the format pattern in the object is verified.

Throws:
InvalidObjectException - if the pattern is invalid
IOException
ClassNotFoundException