File	Doc	Category	Size	Date	Package
SimpleDateFormat.java	API Doc	Java SE 6 API	78569	Tue Jun 10 00:25:52 BST 2008	java.text

SimpleDateFormat

• java.lang.Object
  • java.text.Format
    • java.text.DateFormat

Fields Summary
static final long	serialVersionUID
static final int	currentSerialVersion
private int	serialVersionOnStream 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.
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.
private transient char[]	compiledPattern The compiled pattern.
private static final int	TAG_QUOTE_ASCII_CHAR Tags for the compiled pattern.
private static final int	TAG_QUOTE_CHARS
private transient char	zeroDigit Locale dependent digit zero.
private DateFormatSymbols	formatData The symbols used by this formatter for week names, month names, etc. May not be null.
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.
private transient int	defaultCenturyStartYear
private static final int	millisPerHour
private static final int	millisPerMinute
private static final String	GMT
private static Hashtable	cachedLocaleData Cache to hold the DateTimePatterns of a Locale.
private static Hashtable	cachedNumberFormatData Cache NumberFormat instances with Locale key.
private Locale	locale The Locale used to instantiate this SimpleDateFormat. The value may be null if this object has been created by an older SimpleDateFormat and deserialized.
transient boolean	useDateFormatSymbols 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.
private static final int[]	PATTERN_INDEX_TO_CALENDAR_FIELD
private static final int[]	PATTERN_INDEX_TO_DATE_FORMAT_FIELD
private static final Field[]	PATTERN_INDEX_TO_DATE_FORMAT_FIELD_ID

Constructors Summary
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 {@link DateFormat} class.
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 {@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, 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 {@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, DateFormatSymbols formatSymbols) 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
SimpleDateFormat(int timeStyle, int dateStyle, Locale loc)

Methods Summary
public void	applyLocalizedPattern(java.lang.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	applyPattern(java.lang.String pattern) 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 java.lang.Object	clone() Creates a copy of this SimpleDateFormat. This also clones the format's date format symbols. return a clone of this SimpleDateFormat
private char[]	compile(java.lang.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'). exception NullPointerException if the given pattern is null exception IllegalArgumentException if the given pattern is invalid
private static final void	encode(int tag, int length, java.lang.StringBuilder buffer) Encodes the given tag and length and puts encoded char(s) into buffer.
public boolean	equals(java.lang.Object obj) Compares the given object with this SimpleDateFormat for equality. return true if the given object is equal to this SimpleDateFormat
public java.lang.StringBuffer	format(java.util.Date date, java.lang.StringBuffer toAppendTo, java.text.FieldPosition pos) 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
private java.lang.StringBuffer	format(java.util.Date date, java.lang.StringBuffer toAppendTo, FieldDelegate delegate)
public java.text.AttributedCharacterIterator	formatToCharacterIterator(java.lang.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. 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 java.util.Date	get2DigitYearStart() 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
private final java.lang.String	getCalendarName()
public java.text.DateFormatSymbols	getDateFormatSymbols() 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
private java.lang.String	getKey()
public int	hashCode() Returns the hash code value for this SimpleDateFormat object. return the hash code value for this SimpleDateFormat object.
private void	initialize(java.util.Locale loc)
private void	initializeCalendar(java.util.Locale loc)
private void	initializeDefaultCentury()
private boolean	isGregorianCalendar()
private boolean	matchDSTString(java.lang.String text, int start, int zoneIndex, int standardIndex)
private int	matchString(java.lang.String text, int start, int field, java.lang.String[] data) 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(java.lang.String text, int start, int field, java.util.Map data) Performs the same thing as matchString(String, int, int, String[]). This method takes a Map instead of String[].
private int	matchZoneString(java.lang.String text, int start, int zoneIndex)
public java.util.Date	parse(java.lang.String text, java.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. 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.
private void	parseAmbiguousDatesAsAfter(java.util.Date startDate)
private void	readObject(java.io.ObjectInputStream stream) After reading an object from the input stream, the format pattern in the object is verified. exception InvalidObjectException if the pattern is invalid
public void	set2DigitYearStart(java.util.Date startDate) 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	setDateFormatSymbols(java.text.DateFormatSymbols newFormatSymbols) 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
private void	subFormat(int patternCharIndex, int count, FieldDelegate delegate, java.lang.StringBuffer buffer, boolean useDateFormatSymbols) Private member function that does the real date/time formatting.
private int	subParse(java.lang.String text, int start, int patternCharIndex, int count, boolean obeyCount, boolean[] ambiguousYear, java.text.ParsePosition origPos) Private member function that converts the parsed date strings into timeFields. Returns -start (for ParsePosition) if failed. param text the time text to be parsed. param start where to start parsing. param ch the pattern character for the date field text to be parsed. param count the count of a pattern character. param obeyCount if true, then the next field directly abuts this one, and we should use the count to know when to stop parsing. param ambiguousYear return parameter; upon return, if ambiguousYear[0] is true, then a two-digit year was parsed and may need to be readjusted. param origPos origPos.errorIndex is used to return an error index at which a parse error occurred, if matching failure occurs. return 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.
private int	subParseZoneString(java.lang.String text, int start) find time zone 'text' matched zoneStrings and set to internal calendar.
public java.lang.String	toLocalizedPattern() Returns a localized pattern string describing this date format. return a localized pattern string describing this date format.
public java.lang.String	toPattern() Returns a pattern string describing this date format. return a pattern string describing this date format.
private java.lang.String	translatePattern(java.lang.String pattern, java.lang.String from, java.lang.String to) Translates a pattern, mapping each character in the from string to the corresponding character in the to string. exception IllegalArgumentException if the given pattern is invalid
private boolean	useDateFormatSymbols()
private final void	zeroPaddingNumber(int value, int minDigits, int maxDigits, java.lang.StringBuffer buffer) Formats a number with the specified minimum and maximum number of digits.