Added in API level 35

DisplayOptions


class DisplayOptions
kotlin.Any
   ↳ android.icu.text.DisplayOptions

Represents all the display options that are supported by CLDR such as grammatical case, noun class, ... etc. It currently supports enums, but may be extended in the future to have other types of data. It replaces a DisplayContext[] as a method parameter.

NOTE: This class is Immutable, and uses a Builder interface.

For example: DisplayOptions x = DisplayOptions.builder() .setNounClass(NounClass.DATIVE) .setPluralCategory(PluralCategory.FEW) .build();

Summary

Nested classes

Responsible for building DisplayOptions.

Represents all the capitalization options.

Represents all the display lengths.

Represents all the grammatical cases that are supported by CLDR.

Represents all the name styles.

Represents all the grammatical noun classes that are supported by CLDR.

Standard CLDR plural category constants.

Represents all the substitute handlings.

Public methods
static DisplayOptions.Builder!

Creates a builder with the UNDEFINED value for all the parameters.

DisplayOptions.Builder!

Creates a builder with the same parameters from this object.

DisplayOptions.Capitalization!

Gets the capitalization.

DisplayOptions.DisplayLength!

Gets the display length.

DisplayOptions.GrammaticalCase!

Gets the grammatical case.

DisplayOptions.NameStyle!

Gets the name style.

DisplayOptions.NounClass!

Gets the noun class.

DisplayOptions.PluralCategory!

Gets the plural category.

DisplayOptions.SubstituteHandling!

Gets the substitute handling.

Public methods

builder

Added in API level 35
static fun builder(): DisplayOptions.Builder!

Creates a builder with the UNDEFINED value for all the parameters.

Return
DisplayOptions.Builder! Builder

copyToBuilder

Added in API level 35
fun copyToBuilder(): DisplayOptions.Builder!

Creates a builder with the same parameters from this object.

Return
DisplayOptions.Builder! Builder

getCapitalization

Added in API level 35
fun getCapitalization(): DisplayOptions.Capitalization!

Gets the capitalization.

Return
DisplayOptions.Capitalization! Capitalization

getDisplayLength

Added in API level 35
fun getDisplayLength(): DisplayOptions.DisplayLength!

Gets the display length.

Return
DisplayOptions.DisplayLength! DisplayLength

getGrammaticalCase

Added in API level 35
fun getGrammaticalCase(): DisplayOptions.GrammaticalCase!

Gets the grammatical case.

Return
DisplayOptions.GrammaticalCase! GrammaticalCase

getNameStyle

Added in API level 35
fun getNameStyle(): DisplayOptions.NameStyle!

Gets the name style.

Return
DisplayOptions.NameStyle! NameStyle

getNounClass

Added in API level 35
fun getNounClass(): DisplayOptions.NounClass!

Gets the noun class.

Return
DisplayOptions.NounClass! NounClass

getPluralCategory

Added in API level 35
fun getPluralCategory(): DisplayOptions.PluralCategory!

Gets the plural category.

Return
DisplayOptions.PluralCategory! PluralCategory

getSubstituteHandling

Added in API level 35
fun getSubstituteHandling(): DisplayOptions.SubstituteHandling!

Gets the substitute handling.

Return
DisplayOptions.SubstituteHandling! SubstituteHandling