DisplayOptions

Kotlin |Java

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
	`Builder` Responsible for building `DisplayOptions`.
	`Capitalization` Represents all the capitalization options.
	`DisplayLength` Represents all the display lengths.
	`GrammaticalCase` Represents all the grammatical cases that are supported by CLDR.
	`NameStyle` Represents all the name styles.
	`NounClass` Represents all the grammatical noun classes that are supported by CLDR.
	`PluralCategory` Standard CLDR plural category constants.
	`SubstituteHandling` Represents all the substitute handlings.

Public methods
static DisplayOptions.Builder!	`builder()` Creates a builder with the `UNDEFINED` value for all the parameters.
DisplayOptions.Builder!	`copyToBuilder()` Creates a builder with the same parameters from this object.
DisplayOptions.Capitalization!	`getCapitalization()` Gets the capitalization.
DisplayOptions.DisplayLength!	`getDisplayLength()` Gets the display length.
DisplayOptions.GrammaticalCase!	`getGrammaticalCase()` Gets the grammatical case.
DisplayOptions.NameStyle!	`getNameStyle()` Gets the name style.
DisplayOptions.NounClass!	`getNounClass()` Gets the noun class.
DisplayOptions.PluralCategory!	`getPluralCategory()` Gets the plural category.
DisplayOptions.SubstituteHandling!	`getSubstituteHandling()` Gets the substitute handling.

Public methods

builder

Added in API level VanillaIceCream

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 VanillaIceCream

fun copyToBuilder(): DisplayOptions.Builder!

Creates a builder with the same parameters from this object.

Return
`DisplayOptions.Builder!`	Builder

getCapitalization

Added in API level VanillaIceCream

fun getCapitalization(): DisplayOptions.Capitalization!

Gets the capitalization.

Return
`DisplayOptions.Capitalization!`	Capitalization

getDisplayLength

Added in API level VanillaIceCream

fun getDisplayLength(): DisplayOptions.DisplayLength!

Gets the display length.

Return
`DisplayOptions.DisplayLength!`	DisplayLength

getGrammaticalCase

Added in API level VanillaIceCream

fun getGrammaticalCase(): DisplayOptions.GrammaticalCase!

Gets the grammatical case.

Return
`DisplayOptions.GrammaticalCase!`	GrammaticalCase

getNameStyle

Added in API level VanillaIceCream

fun getNameStyle(): DisplayOptions.NameStyle!

Gets the name style.

Return
`DisplayOptions.NameStyle!`	NameStyle

getNounClass

Added in API level VanillaIceCream

fun getNounClass(): DisplayOptions.NounClass!

Gets the noun class.

Return
`DisplayOptions.NounClass!`	NounClass

getPluralCategory

Added in API level VanillaIceCream

fun getPluralCategory(): DisplayOptions.PluralCategory!

Gets the plural category.

Return
`DisplayOptions.PluralCategory!`	PluralCategory

getSubstituteHandling

Added in API level VanillaIceCream

fun getSubstituteHandling(): DisplayOptions.SubstituteHandling!

Gets the substitute handling.

Return
`DisplayOptions.SubstituteHandling!`	SubstituteHandling