Java Doc for SimpleDateFormat.java in  » 6.0-JDK-Modules » j2me » java » text » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules » j2me » java.text 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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

SimpleDateFormat
public class SimpleDateFormat extends DateFormat (Code)
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:
  • 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: 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.

  • 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.

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.
See Also:    Java Tutorial
See Also:   java.util.Calendar
See Also:   java.util.TimeZone
See Also:   DateFormat
See Also:   DateFormatSymbols
version:
   1.59, 10/10/06
author:
   Mark Davis, Chen-Lieh Huang, Alan Liu



Field Summary
final static  intcurrentSerialVersion
    
final static  longserialVersionUID
    

Constructor Summary
public  SimpleDateFormat()
     Constructs a SimpleDateFormat using the default pattern and date format symbols for the default locale.
public  SimpleDateFormat(String pattern)
     Constructs a SimpleDateFormat using the given pattern and the default date format symbols for the default locale.
public  SimpleDateFormat(String pattern, Locale locale)
     Constructs a SimpleDateFormat using the given pattern and the default date format symbols for the given locale.
public  SimpleDateFormat(String pattern, DateFormatSymbols formatSymbols)
     Constructs a SimpleDateFormat using the given pattern and date format symbols.
 SimpleDateFormat(int timeStyle, int dateStyle, Locale loc)
    

Method Summary
public  voidapplyLocalizedPattern(String pattern)
     Applies the given localized pattern string to this date format.
public  voidapplyPattern(String pattern)
     Applies the given pattern string to this date format.
public  Objectclone()
     Creates a copy of this SimpleDateFormat.
public  booleanequals(Object obj)
     Compares the given object with this SimpleDateFormat for equality.
public  StringBufferformat(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 - the date-time value to be formatted into a date-time string.
Parameters:
  toAppendTo - where the new date-time text is to be appended.
Parameters:
  pos - the formatting position.
public  AttributedCharacterIteratorformatToCharacterIterator(Object obj)
     Formats an Object producing an AttributedCharacterIterator.
public  Dateget2DigitYearStart()
     Returns the beginning date of the 100-year period 2-digit years are interpreted as being within.
public  DateFormatSymbolsgetDateFormatSymbols()
     Gets a copy of the date and time format symbols of this date format.
public  inthashCode()
     Returns the hash code value for this SimpleDateFormat object.
public  Dateparse(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.

public  voidset2DigitYearStart(Date startDate)
     Sets the 100-year period 2-digit years will be interpreted as being in to begin on the date the user specifies.
public  voidsetDateFormatSymbols(DateFormatSymbols newFormatSymbols)
     Sets the date and time format symbols of this date format.
public  StringtoLocalizedPattern()
     Returns a localized pattern string describing this date format.
public  StringtoPattern()
     Returns a pattern string describing this date format.

Field Detail
currentSerialVersion
final static int currentSerialVersion(Code)



serialVersionUID
final static long serialVersionUID(Code)




Constructor Detail
SimpleDateFormat
public SimpleDateFormat()(Code)
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)(Code)
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
exception:
  NullPointerException - if the given pattern is null
exception:
  IllegalArgumentException - if the given pattern is invalid



SimpleDateFormat
public SimpleDateFormat(String pattern, Locale locale)(Code)
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
Parameters:
  locale - the locale whose date format symbols should be used
exception:
  NullPointerException - if the given pattern is null
exception:
  IllegalArgumentException - if the given pattern is invalid



SimpleDateFormat
public SimpleDateFormat(String pattern, DateFormatSymbols formatSymbols)(Code)
Constructs a SimpleDateFormat using the given pattern and date format symbols.
Parameters:
  pattern - the pattern describing the date and time format
Parameters:
  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



SimpleDateFormat
SimpleDateFormat(int timeStyle, int dateStyle, Locale loc)(Code)




Method Detail
applyLocalizedPattern
public void applyLocalizedPattern(String pattern)(Code)
Applies the given localized pattern string to this date format.
Parameters:
  pattern - a String to be mapped to the new date and time formatpattern for this format
exception:
  NullPointerException - if the given pattern is null
exception:
  IllegalArgumentException - if the given pattern is invalid



applyPattern
public void applyPattern(String pattern)(Code)
Applies the given pattern string to this date format.
Parameters:
  pattern - the new date and time pattern for this date format
exception:
  NullPointerException - if the given pattern is null
exception:
  IllegalArgumentException - if the given pattern is invalid



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



equals
public boolean equals(Object obj)(Code)
Compares the given object with this SimpleDateFormat for equality. true if the given object is equal to thisSimpleDateFormat



format
public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition pos)(Code)
Formats the given Date into a date/time string and appends the result to the given StringBuffer.
Parameters:
  date - the date-time value to be formatted into a date-time string.
Parameters:
  toAppendTo - where the new date-time text is to be appended.
Parameters:
  pos - the formatting position. On input: an alignment field,if desired. On output: the offsets of the alignment field. the formatted date-time string.
exception:
  NullPointerException - if the given date is null



formatToCharacterIterator
public AttributedCharacterIterator formatToCharacterIterator(Object obj)(Code)
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 thegiven object, or if the Format's pattern string is invalid.
Parameters:
  obj - The object to format AttributedCharacterIterator describing the formatted value.
since:
   1.4




get2DigitYearStart
public Date get2DigitYearStart()(Code)
Returns the beginning date of the 100-year period 2-digit years are interpreted as being within. the start of the 100-year period into which two digit years areparsed
See Also:   SimpleDateFormat.set2DigitYearStart
since:
   1.2



getDateFormatSymbols
public DateFormatSymbols getDateFormatSymbols()(Code)
Gets a copy of the date and time format symbols of this date format. the date and time format symbols of this date format
See Also:   SimpleDateFormat.setDateFormatSymbols



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



parse
public Date parse(String text, ParsePosition pos)(Code)
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.
Parameters:
  text - A String, part of which should be parsed.
Parameters:
  pos - A ParsePosition object with index and errorindex information as described above. A Date parsed from the string. In case oferror, returns null.
exception:
  NullPointerException - if text or pos is null.




set2DigitYearStart
public void set2DigitYearStart(Date startDate)(Code)
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 rangestartDate to startDate + 100 years.
See Also:   SimpleDateFormat.get2DigitYearStart
since:
   1.2



setDateFormatSymbols
public void setDateFormatSymbols(DateFormatSymbols newFormatSymbols)(Code)
Sets the date and time format symbols of this date format.
Parameters:
  newFormatSymbols - the new date and time format symbols
exception:
  NullPointerException - if the given newFormatSymbols is null
See Also:   SimpleDateFormat.getDateFormatSymbols



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



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



Fields inherited from java.text.DateFormat
final public static int AM_PM_FIELD(Code)(Java Doc)
final public static int DATE_FIELD(Code)(Java Doc)
final public static int DAY_OF_WEEK_FIELD(Code)(Java Doc)
final public static int DAY_OF_WEEK_IN_MONTH_FIELD(Code)(Java Doc)
final public static int DAY_OF_YEAR_FIELD(Code)(Java Doc)
final public static int DEFAULT(Code)(Java Doc)
final public static int ERA_FIELD(Code)(Java Doc)
final public static int FULL(Code)(Java Doc)
final public static int HOUR0_FIELD(Code)(Java Doc)
final public static int HOUR1_FIELD(Code)(Java Doc)
final public static int HOUR_OF_DAY0_FIELD(Code)(Java Doc)
final public static int HOUR_OF_DAY1_FIELD(Code)(Java Doc)
final public static int LONG(Code)(Java Doc)
final public static int MEDIUM(Code)(Java Doc)
final public static int MILLISECOND_FIELD(Code)(Java Doc)
final public static int MINUTE_FIELD(Code)(Java Doc)
final public static int MONTH_FIELD(Code)(Java Doc)
final public static int SECOND_FIELD(Code)(Java Doc)
final public static int SHORT(Code)(Java Doc)
final public static int TIMEZONE_FIELD(Code)(Java Doc)
final public static int WEEK_OF_MONTH_FIELD(Code)(Java Doc)
final public static int WEEK_OF_YEAR_FIELD(Code)(Java Doc)
final public static int YEAR_FIELD(Code)(Java Doc)
protected Calendar calendar(Code)(Java Doc)
protected NumberFormat numberFormat(Code)(Java Doc)

Methods inherited from java.text.DateFormat
public Object clone()(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
final public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition fieldPosition)(Code)(Java Doc)
abstract public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition)(Code)(Java Doc)
final public String format(Date date)(Code)(Java Doc)
public static Locale[] getAvailableLocales()(Code)(Java Doc)
public Calendar getCalendar()(Code)(Java Doc)
final public static DateFormat getDateInstance()(Code)(Java Doc)
final public static DateFormat getDateInstance(int style)(Code)(Java Doc)
final public static DateFormat getDateInstance(int style, Locale aLocale)(Code)(Java Doc)
final public static DateFormat getDateTimeInstance()(Code)(Java Doc)
final public static DateFormat getDateTimeInstance(int dateStyle, int timeStyle)(Code)(Java Doc)
final public static DateFormat getDateTimeInstance(int dateStyle, int timeStyle, Locale aLocale)(Code)(Java Doc)
final public static DateFormat getInstance()(Code)(Java Doc)
public NumberFormat getNumberFormat()(Code)(Java Doc)
final public static DateFormat getTimeInstance()(Code)(Java Doc)
final public static DateFormat getTimeInstance(int style)(Code)(Java Doc)
final public static DateFormat getTimeInstance(int style, Locale aLocale)(Code)(Java Doc)
public TimeZone getTimeZone()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public boolean isLenient()(Code)(Java Doc)
public Date parse(String source) throws ParseException(Code)(Java Doc)
abstract public Date parse(String source, ParsePosition pos)(Code)(Java Doc)
public Object parseObject(String source, ParsePosition pos)(Code)(Java Doc)
public void setCalendar(Calendar newCalendar)(Code)(Java Doc)
public void setLenient(boolean lenient)(Code)(Java Doc)
public void setNumberFormat(NumberFormat newNumberFormat)(Code)(Java Doc)
public void setTimeZone(TimeZone zone)(Code)(Java Doc)

Methods inherited from java.text.Format
public Object clone()(Code)(Java Doc)
AttributedCharacterIterator createAttributedCharacterIterator(String s)(Code)(Java Doc)
AttributedCharacterIterator createAttributedCharacterIterator(AttributedCharacterIterator[] iterators)(Code)(Java Doc)
AttributedCharacterIterator createAttributedCharacterIterator(String string, AttributedCharacterIterator.Attribute key, Object value)(Code)(Java Doc)
AttributedCharacterIterator createAttributedCharacterIterator(AttributedCharacterIterator iterator, AttributedCharacterIterator.Attribute key, Object value)(Code)(Java Doc)
final public String format(Object obj)(Code)(Java Doc)
abstract public StringBuffer format(Object obj, StringBuffer toAppendTo, FieldPosition pos)(Code)(Java Doc)
public AttributedCharacterIterator formatToCharacterIterator(Object obj)(Code)(Java Doc)
abstract public Object parseObject(String source, ParsePosition pos)(Code)(Java Doc)
public Object parseObject(String source) throws ParseException(Code)(Java Doc)

Methods inherited from java.lang.Object
public boolean equals(Object obj)(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.