Class DisplayOptions

java.lang.Object

com.ibm.icu.text.DisplayOptions

public final class DisplayOptions
extends Object

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();

Status:

Stable ICU 72.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DisplayOptions.Builder	Responsible for building DisplayOptions.
static enum	DisplayOptions.Capitalization	Represents all the capitalization options.
static enum	DisplayOptions.DisplayLength	Represents all the display lengths.
static enum	DisplayOptions.GrammaticalCase	Represents all the grammatical cases that are supported by CLDR.
static enum	DisplayOptions.NameStyle	Represents all the name styles.
static enum	DisplayOptions.NounClass	Represents all the grammatical noun classes that are supported by CLDR.
static enum	DisplayOptions.PluralCategory	Standard CLDR plural category constants.
static enum	DisplayOptions.SubstituteHandling	Represents all the substitute handlings.

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static DisplayOptions.Builder builder()

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

Returns:

Builder

Status:

Stable ICU 72.

copyToBuilder

public DisplayOptions.Builder copyToBuilder()

Creates a builder with the same parameters from this object.

Returns:

Builder

Status:

Stable ICU 72.

getGrammaticalCase

public DisplayOptions.GrammaticalCase getGrammaticalCase()

Gets the grammatical case.

Returns:

GrammaticalCase

Status:

Stable ICU 72.

getNounClass

public DisplayOptions.NounClass getNounClass()

Gets the noun class.

Returns:

NounClass

Status:

Stable ICU 72.

getPluralCategory

public DisplayOptions.PluralCategory getPluralCategory()

Gets the plural category.

Returns:

PluralCategory

Status:

Stable ICU 72.

getCapitalization

public DisplayOptions.Capitalization getCapitalization()

Gets the capitalization.

Returns:

Capitalization

Status:

Stable ICU 72.

getNameStyle

public DisplayOptions.NameStyle getNameStyle()

Gets the name style.

Returns:

NameStyle

Status:

Stable ICU 72.

getDisplayLength

public DisplayOptions.DisplayLength getDisplayLength()

Gets the display length.

Returns:

DisplayLength

Status:

Stable ICU 72.

getSubstituteHandling

public DisplayOptions.SubstituteHandling getSubstituteHandling()

Gets the substitute handling.

Returns:

SubstituteHandling

Status:

Stable ICU 72.