Skip to content

Most visited

Recently visited

navigation
Added in API level 1

SimpleDateFormat

public class SimpleDateFormat
extends DateFormat

java.lang.Object
   ↳ java.text.Format
     ↳ java.text.DateFormat
       ↳ java.text.SimpleDateFormat


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
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
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
"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

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.

See also:

Summary

Inherited constants

From class java.text.DateFormat

Inherited fields

From class java.text.DateFormat

Public constructors

SimpleDateFormat()

Constructs a SimpleDateFormat using the default pattern and date format symbols for the default locale.

SimpleDateFormat(String pattern)

Constructs a SimpleDateFormat using the given pattern and the default date format symbols for the default locale.

SimpleDateFormat(String pattern, Locale locale)

Constructs a SimpleDateFormat using the given pattern and the default date format symbols for the given locale.

SimpleDateFormat(String pattern, DateFormatSymbols formatSymbols)

Constructs a SimpleDateFormat using the given pattern and date format symbols.

Public methods

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.

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.

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.

Date parse(String text, ParsePosition pos)

Parses text from a string to produce a Date.

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.

String toLocalizedPattern()

Returns a localized pattern string describing this date format.

String toPattern()

Returns a pattern string describing this date format.

Inherited methods

From class java.text.DateFormat
From class java.text.Format
From class java.lang.Object

Public constructors

SimpleDateFormat

Added in API level 1
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

Added in API level 1
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 String: the pattern describing the date and time format
Throws
NullPointerException if the given pattern is null
IllegalArgumentException if the given pattern is invalid

SimpleDateFormat

Added in API level 1
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 String: the pattern describing the date and time format
locale 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

SimpleDateFormat

Added in API level 1
SimpleDateFormat (String pattern, 
                DateFormatSymbols formatSymbols)

Constructs a SimpleDateFormat using the given pattern and date format symbols.

Parameters
pattern String: the pattern describing the date and time format
formatSymbols DateFormatSymbols: 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

Public methods

applyLocalizedPattern

Added in API level 1
void applyLocalizedPattern (String pattern)

Applies the given localized pattern string to this date format.

Parameters
pattern String: 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

applyPattern

Added in API level 1
void applyPattern (String pattern)

Applies the given pattern string to this date format.

Parameters
pattern String: 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

clone

Added in API level 1
Object clone ()

Creates a copy of this SimpleDateFormat. This also clones the format's date format symbols.

Returns
Object a clone of this SimpleDateFormat

equals

Added in API level 1
boolean equals (Object obj)

Compares the given object with this SimpleDateFormat for equality.

Parameters
obj Object: the reference object with which to compare.
Returns
boolean true if the given object is equal to this SimpleDateFormat

format

Added in API level 1
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.

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

formatToCharacterIterator

Added in API level 1
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.

Parameters
obj Object: The object to format
Returns
AttributedCharacterIterator 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.

get2DigitYearStart

Added in API level 1
Date get2DigitYearStart ()

Returns the beginning date of the 100-year period 2-digit years are interpreted as being within.

Returns
Date the start of the 100-year period into which two digit years are parsed

See also:

getDateFormatSymbols

Added in API level 1
DateFormatSymbols getDateFormatSymbols ()

Gets a copy of the date and time format symbols of this date format.

Returns
DateFormatSymbols the date and time format symbols of this date format

See also:

hashCode

Added in API level 1
int hashCode ()

Returns the hash code value for this SimpleDateFormat object.

Returns
int the hash code value for this SimpleDateFormat object.

parse

Added in API level 1
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.

This parsing operation uses the calendar to produce a Date. All of the calendar's date-time fields are cleared before parsing, and the 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 Date is 1970 with GregorianCalendar if no year value is given from the parsing operation. The TimeZone value may be overwritten, depending on the given pattern and the time zone value in text. Any TimeZone value that has previously been set by a call to setTimeZone may need to be restored for further operations.

Parameters
text String: A String, part of which should be parsed.
pos ParsePosition: A ParsePosition object with index and error index information as described above.
Returns
Date A Date parsed from the string. In case of error, returns null.
Throws
NullPointerException if text or pos is null.

set2DigitYearStart

Added in API level 1
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 Date: During parsing, two digit years will be placed in the range startDate to startDate + 100 years.

See also:

setDateFormatSymbols

Added in API level 1
void setDateFormatSymbols (DateFormatSymbols newFormatSymbols)

Sets the date and time format symbols of this date format.

Parameters
newFormatSymbols DateFormatSymbols: the new date and time format symbols
Throws
NullPointerException if the given newFormatSymbols is null

See also:

toLocalizedPattern

Added in API level 1
String toLocalizedPattern ()

Returns a localized pattern string describing this date format.

Returns
String a localized pattern string describing this date format.

toPattern

Added in API level 1
String toPattern ()

Returns a pattern string describing this date format.

Returns
String a pattern string describing this date format.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.