DisplayContext (ICU4J 76)

java.lang.Object
- java.lang.Enum<DisplayContext>
- - com.ibm.icu.text.DisplayContext

All Implemented Interfaces:

Serializable, Comparable<DisplayContext>
```
public enum DisplayContext
extends Enum<DisplayContext>
```
Display context settings. Note, the specific numeric values are internal and may change.

Status:
Stable ICU 51.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DisplayContext.Type
Type values for DisplayContext

Nested Classes
Modifier and Type	Class and Description
`static class`	`DisplayContext.Type` Type values for DisplayContext

Enum Constant Summary

Enum Constants
Enum Constant and Description
`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` 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` 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` 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` A possible setting for CAPITALIZATION: The capitalization context to be used is unknown (this is the default value).
`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` A possible setting for DISPLAY_LENGTH: use full names when generating a locale name, e.g.
`LENGTH_SHORT` A possible setting for DISPLAY_LENGTH: use short names when generating a locale name, e.g.
`NO_SUBSTITUTE` A possible setting for SUBSTITUTE_HANDLING: Returns a null value when no data is available.
`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` A possible setting for SUBSTITUTE_HANDLING: Returns a fallback value (e.g., the input code) when no data is available.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DisplayContext.Type`	`type()` Get the Type part of the enum item (e.g.
`int`	`value()` Get the value part of the enum item (e.g.
`static DisplayContext`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DisplayContext[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - STANDARD_NAMES
```
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)'.
    
    Status:
    Stable ICU 51.
  - DIALECT_NAMES
```
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'.
    
    Status:
    Stable ICU 51.
  - CAPITALIZATION_NONE
```
public static final DisplayContext CAPITALIZATION_NONE
```
    A possible setting for CAPITALIZATION: The capitalization context to be used is unknown (this is the default value).
    
    Status:
    Stable ICU 51.
  - CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE
```
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.
    
    Status:
    Stable ICU 51.
  - CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE
```
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.
    
    Status:
    Stable ICU 51.
  - CAPITALIZATION_FOR_UI_LIST_OR_MENU
```
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.
    
    Status:
    Stable ICU 51.
  - CAPITALIZATION_FOR_STANDALONE
```
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.
    
    Status:
    Stable ICU 51.
  - LENGTH_FULL
```
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.
    
    Status:
    Stable ICU 54.
  - LENGTH_SHORT
```
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.
    
    Status:
    Stable ICU 54.
  - SUBSTITUTE
```
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.
    
    Status:
    Stable ICU 58.
  - NO_SUBSTITUTE
```
public static final DisplayContext NO_SUBSTITUTE
```
    A possible setting for SUBSTITUTE_HANDLING: Returns a null value when no data is available.
    
    Status:
    Stable ICU 58.
- Method Detail
  - values
```
public static DisplayContext[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (DisplayContext c : DisplayContext.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DisplayContext valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - type
```
public DisplayContext.Type type()
```
    Get the Type part of the enum item (e.g. CAPITALIZATION)
    
    Status:
    Stable ICU 51.
  - value
```
public int value()
```
    Get the value part of the enum item (e.g. CAPITALIZATION_FOR_STANDALONE)
    
    Status:
    Stable ICU 51.

Enum DisplayContext

Nested Class Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

STANDARD_NAMES

DIALECT_NAMES

CAPITALIZATION_NONE

CAPITALIZATION_FOR_MIDDLE_OF_SENTENCE

CAPITALIZATION_FOR_BEGINNING_OF_SENTENCE

CAPITALIZATION_FOR_UI_LIST_OR_MENU

CAPITALIZATION_FOR_STANDALONE

LENGTH_FULL

LENGTH_SHORT

SUBSTITUTE

NO_SUBSTITUTE

Method Detail

values

valueOf

type

value