readium-shared/org.readium.r2.shared.publication/LocalizedString

LocalizedString

data class LocalizedString(val translations: Map<String?, LocalizedString.Translation> = emptyMap()) : JSONable, Parcelable

Represents a string with multiple translations indexed by a BCP 47 language tag.

Constructors

LocalizedString

constructor(translations: Map<String?, LocalizedString.Translation> = emptyMap())

constructor(value: String, lang: String? = null)

Shortcut to create a LocalizedString using a single string for a given language.

Types

Companion

object Companion

Translation

data class Translation(val string: String) : Parcelable

Properties

defaultTranslation

val defaultTranslation: LocalizedString.Translation

The default translation for this localized string.

string

val string: String

The default translation string for this localized string. This is a shortcut for apps.

translations

val translations: Map<String?, LocalizedString.Translation>

Functions

copyWithString

fun copyWithString(language: String?, string: String): LocalizedString

Returns a new LocalizedString after adding (or replacing) the translation with the given language.

describeContents

abstract fun describeContents(): Int

getOrFallback

fun getOrFallback(language: String?): LocalizedString.Translation?

Returns the first translation for the given language BCP–47 tag. If not found, then fallback: 1. on the default Locale 2. on the undefined language 3. on the English language 4. the first translation found

mapLanguages

fun mapLanguages(transform: (Map.Entry<String?, LocalizedString.Translation>) -> String?): LocalizedString

Returns a new LocalizedString after applying the transform function to each language.

mapTranslations

fun mapTranslations(transform: (Map.Entry<String?, LocalizedString.Translation>) -> LocalizedString.Translation): LocalizedString

Returns a new LocalizedString after applying the transform function to each translation.

toJSON

open override fun toJSON(): JSONObject

Serializes a LocalizedString to its RWPM JSON representation.

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)