Top Description Inners Fields Constructors Methods
com.ibm.icu.text

public Class SimpleDateFormat

extends DateFormat
Class Inheritance
Known Direct Subclasses
com.ibm.icu.text.ChineseDateFormat
Imports
java.io.IOException, .ObjectInputStream, .ObjectOutputStream, java.text.AttributedCharacterIterator, .AttributedString, .FieldPosition, .Format, .ParsePosition, java.util.ArrayList, .Date, .HashMap, .List, .Locale, .MissingResourceException, .UUID, com.ibm.icu.impl.DateNumberFormat, .DayPeriodRules, .ICUCache, .ICUData, .ICUResourceBundle, .PatternProps, .SimpleCache, .SimpleFormatterImpl, com.ibm.icu.lang.UCharacter, com.ibm.icu.text.TimeZoneFormat.Style, .TimeZoneFormat.TimeType, com.ibm.icu.util.BasicTimeZone, .BasicTimeZone.LocalOption, .Calendar, .HebrewCalendar, .Output, .TimeZone, .TimeZoneTransition, .ULocale, .ULocale.Category, .UResourceBundle

ICU Enhancement

This class is ICU's replacement for java.text.SimpleDateFormat.

ICU

Methods, fields, and other functionality specific to ICU are labeled 'ICU'.

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, all unquoted ASCII letters [A-Za-z] are reserved as pattern letters representing calendar fields. SimpleDateFormat supports the date and time formatting algorithm and pattern letters defined by UTS#35 Unicode Locale Data Markup Language (LDML). The following pattern letters are currently available (note that the actual values depend on CLDR and may change from the examples shown here):

Field Sym. No. Example Description
era G 1..3 AD Era - Replaced with the Era string for the current date. One to three letters for the abbreviated form, four letters for the long (wide) form, five for the narrow form.
4 Anno Domini
5 A
year y 1..n 1996 Year. Normally the length specifies the padding, but for two letters it also specifies the maximum length. Example:
Year y yy yyy yyyy yyyyy
AD 1 1 01 001 0001 00001
AD 12 12 12 012 0012 00012
AD 123 123 23 123 0123 00123
AD 1234 1234 34 1234 1234 01234
AD 12345 12345 45 12345 12345 12345
Y 1..n 1997 Year (in "Week of Year" based calendars). Normally the length specifies the padding, but for two letters it also specifies the maximum length. This year designation is used in ISO year-week calendar as defined by ISO 8601, but can be used in non-Gregorian based calendar systems where week date processing is desired. May not always be the same value as calendar year.
u 1..n 4601 Extended year. This is a single number designating the year of this calendar system, encompassing all supra-year fields. For example, for the Julian calendar system, year numbers are positive, with an era of BCE or CE. An extended year value for the Julian calendar system assigns positive values to CE years and negative values to BCE years, with 1 BCE being year 0.
U 1..3 甲子 Cyclic year name. Calendars such as the Chinese lunar calendar (and related calendars) and the Hindu calendars use 60-year cycles of year names. Use one through three letters for the abbreviated name, four for the full (wide) name, or five for the narrow name (currently the data only provides abbreviated names, which will be used for all requested name widths). If the calendar does not provide cyclic year name data, or if the year value to be formatted is out of the range of years for which cyclic name data is provided, then numeric formatting is used (behaves like 'y').
4 (currently also 甲子)
5 (currently also 甲子)
quarter Q 1..2 02 Quarter - Use one or two for the numerical quarter, three for the abbreviation, or four for the full (wide) name (five for the narrow name is not yet supported).
3 Q2
4 2nd quarter
q 1..2 02 Stand-Alone Quarter - Use one or two for the numerical quarter, three for the abbreviation, or four for the full name (five for the narrow name is not yet supported).
3 Q2
4 2nd quarter
month M 1..2 09 Month - Use one or two for the numerical month, three for the abbreviation, four for the full (wide) name, or five for the narrow name. With two ("MM"), the month number is zero-padded if necessary (e.g. "08").
3 Sep
4 September
5 S
L 1..2 09 Stand-Alone Month - Use one or two for the numerical month, three for the abbreviation, four for the full (wide) name, or 5 for the narrow name. With two ("LL"), the month number is zero-padded if necessary (e.g. "08").
3 Sep
4 September
5 S
week w 1..2 27 Week of Year. Use "w" to show the minimum number of digits, or "ww" to always show two digits (zero-padding if necessary, e.g. "08").
W 1 3 Week of Month
day d 1..2 1 Date - Day of the month. Use "d" to show the minimum number of digits, or "dd" to always show two digits (zero-padding if necessary, e.g. "08").
D 1..3 345 Day of year
F 1 2 Day of Week in Month. The example is for the 2nd Wed in July
g 1..n 2451334 Modified Julian day. This is different from the conventional Julian day number in two regards. First, it demarcates days at local zone midnight, rather than noon GMT. Second, it is a local number; that is, it depends on the local time zone. It can be thought of as a single number that encompasses all the date-related fields.
week
day
E 1..3 Tue Day of week - Use one through three letters for the short day, four for the full (wide) name, five for the narrow name, or six for the short name.
4 Tuesday
5 T
6 Tu
e 1..2 2 Local day of week. Same as E except adds a numeric value that will depend on the local starting day of the week, using one or two letters. For this example, Monday is the first day of the week.
3 Tue
4 Tuesday
5 T
6 Tu
c 1 2 Stand-Alone local day of week - Use one letter for the local numeric value (same as 'e'), three for the short day, four for the full (wide) name, five for the narrow name, or six for the short name.
3 Tue
4 Tuesday
5 T
6 Tu
period a 1 AM AM or PM
hour h 1..2 11 Hour [1-12]. When used in skeleton data or in a skeleton passed in an API for flexible data pattern generation, it should match the 12-hour-cycle format preferred by the locale (h or K); it should not match a 24-hour-cycle format (H or k). Use hh for zero padding.
H 1..2 13 Hour [0-23]. When used in skeleton data or in a skeleton passed in an API for flexible data pattern generation, it should match the 24-hour-cycle format preferred by the locale (H or k); it should not match a 12-hour-cycle format (h or K). Use HH for zero padding.
K 1..2 0 Hour [0-11]. When used in a skeleton, only matches K or h, see above. Use KK for zero padding.
k 1..2 24 Hour [1-24]. When used in a skeleton, only matches k or H, see above. Use kk for zero padding.
minute m 1..2 59 Minute. Use "m" to show the minimum number of digits, or "mm" to always show two digits (zero-padding if necessary, e.g. "08")..
second s 1..2 12 Second. Use "s" to show the minimum number of digits, or "ss" to always show two digits (zero-padding if necessary, e.g. "08").
S 1..n 3450 Fractional Second - truncates (like other time fields) to the count of letters when formatting. Appends zeros if more than 3 letters specified. Truncates at three significant digits when parsing. (example shows display using pattern SSSS for seconds value 12.34567)
A 1..n 69540000 Milliseconds in day. This field behaves exactly like a composite of all time-related fields, not including the zone fields. As such, it also reflects discontinuities of those fields on DST transition days. On a day of DST onset, it will jump forward. On a day of DST cessation, it will jump backward. This reflects the fact that is must be combined with the offset field to obtain a unique local time value.
zone z 1..3 PDT The short specific non-location format. Where that is unavailable, falls back to the short localized GMT format ("O").
4 Pacific Daylight Time The long specific non-location format. Where that is unavailable, falls back to the long localized GMT format ("OOOO").
Z 1..3 -0800 The ISO8601 basic format with hours, minutes and optional seconds fields. The format is equivalent to RFC 822 zone format (when optional seconds field is absent). This is equivalent to the "xxxx" specifier.
4 GMT-8:00 The long localized GMT format. This is equivalent to the "OOOO" specifier.
5 -08:00
-07:52:58
The ISO8601 extended format with hours, minutes and optional seconds fields. The ISO8601 UTC indicator "Z" is used when local time offset is 0. This is equivalent to the "XXXXX" specifier.
O 1 GMT-8 The short localized GMT format.
4 GMT-08:00 The long localized GMT format.
v 1 PT The short generic non-location format. Where that is unavailable, falls back to the generic location format ("VVVV"), then the short localized GMT format as the final fallback.
4 Pacific Time The long generic non-location format. Where that is unavailable, falls back to generic location format ("VVVV").
V 1 uslax The short time zone ID. Where that is unavailable, the special short time zone ID unk (Unknown Zone) is used.
Note: This specifier was originally used for a variant of the short specific non-location format, but it was deprecated in the later version of the LDML specification. In CLDR 23/ICU 51, the definition of the specifier was changed to designate a short time zone ID.
2 America/Los_Angeles The long time zone ID.
3 Los Angeles The exemplar city (location) for the time zone. Where that is unavailable, the localized exemplar city name for the special zone Etc/Unknown is used as the fallback (for example, "Unknown City").
4 Los Angeles Time The generic location format. Where that is unavailable, falls back to the long localized GMT format ("OOOO"; Note: Fallback is only necessary with a GMT-style Time Zone ID, like Etc/GMT-830.)
This is especially useful when presenting possible timezone choices for user selection, since the naming is more uniform than the "v" format.
X 1 -08
+0530
Z
The ISO8601 basic format with hours field and optional minutes field. The ISO8601 UTC indicator "Z" is used when local time offset is 0.
2 -0800
Z
The ISO8601 basic format with hours and minutes fields. The ISO8601 UTC indicator "Z" is used when local time offset is 0.
3 -08:00
Z
The ISO8601 extended format with hours and minutes fields. The ISO8601 UTC indicator "Z" is used when local time offset is 0.
4 -0800
-075258
Z
The ISO8601 basic format with hours, minutes and optional seconds fields. (Note: The seconds field is not supported by the ISO8601 specification.) The ISO8601 UTC indicator "Z" is used when local time offset is 0.
5 -08:00
-07:52:58
Z
The ISO8601 extended format with hours, minutes and optional seconds fields. (Note: The seconds field is not supported by the ISO8601 specification.) The ISO8601 UTC indicator "Z" is used when local time offset is 0.
x 1 -08
+0530
The ISO8601 basic format with hours field and optional minutes field.
2 -0800 The ISO8601 basic format with hours and minutes fields.
3 -08:00 The ISO8601 extended format with hours and minutes fields.
4 -0800
-075258
The ISO8601 basic format with hours, minutes and optional seconds fields. (Note: The seconds field is not supported by the ISO8601 specification.)
5 -08:00
-07:52:58
The ISO8601 extended format with hours, minutes and optional seconds fields. (Note: The seconds field is not supported by the ISO8601 specification.)

Any characters in the pattern that are not in the ranges of ['a'..'z'] and ['A'..'Z'] will be treated as quoted text. For instance, characters like ':', '.', ' ', '#' and '@' will appear in the resulting time text even they are not embraced within single quotes.

A pattern containing any invalid pattern letter will result in a thrown exception during formatting or parsing.

Examples Using the US Locale:

Format Pattern                         Result
--------------                         -------
"yyyy.MM.dd G 'at' HH:mm:ss vvvv" ->>  1996.07.10 AD at 15:08:56 Pacific Time
"EEE, MMM d, ''yy"                ->>  Wed, July 10, '96
"h:mm a"                          ->>  12:08 PM
"hh 'o''clock' a, zzzz"           ->>  12 o'clock PM, Pacific Daylight Time
"K:mm a, vvv"                     ->>  0:00 PM, PT
"yyyyy.MMMMM.dd GGG hh:mm aaa"    ->>  01996.July.10 AD 12:08 PM
Code Sample:
SimpleTimeZone pdt = new SimpleTimeZone(-8 * 60 * 60 * 1000, "PST");
pdt.setStartRule(Calendar.APRIL, 1, Calendar.SUNDAY, 2*60*60*1000);
pdt.setEndRule(Calendar.OCTOBER, -1, Calendar.SUNDAY, 2*60*60*1000);

// Format the current time. SimpleDateFormat formatter = new SimpleDateFormat ("yyyy.MM.dd G 'at' hh:mm:ss a zzz"); Date currentTime_1 = new Date(); String dateString = formatter.format(currentTime_1);
// Parse the previous string back into a Date. ParsePosition pos = new ParsePosition(0); Date currentTime_2 = formatter.parse(dateString, pos);
In the example, the time value currentTime_2 obtained from parsing will be equal to currentTime_1. However, they may not be equal if the am/pm marker 'a' is left out from the format pattern while the "hour in am/pm" pattern symbol is used. This information loss can happen when formatting the time in PM.

When parsing a date string using the abbreviated year pattern ("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 com.ibm.icu.lang.UCharacter#isDigit(int), 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.

If the year pattern does not have exactly two 'y' characters, 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.

When numeric fields abut one another directly, with no intervening delimiter characters, they constitute a run of abutting numeric fields. Such runs are parsed specially. For example, the format "HHmmss" parses the input text "123456" to 12:34:56, parses the input text "12345" to 1:23:45, and fails to parse "1234". In other words, the leftmost field of the run is flexible, while the others keep a fixed width. If the parse fails anywhere in the run, then the leftmost field is shortened by one character, and the entire run is parsed again. This is repeated until either the parse succeeds or the leftmost field is one character in length. If the parse still fails at that point, the parse of the run fails.

For time zones that have no names, use strings GMT+hours:minutes or GMT-hours:minutes.

The calendar defines what is the first day of the week, the first week of the year, whether hours are zero based or not (0 vs 12 or 24), and the time zone. There is one common decimal format to handle all the numbers; the digit count is handled programmatically according to the pattern.

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
ICU Status
Stable since ICU 2.0.
See Also
com.ibm.icu.util.Calendar, com.ibm.icu.util.GregorianCalendar, com.ibm.icu.util.TimeZone, DateFormat, DateFormatSymbols, DecimalFormat, TimeZoneFormat

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static enum
SimpleDateFormat.ContextValue

Old ContextValue enum, preserved only to avoid deserialization errs from ICU 49.1.

private static class

Field Summary

Modifier and TypeField and Description
private static ULocale
private static String
private static final int[]
private transient BreakIterator
capitalizationBrkIter

BreakIterator to use for capitalization (will be cloned for actual use)

pack-priv static final int
pack-priv static final UnicodeSet
private transient char[]
private static final int
private transient char[]
private transient long
private Date
defaultCenturyStart

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

private transient int
pack-priv static boolean
private static final String
private DateFormatSymbols
formatData

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

private transient boolean
hasHanYearChar

DateFormat pattern contains the Han year character 年=年, => non-numeric E Asian format.

private transient boolean
hasMinute

DateFormat pattern contains the minute field.

private transient boolean
hasSecond

DateFormat pattern contains the second field.

private static final int
private static final int
private static final int
private transient ULocale
private static final long
MAX_DAYLIGHT_DETECTION_RANGE

Maximum range for detecting daylight offset of a time zone when parsed time zone string indicates it's daylight saving time, but the detected time zone does not observe daylight saving time at the parsed date.

private static final int
private HashMap<String, NumberFormat>
numberFormatters

The hash map used for number format overrides.

private static final String
NUMERIC_FORMAT_CHARS

Format characters that indicate numeric fields always.

private static final String
NUMERIC_FORMAT_CHARS2

Format characters that indicate numeric fields when pattern length is up to 2.

private String
override

The override string of this formatter.

private HashMap<Character, String>
overrideMap

The hash map used for number format overrides.

private static ICUCache<String, Object[]>
private String
pattern

The pattern string of this formatter.

private static final boolean[]
private static final int[]
private static final int[]
private static final int[]
private static final DateFormat.Field[]
private static final int[]
private transient Object[]
private int
serialVersionOnStream

Hides com.ibm.icu.text.DateFormat.serialVersionOnStream.

The version of the serialized data on the stream.
private static final long
private static final String
private volatile TimeZoneFormat
private transient boolean
useFastFormat

If true, this object supports fast formatting using the subFormat variant that takes a StringBuffer.

private transient boolean
Inherited from com.ibm.icu.text.DateFormat:
ABBR_GENERIC_TZABBR_MONTHABBR_MONTH_DAYABBR_MONTH_WEEKDAY_DAYABBR_QUARTERABBR_SPECIFIC_TZABBR_STANDALONE_MONTHABBR_UTC_TZABBR_WEEKDAYAM_PM_FIELDAM_PM_MIDNIGHT_NOON_FIELDcalendarDATE_FIELDDATE_SKELETONSDAYDAY_OF_WEEK_FIELDDAY_OF_WEEK_IN_MONTH_FIELDDAY_OF_YEAR_FIELDDEFAULTDOW_LOCAL_FIELDERA_FIELDEXTENDED_YEAR_FIELDFIELD_COUNTFLEXIBLE_DAY_PERIOD_FIELDFRACTIONAL_SECOND_FIELDFULLGENERIC_TZHOURHOUR0_FIELDHOUR1_FIELDHOUR24HOUR24_MINUTEHOUR24_MINUTE_SECONDHOUR_GENERIC_TZHOUR_MINUTEHOUR_MINUTE_GENERIC_TZHOUR_MINUTE_SECONDHOUR_MINUTE_TZHOUR_OF_DAY0_FIELDHOUR_OF_DAY1_FIELDHOUR_TZJP_ERA_2019_JAJP_ERA_2019_NARROWJP_ERA_2019_ROOTJULIAN_DAY_FIELDLOCATION_TZLONGMEDIUMMILLISECOND_FIELDMILLISECONDS_IN_DAY_FIELDMINUTEMINUTE_FIELDMINUTE_SECONDMONTHMONTH_DAYMONTH_FIELDMONTH_WEEKDAY_DAYNONENUM_MONTHNUM_MONTH_DAYNUM_MONTH_WEEKDAY_DAYnumberFormatQUARTERQUARTER_FIELDRELATED_YEARRELATIVERELATIVE_DEFAULTRELATIVE_FULLRELATIVE_LONGRELATIVE_MEDIUMRELATIVE_SHORTSECONDSECOND_FIELDSHORTSPECIFIC_TZSTANDALONE_DAY_FIELDSTANDALONE_MONTHSTANDALONE_MONTH_FIELDSTANDALONE_QUARTER_FIELDTIME_SEPARATORTIME_SKELETONSTIMEZONE_FIELDTIMEZONE_GENERIC_FIELDTIMEZONE_ISO_FIELDTIMEZONE_ISO_LOCAL_FIELDTIMEZONE_LOCALIZED_GMT_OFFSET_FIELDTIMEZONE_RFC_FIELDTIMEZONE_SPECIAL_FIELDWEEK_OF_MONTH_FIELDWEEK_OF_YEAR_FIELDWEEKDAYYEARYEAR_ABBR_MONTHYEAR_ABBR_MONTH_DAYYEAR_ABBR_MONTH_WEEKDAY_DAYYEAR_ABBR_QUARTERYEAR_FIELDYEAR_MONTHYEAR_MONTH_DAYYEAR_MONTH_WEEKDAY_DAYYEAR_NAME_FIELDYEAR_NUM_MONTHYEAR_NUM_MONTH_DAYYEAR_NUM_MONTH_WEEKDAY_DAYYEAR_QUARTERYEAR_WOY_FIELDZONE_SKELETONS

Constructor Summary

AccessConstructor and Description
public
SimpleDateFormat()

Constructs a SimpleDateFormat using the default pattern for the default FORMAT locale

Note

Not all locales support SimpleDateFormat; for full generality, use the factory methods in the DateFormat class.

public
SimpleDateFormat(String pattern)

Constructs a SimpleDateFormat using the given pattern in the default FORMAT locale

Note

Not all locales support SimpleDateFormat; for full generality, use the factory methods in the DateFormat class.

public
SimpleDateFormat(String pattern, Locale loc)

Constructs a SimpleDateFormat using the given pattern and locale

Note

Not all locales support SimpleDateFormat; for full generality, use the factory methods in the DateFormat class.

public
SimpleDateFormat(String pattern, ULocale loc)

Constructs a SimpleDateFormat using the given pattern and locale

Note

Not all locales support SimpleDateFormat; for full generality, use the factory methods in the DateFormat class.

public
SimpleDateFormat(String
The pattern to be used
pattern
,
String
The override string. A numbering system override string can take one of the following forms: 1). If just a numbering system name is specified, it applies to all numeric fields in the date format pattern. 2). To specify an alternate numbering system on a field by field basis, use the field letters from the pattern followed by an = sign, followed by the numbering system name. For example, to specify that just the year be formatted using Hebrew digits, use the override "y=hebr". Multiple overrides can be specified in a single string by separating them with a semi-colon. For example, the override string "m=thai;y=deva" would format using Thai digits for the month and Devanagari digits for the year.
override
,
ULocale
The locale to be used
loc
)

Constructs a SimpleDateFormat using the given pattern , override and locale.

public
SimpleDateFormat(String pattern, DateFormatSymbols formatData)

Constructs a SimpleDateFormat using the given pattern and locale-specific symbol data.

public
SimpleDateFormat(String pattern, DateFormatSymbols formatData, ULocale loc)

Deprecated This API is ICU internal only.
pack-priv
SimpleDateFormat(String pattern, DateFormatSymbols formatData, Calendar calendar, ULocale locale, boolean useFastFormat, String override)

Package-private constructor that allows a subclass to specify whether it supports fast formatting.

private
SimpleDateFormat(String pattern, DateFormatSymbols formatData, Calendar calendar, NumberFormat numberFormat, ULocale locale, boolean useFastFormat, String override)

Method Summary

Modifier and TypeMethod and Description
private boolean
allowNumericFallback(int patternCharIndex)

return true if the pattern specified by patternCharIndex is one that allows numeric fallback regardless of actual pattern size.

public void
applyLocalizedPattern(String pat)

Apply the given localized pattern string to this date format.

public void
applyPattern(String pat)

Apply the given unlocalized pattern string to this date format.

public Object
clone()

Overrides com.ibm.icu.text.DateFormat.clone.

Overrides Cloneable
private static int

Returns:

number of digits found in the text in the specified range.
countDigits
(String
input text
text
,
int
start index, inclusive
start
,
int
end index, exclusive
end
)

Counts number of digit code points in the specified text.

private boolean

Returns:

true is i-th item in 2 calendar is in different value, false otherwise.
diffCalFieldValue
(Calendar
one calendar
fromCalendar
,
Calendar
the other calendar
toCalendar
,
Object[]
pattern items
items
,
int
the i-th item in pattern items
i
)

check whether the i-th item in 2 calendar is in different value.

public boolean
equals(Object
the reference object with which to compare.
obj
)

Overrides com.ibm.icu.text.DateFormat.equals.

Override equals.
private void
fastZeroPaddingNumber(StringBuffer buf, int value, int minDigits, int maxDigits)

public StringBuffer

Returns:

the formatted date-time string.
format
(Calendar
the calendar whose date-time value is to be formatted into a date-time string
cal
,
StringBuffer
where the new date-time text is to be appended
toAppendTo
,
FieldPosition
the formatting position. On input: an alignment field, if desired. On output: the offsets of the alignment field.
pos
)

Implements abstract com.ibm.icu.text.DateFormat.format.

Formats a date or time, which is the standard millis since January 1, 1970, 00:00:00 GMT.
pack-priv StringBuffer
format(Calendar cal, StringBuffer toAppendTo, FieldPosition pos, List<FieldPosition> attributes)

Internal formatting method that accepts an attributes list.

private StringBuffer
format(Calendar cal, DisplayContext capitalizationContext, StringBuffer toAppendTo, FieldPosition pos, List<FieldPosition> attributes)

public AttributedCharacterIterator

Returns:

AttributedCharacterIterator describing the formatted value.
formatToCharacterIterator
(Object
The object to format
obj
)

Overrides java.text.Format.formatToCharacterIterator.

Format the object to an attributed string, and return the corresponding iterator Overrides superclass method.
public Date

Returns:

the start of the 100-year period into which two digit years are parsed
get2DigitYearStart
()

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

public DateFormatSymbols

Returns:

a copy of the date-time formatting data associated with this date-time formatter.
getDateFormatSymbols
()

Gets the date/time formatting data.

private Date
private int
private static synchronized String
private static int
public static SimpleDateFormat

Returns:

A SimpleDateFormat instance
getInstance
(Calendar.FormatConfiguration
the format configuration
formatConfig
)

Deprecated This API is ICU internal only.
Creates an instance of SimpleDateFormat for the given format configuration
private static int
getLevelFromChar(char ch)

Map calendar field letter into calendar field level.

pack-priv ULocale

Returns:

locale in this simple date formatter
getLocale
()

Get the locale of this simple date formatter.

public NumberFormat

Returns:

override NumberFormat used for the field
getNumberFormat
(char
the field the user wants
field
)

give the NumberFormat used for the field like 'y'(year) and 'M'(year)

private Object[]
protected DateFormatSymbols
getSymbols()

Method for subclasses to access the DateFormatSymbols.

public TimeZoneFormat

Returns:

the time zone formatter which this date/time formatter uses.
getTimeZoneFormat
()

ICU

public int
hashCode()

Overrides com.ibm.icu.text.DateFormat.hashCode.

Override hashCode.
private void
private void
private synchronized void
initializeTimeZoneFormat(boolean
when true, check if tzFormat is synchronized with the current numberFormat and update its digits if necessary. When false, this check is skipped.
bForceUpdate
)

Private method lazily instantiate the TimeZoneFormat field

private void
private void
public final StringBuffer

Returns:

Reference to 'appendTo' parameter.
intervalFormatByAlgorithm
(Calendar
calendar set to the from date in date interval to be formatted into date interval string
fromCalendar
,
Calendar
calendar set to the to date in date interval to be formatted into date interval string
toCalendar
,
StringBuffer
Output parameter to receive result. Result is appended to existing contents.
appendTo
,
FieldPosition
On input: an alignment field, if desired. On output: the offsets of the alignment field.
pos
)

Deprecated This API is ICU internal only.
Format date interval by algorithm.
pack-priv boolean

Returns:

true if the 'field' is smaller than all the fields covered in pattern. false otherwise.
isFieldUnitIgnored
(int
the calendar field need to check against
field
)

Check whether the 'field' is smaller than all the fields covered in pattern, return true if it is.

pack-priv static boolean
isFieldUnitIgnored(String pattern, int field)

private static final boolean
isNumeric(char formatChar, int count)

Return true if the given format character, occurring count times, represents a numeric field.

private static boolean
isSyntaxChar(char ch)

Tell if a character can be used to define a field in a format string.

private boolean

Returns:

true if i-th pattern item is lower than 'level', false otherwise
lowerLevel
(Object[]
the pattern items
items
,
int
the i-th item in pattern items
i
,
int
the level with which the i-th pattern item compared to
level
)

check whether the i-th item's level is lower than the input 'level' It is supposed to be used only by CLDR survey tool.

private int

Returns:

the new start position if matching succeeded; a negative number indicating matching failure, otherwise. As a side effect, sets the cal field field to the index of the best match, if matching succeeded.
matchAlphaMonthStrings
(String
the time text being parsed.
text
,
int
where to start parsing.
start
,
String[]
the string array of wide month symbols
wideData
,
String[]
the string array of short month symbols
shortData
,
Calendar cal)

Deprecated This API is ICU internal only. Does not handle monthPattern. field is always Calendar.MONTH
Attempt to match the text at a given position against two arrays of month symbol strings.
private int
matchDayPeriodString(String text, int start, String[] data, int dataLength, Output<DayPeriodRules.DayPeriod> dayPeriod)

Similar to matchQuarterString but customized for day periods.

private int
matchLiteral(String text, int pos, Object[] items, int itemIndex, boolean[] complete)

Matches text (starting at pos) with patl.

protected int

Returns:

the new start position if matching succeeded; a negative number indicating matching failure, otherwise. As a side effect, sets the cal field field to the index of the best match, if matching succeeded.
matchQuarterString
(String
the time text being parsed.
text
,
int
where to start parsing.
start
,
int
the date field being parsed.
field
,
String[]
the string array to parsed.
data
,
Calendar cal)

Attempt to match the text at a given position against an array of quarter strings.

protected int

Returns:

the new start position if matching succeeded; a negative number indicating matching failure, otherwise. As a side effect, sets the cal field field to the index of the best match, if matching succeeded.
matchString
(String
the time text being parsed.
text
,
int
where to start parsing.
start
,
int
the date field being parsed.
field
,
String[]
the string array to parsed.
data
,
Calendar cal)

Attempt to match the text at a given position against an array of strings.

private int

Returns:

the new start position if matching succeeded; a negative number indicating matching failure, otherwise. As a side effect, sets the cal field field to the index of the best match, if matching succeeded.
matchString
(String
the time text being parsed.
text
,
int
where to start parsing.
start
,
int
the date field being parsed.
field
,
String[]
the string array to parsed.
data
,
String
leap month pattern, or null if none.
monthPattern
,
Calendar cal)

Deprecated This API is ICU internal only.
Attempt to match the text at a given position against an array of strings.
public void
parse(String
The date/time string to be parsed
text
,
Calendar
The calendar set on input to the date and time to be used for missing values in the date/time string being parsed, and set on output to the parsed date/time. In general, this should be initialized before calling this method - either cleared or set to the current date, depending on desired behavior. If this parse fails, the calendar may still have been modified. When the calendar type is different from the internal calendar held by this DateFormat instance, calendar field values will be parsed based on the internal calendar initialized with the time and the time zone taken from this calendar, then the parse result (time in milliseconds and time zone) will be set back to this calendar.
cal
,
ParsePosition
On input, the position at which to start parsing; on output, the position at which parsing terminated, or the start position if the parse failed.
parsePos
)

Implements abstract com.ibm.icu.text.DateFormat.parse.

Overrides DateFormat
private void
private Number
parseInt(String text, ParsePosition pos, boolean allowNegative, NumberFormat fmt)

Parse an integer using numberFormat.

private Number
parseInt(String text, int maxDigits, ParsePosition pos, boolean allowNegative, NumberFormat fmt)

Parse an integer using numberFormat up to maxDigits.

private void
protected DateFormat.Field

Returns:

DateFormat.Field associated with the pattern character
patternCharToDateFormatField
(char
The pattern character
ch
)

Returns a DateFormat.Field constant associated with the specified format pattern character.

private void
private void
private int
regionMatchesWithOptionalDot(String text, int start, String data, int length)

private static void
safeAppend(String[] array, int value, StringBuffer appendTo)

private static void
safeAppendWithMonthPattern(String[] array, int value, StringBuffer appendTo, String monthPattern)

public void
set2DigitYearStart(Date
During parsing, two digit years will be placed in the range startDate to startDate + 100 years.
startDate
)

Sets the 100-year period 2-digit years will be interpreted as being in to begin on the date the user specifies.

public void
setContext(DisplayContext
The DisplayContext value to set.
context
)

Overrides com.ibm.icu.text.DateFormat.setContext.

ICU

public void
setDateFormatSymbols(DateFormatSymbols
the new symbols
newFormatSymbols
)

Allows you to set the date/time formatting data.

public void
setNumberFormat(NumberFormat
the given new NumberFormat.
newNumberFormat
)

Overrides com.ibm.icu.text.DateFormat.setNumberFormat.

Overrides superclass method and This method also clears per field NumberFormat instances previously set by setNumberFormat(String, NumberFormat)
public void
setNumberFormat(String
the fields to override
fields
,
NumberFormat
the NumbeferFormat used
overrideNF
)

allow the user to set the NumberFormat for several fields It can be a single field like: "y"(year) or "M"(month) It can be several field combined together: "yMd"(year, month and date)

Note

1 symbol field is enough for multiple symbol fields (so "y" will override "yy", "yyy") If the field is not numeric, then override has no effect (like "MMM" will use abbreviation, not numerical field)

public void
setTimeZoneFormat(TimeZoneFormat
the new time zone formatter
tzfmt
)

ICU

protected String
subFormat(char
the pattern character
ch
,
int
the number of times ch is repeated in the pattern
count
,
int
the offset of the output string at the start of this field; used to set pos when appropriate
beginOffset
,
FieldPosition
receives the position of a field, when appropriate
pos
,
DateFormatSymbols
the symbols for this formatter
fmtData
,
Calendar cal)

Formats a single field, given its pattern character.

protected String
subFormat(char ch, int count, int beginOffset, int fieldNum, DisplayContext capitalizationContext, FieldPosition pos, char patternCharToOutput, Calendar cal)

Deprecated This API is ICU internal only.
Formats a single field.
protected void
subFormat(StringBuffer buf, char ch, int count, int beginOffset, int fieldNum, DisplayContext capitalizationContext, FieldPosition pos, char patternCharToOutput, Calendar cal)

Deprecated This API is ICU internal only.
Formats a single field; useFastFormat variant.
protected int

Returns:

the new start position if matching succeeded; a negative number indicating matching failure, otherwise. As a side effect, set the appropriate field of cal with the parsed value.
subParse
(String
the time text to be parsed.
text
,
int
where to start parsing.
start
,
char
the pattern character for the date field text to be parsed.
ch
,
int
the count of a pattern character.
count
,
boolean
if true, then the next field directly abuts this one, and we should use the count to know when to stop parsing.
obeyCount
,
boolean allowNegative, boolean[]
return parameter; upon return, if ambiguousYear[0] is true, then a two-digit year was parsed and may need to be readjusted.
ambiguousYear
,
Calendar cal)

Protected method that converts one field of the input string into a numeric field value in cal.

private int
subParse(String text, int start, char ch, int count, boolean obeyCount, boolean allowNegative, boolean[] ambiguousYear, Calendar cal, MessageFormat numericLeapMonthFormatter, Output<TimeZoneFormat.TimeType> tzTimeType)

Overloading to provide default argument (null) for day period.

private int

Returns:

the new start position if matching succeeded; a negative number indicating matching failure, otherwise. As a side effect, set the appropriate field of cal with the parsed value.
subParse
(String
the time text to be parsed.
text
,
int
where to start parsing.
start
,
char
the pattern character for the date field text to be parsed.
ch
,
int
the count of a pattern character.
count
,
boolean
if true, then the next field directly abuts this one, and we should use the count to know when to stop parsing.
obeyCount
,
boolean allowNegative, boolean[]
return parameter; upon return, if ambiguousYear[0] is true, then a two-digit year was parsed and may need to be readjusted.
ambiguousYear
,
Calendar cal, MessageFormat
if non-null, used to parse numeric leap months.
numericLeapMonthFormatter
,
Output<TimeZoneFormat.TimeType>
the type of parsed time zone - standard, daylight or unknown (output). This parameter can be null if caller does not need the information.
tzTimeType
,
Output<DayPeriodRules.DayPeriod> dayPeriod)

Deprecated This API is ICU internal only.
Protected method that converts one field of the input string into a numeric field value in cal.
public String
toLocalizedPattern()

Return a localized pattern string describing this date format.

public String
toPattern()

Return a pattern string describing this date format.

private String
translatePattern(String pat, String from, String to)

Translate a pattern, mapping each character in the from string to the corresponding character in the to string.

private TimeZoneFormat

Returns:

the TimeZoneFormat used by this formatter.
tzFormat
()

Private method, returns non-null TimeZoneFormat.

private void
writeObject(ObjectOutputStream stream)

Override writeObject.

protected void
zeroPaddingNumber(NumberFormat nf, StringBuffer buf, int value, int minDigits, int maxDigits)

Deprecated This API is ICU internal only.
Internal high-speed method.
protected String
zeroPaddingNumber(long value, int minDigits, int maxDigits)

Formats a number with the specified minimum and maximum number of digits.

Inherited from com.ibm.icu.text.DateFormat:
fixNumberFormatForDatesformatformatformatgetAvailableLocalesgetAvailableULocalesgetBooleanAttributegetCalendargetContextgetDateInstancegetDateInstancegetDateInstancegetDateInstancegetDateInstancegetDateInstancegetDateInstancegetDateTimeInstancegetDateTimeInstancegetDateTimeInstancegetDateTimeInstancegetDateTimeInstancegetDateTimeInstancegetDateTimeInstancegetInstancegetInstancegetInstancegetInstancegetInstanceForSkeletongetInstanceForSkeletongetInstanceForSkeletongetInstanceForSkeletongetInstanceForSkeletongetNumberFormatgetPatternInstancegetPatternInstancegetPatternInstancegetPatternInstancegetPatternInstancegetTimeInstancegetTimeInstancegetTimeInstancegetTimeInstancegetTimeInstancegetTimeInstancegetTimeInstancegetTimeZoneisCalendarLenientisLenientparseparseparseObjectsetBooleanAttributesetCalendarsetCalendarLenientsetLenientsetTimeZone