Enum DisplayContext

java.lang.Object
java.lang.Enum<DisplayContext>
com.ibm.icu.text.DisplayContext
All Implemented Interfaces:
Serializable, Comparable<DisplayContext>, java.lang.constant.Constable

public enum DisplayContext extends Enum<DisplayContext>
Display context settings. Note, the specific numeric values are internal and may change.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    Type values for DisplayContext

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    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.
    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.
    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.
    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.
    A possible setting for CAPITALIZATION: The capitalization context to be used is unknown (this is the default value).
    A possible setting for DIALECT_HANDLING: use dialect names, when generating a locale name, e.g. en_GB displays as 'British English'.
    A possible setting for DISPLAY_LENGTH: use full names when generating a locale name, e.g.
    A possible setting for DISPLAY_LENGTH: use short names when generating a locale name, e.g.
    A possible setting for SUBSTITUTE_HANDLING: Returns a null value when no data is available.
    A possible setting for DIALECT_HANDLING: use standard names when generating a locale name, e.g. en_GB displays as 'English (United Kingdom)'.
    A possible setting for SUBSTITUTE_HANDLING: Returns a fallback value (e.g., the input code) when no data is available.
  • Method Summary

    Modifier and Type
    Method
    Description
    Get the Type part of the enum item (e.g.
    int
    Get the value part of the enum item (e.g.
    Returns the enum constant of this type with the specified name.
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • 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)'.
    • 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'.
    • 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).
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • 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.
    • NO_SUBSTITUTE

      public static final DisplayContext NO_SUBSTITUTE
      A possible setting for SUBSTITUTE_HANDLING: Returns a null value when no data is available.
  • Method Details

    • values

      public static DisplayContext[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      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)
    • value

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