i18n4k-core/de.comahe.i18n4k

Package-level declarations

Types

DefaultLocaleImpl

class DefaultLocaleImpl(language: String, script: String, country: String, variant: String, extensions: ImmutableMap<Char, String>)

Default implementation for Locale for non JVM targets

expect class Locale

Class representing a locale

actual typealias Locale = DefaultLocaleImpl

actual typealias Locale = java.util.Locale

actual typealias Locale = DefaultLocaleImpl

Properties

val Locale.country: String

Property to access Locale.getCountry

var i18n4k: I18n4kConfig

Global instance to give access to the configuration

val Locale.language: String

Property to access Locale.getLanguage

lessSpecificLocale

val Locale.lessSpecificLocale: Locale

Creates a locale that is one step less specific than this locale.

val rootLocale: Locale

Useful constant for the root locale.

val Locale.script: String

Property to access Locale.getScript

actual val systemLocale: Locale

expect val systemLocale: Locale

The current locale of the system or user

actual val systemLocale: Locale

actual val systemLocale: Locale

actual val systemLocale: Locale

actual val systemLocale: Locale

val Locale.variant: String

Property to access Locale.getVariant

Functions

inline fun <R> applyLocales(localeToStart: Locale? = null, block: (Locale) -> R?): R?

Applies all possible locales in the chain, until block returns a non-null value and returns this value.

createDefaultLocaleImpl

fun createDefaultLocaleImpl(language: String, script: String?, country: String?, variant: String?, extensions: Map<Char, String>?): DefaultLocaleImpl

Default implementation for createLocale for non JVM targets

expect fun createLocale(language: String, script: String? = null, country: String? = null, variant: String? = null, extensions: Map<Char, String>? = null): Locale

Create a local with extensions.

actual fun createLocale(language: String, script: String?, country: String?, variant: String?, extensions: Map<Char, String>?): Locale

actual fun createLocale(language: String, script: String?, country: String?, variant: String?, extensions: Map<Char, String>?): Locale

actual fun createLocale(language: String, script: String?, country: String?, variant: String?, extensions: Map<Char, String>?): Locale

fun forLocaleTag(languageTag: String, separator: Char = '_', separator2: Char = '-'): Locale

Transforms a languageTag like "en_US_texas" to a Locale("en","US","texas")

getDisplayNameInLocale

fun Locale.getDisplayNameInLocale(): String

Returns a name for the locale that is appropriate for display to the user in the language of the locale

removeExtensions

fun Locale.removeExtensions(): Locale

Returns a copy of this (or this itself) Locale with no extensions.

fun toLocaleTag(language: String, script: String, country: String, variant: String, extensions: Map<Char, String>?, separator: String = "_"): String

fun Locale.toTag(separator: String = "_"): String