commonMain.io.islandtime.parser.DateTimeParserSettings.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of core-metadata Show documentation

A multiplatform library for working with dates and times

There is a newer version: 0.3.1

package io.islandtime.parser

import io.islandtime.format.NumberStyle
import io.islandtime.locale.Locale
import io.islandtime.locale.defaultLocale

/**
 * Settings that control the parsing behavior.
 * @property numberStyle Defines the set of characters that should be used when parsing numbers.
 * @property locale A function that will be invoked to provide a locale if one is needed during parsing.
 */
data class DateTimeParserSettings(
    val numberStyle: NumberStyle = NumberStyle.DEFAULT,
    val locale: () -> Locale = { defaultLocale() },
    val isCaseSensitive: Boolean = true
) {
    constructor(
        numberStyle: NumberStyle = NumberStyle.DEFAULT,
        locale: Locale,
        isCaseSensitive: Boolean = true
    ) : this(numberStyle, { locale }, isCaseSensitive)

    companion object {
        /**
         * The default parser settings.
         */
        val DEFAULT = DateTimeParserSettings()
    }
}