DateTimePatternGenerator

DAY

static val DAY: Int

Value: 7

DAYPERIOD

static val DAYPERIOD: Int

Value: 10

DAY_OF_WEEK_IN_MONTH

static val DAY_OF_WEEK_IN_MONTH: Int

Value: 9

DAY_OF_YEAR

static val DAY_OF_YEAR: Int

Value: 8

ERA

static val ERA: Int

Value: 0

FRACTIONAL_SECOND

static val FRACTIONAL_SECOND: Int

Value: 14

HOUR

static val HOUR: Int

Value: 11

MATCH_ALL_FIELDS_LENGTH

static val MATCH_ALL_FIELDS_LENGTH: Int

Option mask for forcing the width of all date and time fields.

Value: 65535

MATCH_HOUR_FIELD_LENGTH

static val MATCH_HOUR_FIELD_LENGTH: Int

Option mask for forcing the width of hour field.

Value: 2048

MATCH_NO_OPTIONS

static val MATCH_NO_OPTIONS: Int

Default option mask used for getBestPattern(java.lang.String,int) and replaceFieldTypes(java.lang.String,java.lang.String,int).

Value: 0

MINUTE

static val MINUTE: Int

Value: 12

MONTH

static val MONTH: Int

Value: 3

QUARTER

static val QUARTER: Int

Value: 2

SECOND

static val SECOND: Int

Value: 13

WEEKDAY

static val WEEKDAY: Int

Value: 6

WEEK_OF_MONTH

static val WEEK_OF_MONTH: Int

Value: 5

WEEK_OF_YEAR

static val WEEK_OF_YEAR: Int

Value: 4

YEAR

static val YEAR: Int

Value: 1

ZONE

static val ZONE: Int

Value: 15

DateTimePatternGenerator

protected DateTimePatternGenerator()

Only for use by subclasses

addPattern

open fun addPattern(
    pattern: String!, 
    override: Boolean, 
    returnInfo: DateTimePatternGenerator.PatternInfo!
): DateTimePatternGenerator!

Adds a pattern to the generator. If the pattern has the same skeleton as an existing pattern, and the override parameter is set, then the previous value is overridden. Otherwise, the previous value is retained. In either case, the conflicting information is returned in PatternInfo.

Note that single-field patterns (like "MMM") are automatically added, and don't need to be added explicitly! *

Example code:

clone

open fun clone(): Any

Returns a copy of this DateTimePatternGenerator object.

cloneAsThawed

open fun cloneAsThawed(): DateTimePatternGenerator!

Provides for the clone operation. Any clone is initially unfrozen.

freeze

open fun freeze(): DateTimePatternGenerator!

Freezes the object.

getAppendItemFormat

open fun getAppendItemFormat(field: Int): String!

Getter corresponding to setAppendItemFormats. Values below 0 or at or above TYPE_LIMIT are illegal arguments.

getAppendItemName

open fun getAppendItemName(field: Int): String!

Getter corresponding to setAppendItemName. Values below 0 or at or above TYPE_LIMIT are illegal arguments. Note: The more general method for getting date/time field display names is getFieldDisplayName.

getBaseSkeleton

open fun getBaseSkeleton(pattern: String!): String!

Utility to return a unique base skeleton from a given pattern. This is the same as the skeleton, except that differences in length are minimized so as to only preserve the difference between string and numeric form. So for example, both "MMM-dd" and "d/MMM" produce the skeleton "MMMd" (notice the single d).

getBaseSkeletons

open fun getBaseSkeletons(result: MutableSet<String!>!): MutableSet<String!>!

Return a list of all the base skeletons (in canonical form) from this class

getBestPattern

open fun getBestPattern(skeleton: String!): String!

Return the best pattern matching the input skeleton. It is guaranteed to have all of the fields in the skeleton.

Example code:

getBestPattern

open fun getBestPattern(
    skeleton: String!, 
    options: Int
): String!

Return the best pattern matching the input skeleton. It is guaranteed to have all of the fields in the skeleton.

getDateTimeFormat

open fun getDateTimeFormat(): String!

Getter corresponding to setDateTimeFormat. There are four DateTimeFormats in a DateTimePatternGenerator object, corresponding to date styles DateFormat.FULL..DateFormat.SHORT. This method gets the style for DateFormat.MEDIUM (the default). To get them individually, see getDateTimeFormat(int style).

getDateTimeFormat

open fun getDateTimeFormat(style: Int): String!

Getter corresponding to setDateTimeFormat.

getDecimal

open fun getDecimal(): String!

Getter corresponding to setDecimal.

getDefaultHourCycle

open fun getDefaultHourCycle(): DateFormat.HourCycle!

Return the default hour cycle.

getEmptyInstance

open static fun getEmptyInstance(): DateTimePatternGenerator!

Create empty generator, to be constructed with addPattern(...) etc.

getFieldDisplayName

open fun getFieldDisplayName(
    field: Int, 
    width: DateTimePatternGenerator.DisplayWidth!
): String!

The general interface to get a display name for a particular date/time field, in one of several possible display widths.

getInstance

open static fun getInstance(): DateTimePatternGenerator!

Construct a flexible generator according to data for the default FORMAT locale.

getInstance

open static fun getInstance(uLocale: ULocale!): DateTimePatternGenerator!

Construct a flexible generator according to data for a given locale.

getInstance

open static fun getInstance(locale: Locale!): DateTimePatternGenerator!

Construct a flexible generator according to data for a given locale.

getSkeleton

open fun getSkeleton(pattern: String!): String!

Utility to return a unique skeleton from a given pattern. For example, both "MMM-dd" and "dd/MMM" produce the skeleton "MMMdd".

getSkeletons

open fun getSkeletons(result: MutableMap<String!, String!>!): MutableMap<String!, String!>!

Return a list of all the skeletons (in canonical form) from this class, and the patterns that they map to.

isFrozen

open fun isFrozen(): Boolean

Determines whether the object has been frozen or not.

replaceFieldTypes

open fun replaceFieldTypes(
    pattern: String!, 
    skeleton: String!
): String!

Adjusts the field types (width and subtype) of a pattern to match what is in a skeleton. That is, if you supply a pattern like "d-M H:m", and a skeleton of "MMMMddhhmm", then the input pattern is adjusted to be "dd-MMMM hh:mm". This is used internally to get the best match for the input skeleton, but can also be used externally.

Example code:

replaceFieldTypes

open fun replaceFieldTypes(
    pattern: String!, 
    skeleton: String!, 
    options: Int
): String!

Adjusts the field types (width and subtype) of a pattern to match what is in a skeleton. That is, if you supply a pattern like "d-M H:m", and a skeleton of "MMMMddhhmm", then the input pattern is adjusted to be "dd-MMMM hh:mm". This is used internally to get the best match for the input skeleton, but can also be used externally.

setAppendItemFormat

open fun setAppendItemFormat(
    field: Int, 
    value: String!
): Unit

An AppendItem format is a pattern used to append a field if there is no good match. For example, suppose that the input skeleton is "GyyyyMMMd", and there is no matching pattern internally, but there is a pattern matching "yyyyMMMd", say "d-MM-yyyy". Then that pattern is used, plus the G. The way these two are conjoined is by using the AppendItemFormat for G (era). So if that value is, say "{0}, {1}" then the final resulting pattern is "d-MM-yyyy, G".

There are actually three available variables: {0} is the pattern so far, {1} is the element we are adding, and {2} is the name of the element.

This reflects the way that the CLDR data is organized.

setAppendItemName

open fun setAppendItemName(
    field: Int, 
    value: String!
): Unit

Sets the names of fields, eg "era" in English for ERA. These are only used if the corresponding AppendItemFormat is used, and if it contains a {2} variable.

This reflects the way that the CLDR data is organized.

setDateTimeFormat

open fun setDateTimeFormat(
    style: Int, 
    dateTimeFormat: String!
): Unit

dateTimeFormats are message patterns used to compose combinations of date and time patterns. There are four length styles, corresponding to the inferred style of the date pattern: - DateFormat.FULL (for date pattern with weekday and long month), else - DateFormat.LONG (for a date pattern with long month), else - DateFormat.MEDIUM (for a date pattern with abbreviated month), else - DateFormat.SHORT (for any other date pattern). For details on dateTimeFormats, see https://www.unicode.org/reports/tr35/tr35-dates.html#dateTimeFormats. The default pattern in the root locale for all styles is "{1} {0}".

setDateTimeFormat

open fun setDateTimeFormat(dateTimeFormat: String!): Unit

The date time format is a message format pattern used to compose date and time patterns. The default value is "{1} {0}", where {1} will be replaced by the date pattern and {0} will be replaced by the time pattern.

This is used when the input skeleton contains both date and time fields, but there is not a close match among the added patterns. For example, suppose that this object was created by adding "dd-MMM" and "hh:mm", and its datetimeFormat is the default "{1} {0}". Then if the input skeleton is "MMMdhmm", there is not an exact match, so the input skeleton is broken up into two components "MMMd" and "hmm". There are close matches for those two skeletons, so the result is put together with this pattern, resulting in "d-MMM h:mm". There are four DateTimeFormats in a DateTimePatternGenerator object, corresponding to date styles DateFormat.FULL..DateFormat.SHORT. This method sets all of them to the specified pattern. To set them individually, see setDateTimeFormat(int style, ...).

setDecimal

open fun setDecimal(decimal: String!): Unit

The decimal value is used in formatting fractions of seconds. If the skeleton contains fractional seconds, then this is used with the fractional seconds. For example, suppose that the input pattern is "hhmmssSSSS", and the best matching pattern internally is "H:mm:ss", and the decimal string is ",". Then the resulting pattern is modified to be "H:mm:ss,SSSS"