net.time4j.format.expert

Enum PatternType

java.lang.Object

java.lang.Enum<PatternType>

net.time4j.format.expert.PatternType

All Implemented Interfaces:

Serializable, Comparable<PatternType>, ChronoPattern<PatternType>

public enum PatternType
extends Enum<PatternType>
implements ChronoPattern<PatternType>

Collection of different format patterns.

Since:

3.0

Author:

Meno Hochschild

See Also:

ChronoFormatter.Builder.addPattern(String, PatternType)

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLDR This standard pattern is applicable on many chronologies and follows the standard LDML of unicode-consortium.
CLDR_24 CLDR-variant with the only difference how the symbol "H" will be interpreted.
CLDR_DATE A small subset of CLDR applicable on many calendar chronologies which have registered the associated elements with same symbols.
DYNAMIC Resolves a pattern such that the chronology used in current context determines the meaning of any pattern symbols.
NON_ISO_DATE Deprecated. Use PatternType.CLDR_DATE as replacement because the name of this pattern type can be confusing considering the fact that not all calendars can be handled by this pattern type (for example, the FrenchRepublicanCalendar is not suitable here)
SIMPLE_DATE_FORMAT Follows the format pattern description of class SimpleDateFormat, which is very near, but not exactly the same as CLDR.

Method Summary

Methods

Modifier and Type	Method and Description
FormatEngine<PatternType>	getFormatEngine()
static PatternType	valueOf(String name) Returns the enum constant of this type with the specified name.
static PatternType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CLDR

public static final PatternType CLDR

This standard pattern is applicable on many chronologies and follows the standard LDML of unicode-consortium.

If not explicitly stated otherwise the count of symbols always controls the minimum count of digits in case of a numerical element. Is an element shorter then the zero digit will be used for padding.

Non-ISO-chronologies are also supported if their elements define CLDR-symbols.

Legend

Element	Symbol	Description
ERA	G	One to three symbols indicate an abbreviation, four symbols indicate the long form and five symbols stand for a letter. The era is based on the chronological history of the current format locale.
YEAR_OF_ERA	y	The count of symbols normally controls the minimum count of digits. If it is 2 however then the year will be printed with exact two digits using the attribute Attributes.PIVOT_YEAR. Important: If the era is not present then this symbol will simply be mapped to PlainDate.YEAR.
PlainDate.YEAR_OF_WEEKDATE	Y	Represents the year in an ISO-8601 week date and behaves like the calendar year in formatting. The week-based year can deviate from the calendar year however because it is bound to the week cycle.
PlainDate.YEAR	u	Proleptic ISO-8601 calendar year. This year never uses a pivot year, also not for "uu". A positive sign will be used exactly if the year has more digits than given by count of symbols. In contrast to the symbol y, this year can never be the historized year-of-era.
RELATED_GREGORIAN_YEAR	r	The related gregorian year corresponds to the begin of the calendar year in non-gregorian calender systems. In ISO-calendar systems, it is identical to the proleptic ISO-8601 calendar year. For formatting or parsing, only the ASCII-digits 0-9 will be used, even if other parts of the format use alternative digits or other numeral systems. The count of symbols is defined within the range 1-9.
PlainDate.QUARTER_OF_YEAR	Q	One or two symbols for the numerical form, three symbols for the abbreviation, four for the full name and five for a letter symbol (NARROW).
PlainDate.QUARTER_OF_YEAR	q	Like Q, but in the version OutputContext.STANDALONE. In some languages (not english) the stand-alone-version requires a special grammar.
MONTH_OF_YEAR	M	One or two symbols for the numerical form, three symbols for the abbreviation, four for the full name and five for a letter symbol (NARROW). Important: If the era is not present then this symbol will simply be mapped to PlainDate.MONTH_OF_YEAR.
MONTH_OF_YEAR	L	Like M, but in the version OutputContext.STANDALONE. In some languages (not english) the stand-alone-version requires a special grammar.
Weekmodel.weekOfYear()	w	One or two symbols for the country-dependent week of year.
Weekmodel.weekOfMonth()	W	One symbol for the country-dependent week of month.
DAY_OF_MONTH	d	One or two symbols for the day of month. Important: If the era is not present then this symbol will simply be mapped to PlainDate.DAY_OF_MONTH.
DAY_OF_YEAR	D	One, two or three symbols for the day of year. Important: If the era is not present then this symbol will simply be mapped to PlainDate.DAY_OF_YEAR.
WEEKDAY_IN_MONTH	F	One symbol for the weekday in month.
EpochDays.MODIFIED_JULIAN_DATE	g	The count of symbols usually controls the minimum count of digits of modified julian year, that is the count of days relative to 1858-11-17. Is only supported by calendrical types like PlainDate.
PlainDate.DAY_OF_WEEK	E	One to three symbols for the abbreviation, four for the full name, five for a letter symbol or six for the short form.
Weekmodel.localDayOfWeek()	e	Like E, but if there are only one or two symbols then the formatter will choose the localized numerical form.
Weekmodel.localDayOfWeek()	c	Like e, but in the version OutputContext.STANDALONE. In some languages (not english) the stand-alone-version requires a special grammar. However, 2 symbols are not allowed.
PlainTime.AM_PM_OF_DAY	a	1-3 symbols for the short form, 4 symbols for the full text form and 5 symbols for the narrow form.
DayPeriod.fixed()	b	1-3 symbols for the short form, 4 symbols for the full text form and 5 symbols for the narrow form.
DayPeriod.approximate()	B	1-3 symbols for the short form, 4 symbols for the full text form and 5 symbols for the narrow form.
PlainTime.CLOCK_HOUR_OF_AMPM	h	One or two symbols for the numerical form.
PlainTime.DIGITAL_HOUR_OF_DAY	H	One or two symbols for the numerical form.
PlainTime.DIGITAL_HOUR_OF_AMPM	K	One or two symbols for the numerical form.
PlainTime.CLOCK_HOUR_OF_DAY	k	One or two symbols for the numerical form.
PlainTime.MINUTE_OF_HOUR	m	One or two symbols for the numerical form.
PlainTime.SECOND_OF_MINUTE	s	One or two symbols for the numerical form.
PlainTime.NANO_OF_SECOND	S	The count of symbols (1-9) controls the minimum and maximum count of digits to be printed. The decimal separation char will not be printed.
PlainTime.MILLI_OF_DAY	A	The count of symbols (1-9) controls the minimum count of digits to be printed.
TIMEZONE_NAME	z	1-3 symbols for the abbreviation, 4 symbols for the full timezone name. The specific non-location format will be used, for example "Pacific Daylight Time" (PDT) or "Pacific Standard Time" (PST). This symbol can only be applied on the type Moment.
TIMEZONE_OFFSET	Z	1-3 symbols => see xxxx, 4 symbols => see OOOO, 5 symbols = > see XXXXX.
LOCALIZED_GMT_OFFSET	O	One symbol for the abbreviation or 4 symbols for the long variant. The GMT-prefix can be suppressed by help of the format attribute Attributes.NO_GMT_PREFIX. See also ChronoFormatter.Builder.addLongLocalizedOffset() or its short counter part.
TIMEZONE_ID	V	The count of pattern symbols must always be 2. This symbol can only be applied on the type Moment.
ISO_TIMEZONE_OFFSET	X	One symbol: ±HH[mm], two symbols: ±HHmm, three symbols: ±HH:mm, four symbols: ±HHmm[ss[.{fraction}]], five symbols: ±HH:mm[:ss[.{fraction}]]. If the timezone offset is equal to 0 then the letter "Z" will be used.
ISO_TIMEZONE_OFFSET	x	Like X but without the special char "Z" if the timezone offset is equal to 0.

Special notes for the Ethiopian calendar:

The Ethiopian year will use the Ethiopic numerals in Amharic. This default behaviour can be overridden on builder-level. And the clock time (symbol "h") will use the Ethiopian time starting at 6 AM in the morning.

Warning: CLDR-like date patterns are only applicable when the calendar in question always contains a month for any date. This underlying assumption is not true for example for the French revolutionary calendar.

SIMPLE_DATE_FORMAT

public static final PatternType SIMPLE_DATE_FORMAT

Follows the format pattern description of class SimpleDateFormat, which is very near, but not exactly the same as CLDR.

The permitted count of digits is usually unlimited. Users should treat this setting only as approximation to any real implementation of SimpleDateFormat. For example, this pattern style is only applicable on ISO-compatible chronologies. Android will define some symbols in a different way. Other deviations from PatternType.CLDR:

Legend

Element	Symbol	Description
ISO_DAY_OF_WEEK	u	Corresponds to the weekday-numbering of ISO-8601-standard (Weekmodel.ISO.localDayOfWeek()), that is: Mo=1, Di=2, Mi=3, Do=4, Fr=5, Sa=6, So=7.
Weekmodel.boundedWeekOfMonth()	W	One symbol for the country-dependent week of month.
PlainTime.MILLI_OF_SECOND	S	No fractional but only integral display of millisecond.
QUARTER_OF_YEAR	Q	Not supported (as work-around: use CLDR).
QUARTER_OF_YEAR	q	Not supported (as work-around: use CLDR).
RELATED_GREGORIAN_YEAR	r	Not supported (as work-around: use CLDR).
MODIFIED_JULIAN_DATE	g	Not supported (as work-around: use CLDR).
{local-day-of-week-number}	e	Not supported (as work-around: use CLDR).
{local-day-of-week-number}	c	Not supported (as work-around: use CLDR).
PlainTime.AM_PM_OF_DAY	a	Only the short form is supported.
DayPeriod.fixed()	b	Not supported (as work-around: use CLDR).
DayPeriod.approximate()	B	Not supported (as work-around: use CLDR).
RFC_822_TIMEZONE_OFFSET	Z	Equivalent to CLDR-xx.
LOCALIZED_GMT_OFFSET	O	Not supported (as work-around: use CLDR).
TIMEZONE_ID	V	Not supported (as work-around: use CLDR).
ISO_TIMEZONE_OFFSET	X	Like in CLDR, but with only three symbols as upper limit.
ISO_TIMEZONE_OFFSET	x	Not supported (as work-around: use CLDR).

CLDR_24

public static final PatternType CLDR_24

CLDR-variant with the only difference how the symbol "H" will be interpreted.

Deviations from PatternType.CLDR:

Legend

Element	Symbol	Description
PlainTime.HOUR_FROM_0_TO_24	H	Hour of day - in full range 0-24 (the value 24 is only permitted if all other time parts are zero).

Since:

3.4/4.3

CLDR_DATE

public static final PatternType CLDR_DATE

A small subset of CLDR applicable on many calendar chronologies which have registered the associated elements with same symbols.

If not explicitly stated otherwise the count of symbols always controls the minimum count of digits in case of a numerical element. Is an element shorter then the zero digit will be used for padding.

Legend

Element	Symbol	Description
ERA	G	One to three symbols indicate an abbreviation, four symbols indicate the long form and five symbols stand for a letter.
YEAR_OF_ERA	y	The count of symbols normally controls the minimum count of digits. If it is 2 however then the year will be printed with exact two digits using the attribute Attributes.PIVOT_YEAR.
MONTH_OF_YEAR	M	One or two symbols for the numerical form, three symbols for the abbreviation, four for the full name and five for a letter symbol (NARROW).
MONTH_OF_YEAR	L	Like M, but in the version OutputContext.STANDALONE. In some languages (not english) the stand-alone-version requires a special grammar.
WEEK_OF_YEAR	w	One or two symbols for the country-dependent week of year.
WEEK_OF_MONTH	W	One symbol for the country-dependent week of month.
DAY_OF_MONTH	d	One or two symbols for the day of month.
DAY_OF_YEAR	D	One, two or three symbols for the day of year.
DAY_OF_WEEK	E	One to three symbols for the abbreviation, four for the full name, five for a letter symbol or six for the short form.
WEEKDAY_IN_MONTH	F	One symbol for the weekday in month.
LOCAL_DAY_OF_WEEK	e	Like E, but if there are only one or two symbols then the formatter will choose the localized numerical form.
LOCAL_DAY_OF_WEEK	c	Like e, but in the version OutputContext.STANDALONE. In some languages (not english) the stand-alone-version requires a special grammar. However, 2 symbols are not allowed.
RELATED_GREGORIAN_YEAR	r	The related gregorian year corresponds to the begin of the calendar year in non-gregorian calender systems. For formatting or parsing, only the ASCII-digits 0-9 will be used, even if other parts of the format use alternative digits or other numeral systems. The count of symbols is defined within the range 1-9.

Special notes for the Ethiopian calendar:

The Ethiopian year will use the Ethiopic numerals in Amharic. This default behaviour can be overridden on builder-level using a sectional attribute for the number system.

Warning: CLDR-like date patterns are only applicable when the calendar in question always contains a month for any date. This underlying assumption is not true for example for the French revolutionary calendar.

Since:

3.33/4.28

NON_ISO_DATE

@Deprecated
public static final PatternType NON_ISO_DATE

Deprecated. Use PatternType.CLDR_DATE as replacement because the name of this pattern type can be confusing considering the fact that not all calendars can be handled by this pattern type (for example, the FrenchRepublicanCalendar is not suitable here)

A small subset of CLDR applicable on any non-ISO-chronology which has registered the associated elements with same symbols.

If not explicitly stated otherwise the count of symbols always controls the minimum count of digits in case of a numerical element. Is an element shorter then the zero digit will be used for padding.

Legend

Element	Symbol	Description
ERA	G	One to three symbols indicate an abbreviation, four symbols indicate the long form and five symbols stand for a letter.
YEAR_OF_ERA	y	The count of symbols normally controls the minimum count of digits. If it is 2 however then the year will be printed with exact two digits using the attribute Attributes.PIVOT_YEAR.
MONTH_OF_YEAR	M	One or two symbols for the numerical form, three symbols for the abbreviation, four for the full name and five for a letter symbol (NARROW).
MONTH_OF_YEAR	L	Like M, but in the version OutputContext.STANDALONE. In some languages (not english) the stand-alone-version requires a special grammar.
WEEK_OF_YEAR	w	One or two symbols for the country-dependent week of year.
WEEK_OF_MONTH	W	One symbol for the country-dependent week of month.
DAY_OF_MONTH	d	One or two symbols for the day of month.
DAY_OF_YEAR	D	One, two or three symbols for the day of year.
DAY_OF_WEEK	E	One to three symbols for the abbreviation, four for the full name, five for a letter symbol or six for the short form.
WEEKDAY_IN_MONTH	F	One symbol for the weekday in month.
LOCAL_DAY_OF_WEEK	e	Like E, but if there are only one or two symbols then the formatter will choose the localized numerical form.
LOCAL_DAY_OF_WEEK	c	Like e, but in the version OutputContext.STANDALONE. In some languages (not english) the stand-alone-version requires a special grammar. However, 2 symbols are not allowed.
RELATED_GREGORIAN_YEAR	r	The related gregorian year corresponds to the begin of the calendar year in non-gregorian calender systems. For formatting or parsing, only the ASCII-digits 0-9 will be used, even if other parts of the format use alternative digits or other numeral systems. The count of symbols is defined within the range 1-9.

Special notes for the Ethiopian calendar:

The Ethiopian year will use the Ethiopic numerals in Amharic. This default behaviour can be overridden on builder-level.

Since:

3.5/4.3

DYNAMIC

public static final PatternType DYNAMIC

Resolves a pattern such that the chronology used in current context determines the meaning of any pattern symbols.

In contrast to other pattern types like CLDR, the meaning of pattern symbols is not defined by any external standard. The elements associated with symbols are looked up among the registered elements of a chronology including those which can be found via any chronological extension. If the found element is a text element then it will be treated as such, and the count of symbols determines the text width (1 = NARROW, 2 = SHORT, 3 = ABBREVIATED, 4 = WIDE). Otherwise this pattern type tries to resolve the element in question as ChronoElement<Integer>, and the count of symbols will determine the min width of displayed/parsed digits and apply some padding if necessary. The maximum width is always 9, and no sign is used.

Since:

3.33/4.20

See Also:

ChronoElement.getSymbol()

Method Detail

values

public static PatternType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PatternType c : PatternType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PatternType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getFormatEngine

public FormatEngine<PatternType> getFormatEngine()

Specified by:

getFormatEngine in interface ChronoPattern<PatternType>