Top Description Inners Fields Constructors Methods
com.ibm.icu.text

public final Class DisplayOptions

extends Object
Class Inheritance
Imports
java.util.Arrays, .Collections, .List

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

ICU Status
Stable since ICU 72.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
DisplayOptions.Builder

Responsible for building DisplayOptions.

public static enum
DisplayOptions.Capitalization

Represents all the capitalization options.

public static enum
DisplayOptions.DisplayLength

Represents all the display lengths.

public static enum
DisplayOptions.GrammaticalCase

Represents all the grammatical cases that are supported by CLDR.

public static enum
DisplayOptions.NameStyle

Represents all the name styles.

public static enum
DisplayOptions.NounClass

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

public static enum
DisplayOptions.PluralCategory

Standard CLDR plural category constants.

public static enum
DisplayOptions.SubstituteHandling

Represents all the substitute handlings.

Field Summary

Modifier and TypeField and Description
private final DisplayOptions.Capitalization
private final DisplayOptions.DisplayLength
private final DisplayOptions.GrammaticalCase
private final DisplayOptions.NameStyle
private final DisplayOptions.NounClass
private final DisplayOptions.PluralCategory
private final DisplayOptions.SubstituteHandling

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static DisplayOptions.Builder

Returns:

Builder
builder
()

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

public DisplayOptions.Builder

Returns:

Builder
copyToBuilder
()

Creates a builder with the same parameters from this object.

public DisplayOptions.Capitalization

Returns:

Capitalization
getCapitalization
()

Gets the capitalization.

public DisplayOptions.DisplayLength

Returns:

DisplayLength
getDisplayLength
()

Gets the display length.

public DisplayOptions.GrammaticalCase

Returns:

GrammaticalCase
getGrammaticalCase
()

Gets the grammatical case.

public DisplayOptions.NameStyle

Returns:

NameStyle
getNameStyle
()

Gets the name style.

public DisplayOptions.NounClass

Returns:

NounClass
getNounClass
()

Gets the noun class.

public DisplayOptions.PluralCategory

Returns:

PluralCategory
getPluralCategory
()

Gets the plural category.

public DisplayOptions.SubstituteHandling

Returns:

SubstituteHandling
getSubstituteHandling
()

Gets the substitute handling.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait