java.text.SimpleDateFormat Maven / Gradle / Ivy
/*
This is not an official specification document, and usage is restricted.
NOTICE
(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 219: Foundation
Profile 1.1. In the event of a discrepency between this work and the
JSR 219 specification, which is available at
http://www.jcp.org/en/jsr/detail?id=219, the latter takes precedence.
*/
package java.text;
import java.util.TimeZone;
import java.util.Calendar;
import java.util.Date;
import java.util.Locale;
import java.util.ResourceBundle;
import java.util.SimpleTimeZone;
import java.util.GregorianCalendar;
import java.io.ObjectInputStream;
import java.io.InvalidObjectException;
import java.io.IOException;
import java.lang.ClassNotFoundException;
import java.util.Hashtable;
import java.lang.StringIndexOutOfBoundsException;
/**
* 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 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
* {@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.
*
- 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 Java Tutorial
* @see java.util.Calendar
* @see java.util.TimeZone
* @see DateFormat
* @see DateFormatSymbols
* @version 1.58, 10/25/05
* @author Mark Davis, Chen-Lieh Huang, Alan Liu
*/
public class SimpleDateFormat extends DateFormat
{
static final long serialVersionUID = 4774881970558875024L;
/**
* The version of the serialized data on the stream. Possible values:
*
* - 0 or not present on stream: JDK 1.1.3. This version
* has no
defaultCenturyStart on stream.
* - 1 JDK 1.1.4 or later. This version adds
*
defaultCenturyStart.
*
* When streaming out this class, the most recent format
* and the highest allowable serialVersionOnStream
* is written.
* @serial
* @since JDK1.1.4
*/
private int serialVersionOnStream;
/**
* 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;
/**
* 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;
/**
* 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() { }
/**
* 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) { }
/**
* 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 is null
* @exception IllegalArgumentException if the given pattern is invalid
*/
public SimpleDateFormat(String pattern, Locale 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) { }
/**
* 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) { }
/**
* 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 null;
}
/**
* 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 date is null
*/
public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition
pos)
{
return null;
}
/**
* 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) {
return null;
}
/**
* 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.
*
* @param text A 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) {
return null;
}
/**
* Returns a pattern string describing this date format.
*
* @return a pattern string describing this date format.
*/
public String toPattern() {
return null;
}
/**
* Returns a localized pattern string describing this date format.
*
* @return a localized pattern string describing this date format.
*/
public String toLocalizedPattern() {
return null;
}
/**
* Applies the given pattern string to this date format.
*
* @param 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
*/
public void applyPattern(String pattern) { }
/**
* Applies the given localized pattern string to this date format.
*
* @param pattern a String to be mapped to the new date and time format
* pattern for this format
* @exception NullPointerException if the given pattern is null
* @exception IllegalArgumentException if the given pattern is invalid
*/
public void applyLocalizedPattern(String pattern) { }
/**
* Gets a copy of the date and time format symbols of this date format.
*
* @return the date and time format symbols of this date format
* @see #setDateFormatSymbols
*/
public DateFormatSymbols getDateFormatSymbols() {
return null;
}
/**
* Sets the date and time format symbols of this date format.
*
* @param newFormatSymbols the new date and time format symbols
* @exception NullPointerException if the given newFormatSymbols is null
* @see #getDateFormatSymbols
*/
public void setDateFormatSymbols(DateFormatSymbols newFormatSymbols) { }
/**
* Creates a copy of this SimpleDateFormat. This also
* clones the format's date format symbols.
*
* @return a clone of this SimpleDateFormat
*/
public Object clone() {
return null;
}
/**
* Returns the hash code value for this SimpleDateFormat object.
*
* @return the hash code value for this SimpleDateFormat object.
*/
public int hashCode() {
return 0;
}
/**
* 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) {
return false;
}
/**
* After reading an object from the input stream, the format
* pattern in the object is verified.
*
* @exception InvalidObjectException if the pattern is invalid
*/
private void readObject(ObjectInputStream stream)
throws IOException, java.lang.ClassNotFoundException
{ }
}