Added in API level 24

Summary: Enums | Methods | Inherited Methods

DisplayContext

Kotlin |Java

public final enum DisplayContext
extends Enum<DisplayContext>

java.lang.Object
↳	java.lang.Enum<android.icu.text.DisplayContext>
	↳	android.icu.text.DisplayContext

Display context settings. Note, the specific numeric values are internal and may change.

Summary

Enum values
`DisplayContext`	`CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE` A possible setting for CAPITALIZATION: The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for the beginning of a sentence.
`DisplayContext`	`CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE` A possible setting for CAPITALIZATION: The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for the middle of a sentence.
`DisplayContext`	`CAPITALIZATION_FOR_STANDALONE` A possible setting for CAPITALIZATION: The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for stand-alone usage such as an isolated name on a calendar page.
`DisplayContext`	`CAPITALIZATION_FOR_UI_LIST_OR_MENU` A possible setting for CAPITALIZATION: The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for a user-interface list or menu item.
`DisplayContext`	`CAPITALIZATION_NONE` A possible setting for CAPITALIZATION: The capitalization context to be used is unknown (this is the default value).
`DisplayContext`	`DIALECT_NAMES` A possible setting for DIALECT_HANDLING: use dialect names, when generating a locale name, e.g. en_GB displays as 'British English'.
`DisplayContext`	`LENGTH_FULL` A possible setting for DISPLAY_LENGTH: use full names when generating a locale name, e.g. "United States" for US.
`DisplayContext`	`LENGTH_SHORT` A possible setting for DISPLAY_LENGTH: use short names when generating a locale name, e.g. "U.S." for US.
`DisplayContext`	`NO_SUBSTITUTE` A possible setting for SUBSTITUTE_HANDLING: Returns a null value when no data is available.
`DisplayContext`	`STANDARD_NAMES` A possible setting for DIALECT_HANDLING: use standard names when generating a locale name, e.g. en_GB displays as 'English (United Kingdom)'.
`DisplayContext`	`SUBSTITUTE` A possible setting for SUBSTITUTE_HANDLING: Returns a fallback value (e.g., the input code) when no data is available.

Public methods
`DisplayContext.Type`	`type()` Get the Type part of the enum item (e.g. CAPITALIZATION)
`int`	`value()` Get the value part of the enum item (e.g. CAPITALIZATION_FOR_STANDALONE)
`static DisplayContext`	`valueOf(String name)`
`static final DisplayContext[]`	`values()`

Inherited methods

From class


        
          java.lang.Enum

`final Object`	`clone()` Throws CloneNotSupportedException.
`final int`	`compareTo(DisplayContext o)` Compares this enum with the specified object for order.
`final boolean`	`equals(Object other)` Returns true if the specified object is equal to this enum constant.
`final void`	`finalize()` enum classes cannot have finalize methods.
`final Class<DisplayContext>`	`getDeclaringClass()` Returns the Class object corresponding to this enum constant's enum type.
`final int`	`hashCode()` Returns a hash code for this enum constant.
`final String`	`name()` Returns the name of this enum constant, exactly as declared in its enum declaration.
`final int`	`ordinal()` Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial constant is assigned an ordinal of zero).
`String`	`toString()` Returns the name of this enum constant, as contained in the declaration.
`static <T extends Enum<T>> T`	`valueOf(Class<T> enumClass, String name)` Returns the enum constant of the specified enum class with the specified name.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.lang.Comparable


      compareTo(DisplayContext o)

Compares this object with the specified object for order.

Enum values

CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE

Added in API level 24

public static final DisplayContext CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE

A possible setting for CAPITALIZATION: The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for the beginning of a sentence.

CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE

Added in API level 24

public static final DisplayContext CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE

A possible setting for CAPITALIZATION: The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for the middle of a sentence.

CAPITALIZATION_FOR_STANDALONE

Added in API level 24

public static final DisplayContext CAPITALIZATION_FOR_STANDALONE

A possible setting for CAPITALIZATION: The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for stand-alone usage such as an isolated name on a calendar page.

CAPITALIZATION_FOR_UI_LIST_OR_MENU

Added in API level 24

public static final DisplayContext CAPITALIZATION_FOR_UI_LIST_OR_MENU

A possible setting for CAPITALIZATION: The capitalization context if a date, date symbol or display name is to be formatted with capitalization appropriate for a user-interface list or menu item.

CAPITALIZATION_NONE

Added in API level 24

public static final DisplayContext CAPITALIZATION_NONE

A possible setting for CAPITALIZATION: The capitalization context to be used is unknown (this is the default value).

DIALECT_NAMES

Added in API level 24

public static final DisplayContext DIALECT_NAMES

A possible setting for DIALECT_HANDLING: use dialect names, when generating a locale name, e.g. en_GB displays as 'British English'.

LENGTH_FULL

Added in API level 24

public static final DisplayContext LENGTH_FULL

A possible setting for DISPLAY_LENGTH: use full names when generating a locale name, e.g. "United States" for US.

LENGTH_SHORT

Added in API level 24

public static final DisplayContext LENGTH_SHORT

A possible setting for DISPLAY_LENGTH: use short names when generating a locale name, e.g. "U.S." for US.

NO_SUBSTITUTE

Added in API level 28

public static final DisplayContext NO_SUBSTITUTE

A possible setting for SUBSTITUTE_HANDLING: Returns a null value when no data is available.

STANDARD_NAMES

Added in API level 24

public static final DisplayContext STANDARD_NAMES

A possible setting for DIALECT_HANDLING: use standard names when generating a locale name, e.g. en_GB displays as 'English (United Kingdom)'.

SUBSTITUTE

Added in API level 28

public static final DisplayContext SUBSTITUTE

A possible setting for SUBSTITUTE_HANDLING: Returns a fallback value (e.g., the input code) when no data is available. This is the default behavior.

Public methods

type

Added in API level 24

public DisplayContext.Type type ()

Get the Type part of the enum item (e.g. CAPITALIZATION)

Returns
`DisplayContext.Type`

value

Added in API level 24

public int value ()

Get the value part of the enum item (e.g. CAPITALIZATION_FOR_STANDALONE)

Returns
`int`

valueOf

public static DisplayContext valueOf (String name)

Parameters
`name`	`String`

Returns
`DisplayContext`

values

public static final DisplayContext[] values ()

Returns
`DisplayContext[]`