org.threeten.bp.format

Class DateTimeFormatters

java.lang.Object

org.threeten.bp.format.DateTimeFormatters

public final class DateTimeFormatters
extends Object

Provides common implementations of DateTimeFormatter.

This utility class provides three different ways to obtain a formatter.

• Using pattern letters, such as yyyy-MMM-dd
• Using localized styles, such as long or medium
• Using predefined constants, such as isoLocalDate()

Specification for implementors

This is a thread-safe utility class. All returned formatters are immutable and thread-safe.

Method Summary

Methods

Modifier and Type	Method and Description
static DateTimeFormatter	basicIsoDate() Returns the ISO date formatter that prints/parses a date without an offset, such as '20111203'.
static DateTimeFormatter	isoDate() Returns the ISO date formatter that prints/parses a date with the offset if available, such as '2011-12-03' or '2011-12-03+01:00'.
static DateTimeFormatter	isoDateTime() Returns the ISO date formatter that prints/parses a date-time with the offset and zone if available, such as '2011-12-03T10:15:30', '2011-12-03T10:15:30+01:00' or '2011-12-03T10:15:30+01:00[Europe/Paris]'.
static DateTimeFormatter	isoInstant() Returns the ISO instant formatter that prints/parses an instant in UTC.
static DateTimeFormatter	isoLocalDate() Returns the ISO date formatter that prints/parses a date without an offset, such as '2011-12-03'.
static DateTimeFormatter	isoLocalDateTime() Returns the ISO date formatter that prints/parses a date-time without an offset, such as '2011-12-03T10:15:30'.
static DateTimeFormatter	isoLocalTime() Returns the ISO time formatter that prints/parses a time without an offset, such as '10:15' or '10:15:30'.
static DateTimeFormatter	isoOffsetDate() Returns the ISO date formatter that prints/parses a date with an offset, such as '2011-12-03+01:00'.
static DateTimeFormatter	isoOffsetDateTime() Returns the ISO date formatter that prints/parses a date-time with an offset, such as '2011-12-03T10:15:30+01:00'.
static DateTimeFormatter	isoOffsetTime() Returns the ISO time formatter that prints/parses a time with an offset, such as '10:15+01:00' or '10:15:30+01:00'.
static DateTimeFormatter	isoOrdinalDate() Returns the ISO date formatter that prints/parses the ordinal date without an offset, such as '2012-337'.
static DateTimeFormatter	isoTime() Returns the ISO time formatter that prints/parses a time, with the offset if available, such as '10:15', '10:15:30' or '10:15:30+01:00'.
static DateTimeFormatter	isoWeekDate() Returns the ISO date formatter that prints/parses the week-based date without an offset, such as '2012-W48-6'.
static DateTimeFormatter	isoZonedDateTime() Returns the ISO date formatter that prints/parses a date-time with offset and zone, such as '2011-12-03T10:15:30+01:00[Europe/Paris]'.
static DateTimeFormatter	localizedDate(FormatStyle dateStyle) Returns a locale specific date format.
static DateTimeFormatter	localizedDateTime(FormatStyle dateTimeStyle) Returns a locale specific date-time format, which is typically of short length.
static DateTimeFormatter	localizedDateTime(FormatStyle dateStyle, FormatStyle timeStyle) Returns a locale specific date and time format.
static DateTimeFormatter	localizedTime(FormatStyle timeStyle) Returns a locale specific time format.
static DateTimeFormatter	pattern(String pattern) Creates a formatter using the specified pattern.
static DateTimeFormatter	pattern(String pattern, Locale locale) Creates a formatter using the specified pattern.
static DateTimeFormatter	rfc1123() Returns the RFC-1123 date-time formatter, such as 'Tue, 3 Jun 2008 11:05:30 GMT'.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

pattern

public static DateTimeFormatter pattern(String pattern)

Creates a formatter using the specified pattern.

This method will create a formatter based on a simple pattern of letters and symbols. For example, d MMM yyyy will format 2011-12-03 as '3 Dec 2011'.

The returned formatter will use the default locale, but this can be changed using DateTimeFormatter.withLocale(Locale).

All letters 'A' to 'Z' and 'a' to 'z' are reserved as pattern letters. The following pattern letters are defined:

  Symbol  Meaning                     Presentation      Examples
  ------  -------                     ------------      -------
   G       era                         number/text       1; 01; AD; Anno Domini
   y       year                        year              2004; 04
   D       day-of-year                 number            189
   M       month-of-year               number/text       7; 07; Jul; July; J
   d       day-of-month                number            10

   Q       quarter-of-year             number/text       3; 03; Q3
   Y       week-based-year             year              1996; 96
   w       week-of-year                number            27
   W       week-of-month               number            27
   e       localized day-of-week       number            2; Tue; Tuesday; T
   E       day-of-week                 number/text       2; Tue; Tuesday; T
   F       week-of-month               number            3

   a       am-pm-of-day                text              PM
   h       clock-hour-of-am-pm (1-12)  number            12
   K       hour-of-am-pm (0-11)        number            0
   k       clock-hour-of-am-pm (1-24)  number            0

   H       hour-of-day (0-23)          number            0
   m       minute-of-hour              number            30
   s       second-of-minute            number            55
   S       fraction-of-second          fraction          978
   A       milli-of-day                number            1234
   n       nano-of-second              number            987654321
   N       nano-of-day                 number            1234000000

   I       time-zone ID                zoneId            America/Los_Angeles
   z       time-zone name              text              Pacific Standard Time; PST
   Z       zone-offset                 offset-Z          +0000; -0800; -08:00;
   X       zone-offset 'Z' for zero    offset-X          Z; -08; -0830; -08:30; -083015; -08:30:15;

   p       pad next                    pad modifier      1

   '       escape for text             delimiter
   ''      single quote                literal           '
   [       optional section start
   ]       optional section end
   {}      reserved for future use
 

The count of pattern letters determine the format.

Text: The text style is determined based on the number of pattern letters used. Less than 4 pattern letters will use the short form. Exactly 4 pattern letters will use the full form. Exactly 5 pattern letters will use the narrow form.

Number: If the count of letters is one, then the value is printed using the minimum number of digits and without padding as per DateTimeFormatterBuilder.appendValue(TemporalField). Otherwise, the count of digits is used as the width of the output field as per DateTimeFormatterBuilder.appendValue(TemporalField, int).

Number/Text: If the count of pattern letters is 3 or greater, use the Text rules above. Otherwise use the Number rules above.

Fraction: Outputs the nano-of-second field as a fraction-of-second. The nano-of-second value has nine digits, thus the count of pattern letters is from 1 to 9. If it is less than 9, then the nano-of-second value is truncated, with only the most significant digits being output. When parsing in strict mode, the number of parsed digits must match the count of pattern letters. When parsing in lenient mode, the number of parsed digits must be at least the count of pattern letters, up to 9 digits.

Year: The count of letters determines the minimum field width below which padding is used. If the count of letters is two, then a reduced two digit form is used. For printing, this outputs the rightmost two digits. For parsing, this will parse using the base value of 2000, resulting in a year within the range 2000 to 2099 inclusive. If the count of letters is less than four (but not two), then the sign is only output for negative years as per SignStyle.NORMAL. Otherwise, the sign is output if the pad width is exceeded, as per SignStyle.EXCEEDS_PAD

ZoneId: 'I' outputs the zone ID, such as 'Europe/Paris'.

Offset X: This formats the offset using 'Z' when the offset is zero. One letter outputs just the hour', such as '+01' Two letters outputs the hour and minute, without a colon, such as '+0130'. Three letters outputs the hour and minute, with a colon, such as '+01:30'. Four letters outputs the hour and minute and optional second, without a colon, such as '+013015'. Five letters outputs the hour and minute and optional second, with a colon, such as '+01:30:15'.

Offset Z: This formats the offset using '+0000' or '+00:00' when the offset is zero. One or two letters outputs the hour and minute, without a colon, such as '+0130'. Three letters outputs the hour and minute, with a colon, such as '+01:30'.

Zone names: Time zone names ('z') cannot be parsed.

Optional section: The optional section markers work exactly like calling DateTimeFormatterBuilder.optionalStart() and DateTimeFormatterBuilder.optionalEnd().

Pad modifier: Modifies the pattern that immediately follows to be padded with spaces. The pad width is determined by the number of pattern letters. This is the same as calling DateTimeFormatterBuilder.padNext(int).

For example, 'ppH' outputs the hour-of-day padded on the left with spaces to a width of 2.

Any unrecognized letter is an error. Any non-letter character, other than '[', ']', '{', '}' and the single quote will be output directly. Despite this, it is recommended to use single quotes around all characters that you want to output directly to ensure that future changes do not break your application.

The pattern string is similar, but not identical, to SimpleDateFormat. Pattern letters 'E' and 'u' are merged, which changes the meaning of "E" and "EE" to be numeric. Pattern letters 'Z' and 'X' are extended. Pattern letter 'y' and 'Y' parse years of two digits and more than 4 digits differently. Pattern letters 'n', 'A', 'N', 'I' and 'p' are added. Number types will reject large numbers. The pattern string is also similar, but not identical, to that defined by the Unicode Common Locale Data Repository (CLDR).

Parameters:

pattern - the pattern to use, not null

Returns:

the formatter based on the pattern, not null

Throws:

IllegalArgumentException - if the pattern is invalid

See Also:

DateTimeFormatterBuilder.appendPattern(String)

pattern

public static DateTimeFormatter pattern(String pattern,
                        Locale locale)

Creates a formatter using the specified pattern.

This method will create a formatter based on a simple pattern of letters and symbols. For example, d MMM yyyy will format 2011-12-03 as '3 Dec 2011'.

See pattern(String) for details of the pattern.

The returned formatter will use the specified locale, but this can be changed using DateTimeFormatter.withLocale(Locale).

Parameters:

pattern - the pattern to use, not null

locale - the locale to use, not null

Returns:

the formatter based on the pattern, not null

Throws:

IllegalArgumentException - if the pattern is invalid

See Also:

DateTimeFormatterBuilder.appendPattern(String)

localizedDate

public static DateTimeFormatter localizedDate(FormatStyle dateStyle)

Returns a locale specific date format.

This returns a formatter that will print/parse a date. The exact format pattern used varies by locale.

The locale is determined from the formatter. The formatter returned directly by this method will use the default locale. The locale can be controlled using withLocale(Locale) on the result of this method.

Note that the localized pattern is looked up lazily. This DateTimeFormatter holds the style required and the locale, looking up the pattern required on demand.

Parameters:

dateStyle - the formatter style to obtain, not null

Returns:

the date formatter, not null

localizedTime

public static DateTimeFormatter localizedTime(FormatStyle timeStyle)

Returns a locale specific time format.

This returns a formatter that will print/parse a time. The exact format pattern used varies by locale.

The locale is determined from the formatter. The formatter returned directly by this method will use the default locale. The locale can be controlled using withLocale(Locale) on the result of this method.

Note that the localized pattern is looked up lazily. This DateTimeFormatter holds the style required and the locale, looking up the pattern required on demand.

Parameters:

timeStyle - the formatter style to obtain, not null

Returns:

the time formatter, not null

localizedDateTime

public static DateTimeFormatter localizedDateTime(FormatStyle dateTimeStyle)

Returns a locale specific date-time format, which is typically of short length.

This returns a formatter that will print/parse a date-time. The exact format pattern used varies by locale.

The locale is determined from the formatter. The formatter returned directly by this method will use the default locale. The locale can be controlled using withLocale(Locale) on the result of this method.

Note that the localized pattern is looked up lazily. This DateTimeFormatter holds the style required and the locale, looking up the pattern required on demand.

Parameters:

dateTimeStyle - the formatter style to obtain, not null

Returns:

the date-time formatter, not null

localizedDateTime

public static DateTimeFormatter localizedDateTime(FormatStyle dateStyle,
                                  FormatStyle timeStyle)

Returns a locale specific date and time format.

This returns a formatter that will print/parse a date-time. The exact format pattern used varies by locale.

The locale is determined from the formatter. The formatter returned directly by this method will use the default locale. The locale can be controlled using withLocale(Locale) on the result of this method.

Note that the localized pattern is looked up lazily. This DateTimeFormatter holds the style required and the locale, looking up the pattern required on demand.

Parameters:

dateStyle - the date formatter style to obtain, not null

timeStyle - the time formatter style to obtain, not null

Returns:

the date, time or date-time formatter, not null

isoLocalDate

public static DateTimeFormatter isoLocalDate()

Returns the ISO date formatter that prints/parses a date without an offset, such as '2011-12-03'.

This returns an immutable formatter capable of printing and parsing the ISO-8601 extended local date format. The format consists of:

• Four digits or more for the year. Years in the range 0000 to 9999 will be pre-padded by zero to ensure four digits. Years outside that range will have a prefixed positive or negative symbol.
• A dash
• Two digits for the month-of-year. This is pre-padded by zero to ensure two digits.
• A dash
• Two digits for the day-of-month. This is pre-padded by zero to ensure two digits.

Returns:

the ISO local date formatter, not null

isoOffsetDate

public static DateTimeFormatter isoOffsetDate()

Returns the ISO date formatter that prints/parses a date with an offset, such as '2011-12-03+01:00'.

This returns an immutable formatter capable of printing and parsing the ISO-8601 extended offset date format. The format consists of:

• The isoLocalDate()
• The offset ID. If the offset has seconds then they will be handled even though this is not part of the ISO-8601 standard. Parsing is case insensitive.

Returns:

the ISO offset date formatter, not null

isoDate

public static DateTimeFormatter isoDate()

Returns the ISO date formatter that prints/parses a date with the offset if available, such as '2011-12-03' or '2011-12-03+01:00'.

This returns an immutable formatter capable of printing and parsing the ISO-8601 extended date format. The format consists of:

• The isoLocalDate()
• If the offset is not available to print/parse then the format is complete.
• The offset ID. If the offset has seconds then they will be handled even though this is not part of the ISO-8601 standard. Parsing is case insensitive.

As this formatter has an optional element, it may be necessary to parse using DateTimeFormatter.parseBest(java.lang.CharSequence, java.lang.Class<?>...).

Returns:

the ISO date formatter, not null

isoLocalTime

public static DateTimeFormatter isoLocalTime()

Returns the ISO time formatter that prints/parses a time without an offset, such as '10:15' or '10:15:30'.

This returns an immutable formatter capable of printing and parsing the ISO-8601 extended local time format. The format consists of:

• Two digits for the hour-of-day. This is pre-padded by zero to ensure two digits.
• A colon
• Two digits for the minute-of-hour. This is pre-padded by zero to ensure two digits.
• If the second-of-minute is not available to print/parse then the format is complete.
• A colon
• Two digits for the second-of-minute. This is pre-padded by zero to ensure two digits.
• If the nano-of-second is zero or not available to print/parse then the format is complete.
• A decimal point
• One to nine digits for the nano-of-second. As many digits will be printed as required.

Returns:

the ISO local time formatter, not null

isoOffsetTime

public static DateTimeFormatter isoOffsetTime()

Returns the ISO time formatter that prints/parses a time with an offset, such as '10:15+01:00' or '10:15:30+01:00'.

This returns an immutable formatter capable of printing and parsing the ISO-8601 extended offset time format. The format consists of:

• The isoLocalTime()
• The offset ID. If the offset has seconds then they will be handled even though this is not part of the ISO-8601 standard. Parsing is case insensitive.

Returns:

the ISO offset time formatter, not null

isoTime

public static DateTimeFormatter isoTime()

Returns the ISO time formatter that prints/parses a time, with the offset if available, such as '10:15', '10:15:30' or '10:15:30+01:00'.

This returns an immutable formatter capable of printing and parsing the ISO-8601 extended offset time format. The format consists of:

• The isoLocalTime()
• If the offset is not available to print/parse then the format is complete.
• The offset ID. If the offset has seconds then they will be handled even though this is not part of the ISO-8601 standard. Parsing is case insensitive.

As this formatter has an optional element, it may be necessary to parse using DateTimeFormatter.parseBest(java.lang.CharSequence, java.lang.Class<?>...).

Returns:

the ISO time formatter, not null

isoLocalDateTime

public static DateTimeFormatter isoLocalDateTime()

Returns the ISO date formatter that prints/parses a date-time without an offset, such as '2011-12-03T10:15:30'.

This returns an immutable formatter capable of printing and parsing the ISO-8601 extended offset date-time format. The format consists of:

• The isoLocalDate()
• The letter 'T'. Parsing is case insensitive.
• The isoLocalTime()

Returns:

the ISO local date-time formatter, not null

isoOffsetDateTime

public static DateTimeFormatter isoOffsetDateTime()

Returns the ISO date formatter that prints/parses a date-time with an offset, such as '2011-12-03T10:15:30+01:00'.

This returns an immutable formatter capable of printing and parsing the ISO-8601 extended offset date-time format. The format consists of:

• The isoLocalDateTime()
• The offset ID. If the offset has seconds then they will be handled even though this is not part of the ISO-8601 standard. Parsing is case insensitive.

Returns:

the ISO offset date-time formatter, not null

isoZonedDateTime

public static DateTimeFormatter isoZonedDateTime()

Returns the ISO date formatter that prints/parses a date-time with offset and zone, such as '2011-12-03T10:15:30+01:00[Europe/Paris]'.

This returns an immutable formatter capable of printing and parsing a format that extends the ISO-8601 extended offset date-time format to add the time-zone. The format consists of:

• The isoOffsetDateTime()
• If the zone ID is not available or is a ZoneOffset then the format is complete.
• An open square bracket '['.
• The zone ID. This is not part of the ISO-8601 standard. Parsing is case sensitive.
• A close square bracket ']'.

Returns:

the ISO zoned date-time formatter, not null

isoDateTime

public static DateTimeFormatter isoDateTime()

Returns the ISO date formatter that prints/parses a date-time with the offset and zone if available, such as '2011-12-03T10:15:30', '2011-12-03T10:15:30+01:00' or '2011-12-03T10:15:30+01:00[Europe/Paris]'.

This returns an immutable formatter capable of printing and parsing the ISO-8601 extended offset date-time format. The format consists of:

• The isoLocalDateTime()
• If the offset is not available to print/parse then the format is complete.
• The offset ID. If the offset has seconds then they will be handled even though this is not part of the ISO-8601 standard.
• If the zone ID is not available or is a ZoneOffset then the format is complete.
• An open square bracket '['.
• The zone ID. This is not part of the ISO-8601 standard. Parsing is case sensitive.
• A close square bracket ']'.

As this formatter has an optional element, it may be necessary to parse using DateTimeFormatter.parseBest(java.lang.CharSequence, java.lang.Class<?>...).

Returns:

the ISO date-time formatter, not null

isoOrdinalDate

public static DateTimeFormatter isoOrdinalDate()

Returns the ISO date formatter that prints/parses the ordinal date without an offset, such as '2012-337'.

This returns an immutable formatter capable of printing and parsing the ISO-8601 extended ordinal date format. The format consists of:

• Four digits or more for the year. Years in the range 0000 to 9999 will be pre-padded by zero to ensure four digits. Years outside that range will have a prefixed positive or negative symbol.
• A dash
• Three digits for the day-of-year. This is pre-padded by zero to ensure three digits.
• If the offset is not available to print/parse then the format is complete.
• The offset ID. If the offset has seconds then they will be handled even though this is not part of the ISO-8601 standard. Parsing is case insensitive.

As this formatter has an optional element, it may be necessary to parse using DateTimeFormatter.parseBest(java.lang.CharSequence, java.lang.Class<?>...).

Returns:

the ISO ordinal date formatter, not null

isoWeekDate

public static DateTimeFormatter isoWeekDate()

Returns the ISO date formatter that prints/parses the week-based date without an offset, such as '2012-W48-6'.

This returns an immutable formatter capable of printing and parsing the ISO-8601 extended week-based date format. The format consists of:

• Four digits or more for the week-based-year. Years in the range 0000 to 9999 will be pre-padded by zero to ensure four digits. Years outside that range will have a prefixed positive or negative symbol.
• A dash
• The letter 'W'. Parsing is case insensitive.
• Two digits for the week-of-week-based-year. This is pre-padded by zero to ensure three digits.
• A dash
• One digit for the day-of-week. The value run from Monday (1) to Sunday (7).
• If the offset is not available to print/parse then the format is complete.
• The offset ID. If the offset has seconds then they will be handled even though this is not part of the ISO-8601 standard. Parsing is case insensitive.

As this formatter has an optional element, it may be necessary to parse using DateTimeFormatter.parseBest(java.lang.CharSequence, java.lang.Class<?>...).

Returns:

the ISO week-based date formatter, not null

isoInstant

public static DateTimeFormatter isoInstant()

Returns the ISO instant formatter that prints/parses an instant in UTC.

This returns an immutable formatter capable of printing and parsing the ISO-8601 instant format. The format consists of:

• The isoOffsetDateTime() where the instant is converted from ChronoField.INSTANT_SECONDS and ChronoField.NANO_OF_SECOND using the UTC offset. Parsing is case insensitive.

Returns:

the ISO instant formatter, not null

basicIsoDate

public static DateTimeFormatter basicIsoDate()

Returns the ISO date formatter that prints/parses a date without an offset, such as '20111203'.

This returns an immutable formatter capable of printing and parsing the ISO-8601 basic local date format. The format consists of:

• Four digits for the year. Only years in the range 0000 to 9999 are supported.
• Two digits for the month-of-year. This is pre-padded by zero to ensure two digits.
• Two digits for the day-of-month. This is pre-padded by zero to ensure two digits.
• If the offset is not available to print/parse then the format is complete.
• The offset ID without colons. If the offset has seconds then they will be handled even though this is not part of the ISO-8601 standard. Parsing is case insensitive.

As this formatter has an optional element, it may be necessary to parse using DateTimeFormatter.parseBest(java.lang.CharSequence, java.lang.Class<?>...).

Returns:

the ISO basic local date formatter, not null

rfc1123

public static DateTimeFormatter rfc1123()

Returns the RFC-1123 date-time formatter, such as 'Tue, 3 Jun 2008 11:05:30 GMT'.

This returns an immutable formatter capable of printing and parsing most of the RFC-1123 format. RFC-1123 updates RFC-822 changing the year from two digits to four. This implementation requires a four digit year. This implementation also does not handle North American or military zone names, only 'GMT' and offset amounts.

The format consists of:

• If the day-of-week is not available to print/parse then jump to day-of-month.
• Three letter day-of-week in English.
• A comma
• A space
• One or two digits for the day-of-month.
• A space
• Three letter month-of-year in English.
• A space
• Four digits for the year. Only years in the range 0000 to 9999 are supported.
• A space
• Two digits for the hour-of-day. This is pre-padded by zero to ensure two digits.
• A colon
• Two digits for the minute-of-hour. This is pre-padded by zero to ensure two digits.
• If the second-of-minute is not available to print/parse then jump to the next space.
• A colon
• Two digits for the second-of-minute. This is pre-padded by zero to ensure two digits.
• A space
• The offset ID without colons or seconds. An offset of zero uses "GMT". North American zone names and military zone names are not handled.

Parsing is case insensitive.

Returns:

the RFC-1123 formatter, not null