All Implemented Interfaces:

android.os.Parcelable , org.readium.r2.shared.JSONable
```
public final class LocalizedString
 implements JSONable, Parcelable
                    
```
Represents a string with multiple translations indexed by a BCP 47 language tag.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`LocalizedString.Translation`
`public class`	`LocalizedString.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final LocalizedString.Translation`	`defaultTranslation`
`private final String`	`string`
`private final String`	`singleString`
`private final Map<String, String>`	`multiString`
`private final Map<String, LocalizedString.Translation>`	`translations`

Constructor Summary

Constructors
Constructor	Description
`LocalizedString(String value, String lang)`	Shortcut to create a LocalizedString using a single string for a given language.
`LocalizedString(Map<String, LocalizedString.Translation> translations)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final LocalizedString.Translation`	`getDefaultTranslation()`
`final String`	`getString()`
`final String`	`getSingleString()`
`final Map<String, String>`	`getMultiString()`
`final Map<String, LocalizedString.Translation>`	`getTranslations()`
`final LocalizedString.Translation`	`getOrFallback(String language)`	Returns the first translation for the given language BCP–47 tag.
`final LocalizedString`	`copyWithString(String language, String string)`	Returns a new LocalizedString after adding (or replacing) the translation with the given language.
`final LocalizedString`	`mapLanguages(Function1<Entry.Map<String, LocalizedString.Translation>, String> transform)`	Returns a new LocalizedString after applying the transform function to each language.
`final LocalizedString`	`mapTranslations(Function1<Entry.Map<String, LocalizedString.Translation>, LocalizedString.Translation> transform)`	Returns a new LocalizedString after applying the transform function to each translation.
`JSONObject`	`toJSON()`	Serializes a LocalizedString to its RWPM JSON representation.

Methods inherited from class android.os.Parcelable
describeContents, writeToParcel
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LocalizedString
```
LocalizedString(String value, String lang)
```
    Shortcut to create a LocalizedString using a single string for a given language.
  - LocalizedString
```
LocalizedString(Map<String, LocalizedString.Translation> translations)
```
- Method Detail
  - getDefaultTranslation
```
 final LocalizedString.Translation getDefaultTranslation()
```
  - getString
```
 final String getString()
```
  - getSingleString
```
 final String getSingleString()
```
  - getMultiString
```
 final Map<String, String> getMultiString()
```
  - getTranslations
```
 final Map<String, LocalizedString.Translation> getTranslations()
```
  - getOrFallback
```
 final LocalizedString.Translation getOrFallback(String language)
```
    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
  - copyWithString
```
 final LocalizedString copyWithString(String language, String string)
```
    Returns a new LocalizedString after adding (or replacing) the translation with the given language.
  - mapLanguages
```
 final LocalizedString mapLanguages(Function1<Entry.Map<String, LocalizedString.Translation>, String> transform)
```
    Returns a new LocalizedString after applying the transform function to each language.
  - mapTranslations
```
 final LocalizedString mapTranslations(Function1<Entry.Map<String, LocalizedString.Translation>, LocalizedString.Translation> transform)
```
    Returns a new LocalizedString after applying the transform function to each translation.
  - toJSON
```
 JSONObject toJSON()
```
    Serializes a LocalizedString to its RWPM JSON representation.

Class LocalizedString

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class android.os.Parcelable

Methods inherited from class java.lang.Object

Constructor Detail

LocalizedString

LocalizedString

Method Detail

getDefaultTranslation

getString

getSingleString

getMultiString

getTranslations

getOrFallback

copyWithString

mapLanguages

mapTranslations

toJSON