Enum DisplayOptions.SubstituteHandling

java.lang.Object

java.lang.Enum<DisplayOptions.SubstituteHandling>

com.ibm.icu.text.DisplayOptions.SubstituteHandling

All Implemented Interfaces:

Serializable, Comparable<DisplayOptions.SubstituteHandling>

Enclosing class:

DisplayOptions

public static enum DisplayOptions.SubstituteHandling
extends Enum<DisplayOptions.SubstituteHandling>

Represents all the substitute handlings.

Status:

Stable ICU 72.

Enum Constant Summary

Enum Constants

Enum Constant	Description
NO_SUBSTITUTE	Returns a null value when no data is available.
SUBSTITUTE	Returns a fallback value (e.g., the input code) when no data is available.
UNDEFINED	A possible setting for SubstituteHandling.

Field Summary

Fields

Modifier and Type	Field	Description
static final List<DisplayOptions.SubstituteHandling>	VALUES	Unmodifiable List of all substitute handlings constants.

Method Summary

Modifier and Type	Method	Description
static DisplayOptions.SubstituteHandling	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DisplayOptions.SubstituteHandling[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNDEFINED

public static final DisplayOptions.SubstituteHandling UNDEFINED

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

Status:

Stable ICU 72.

SUBSTITUTE

public static final DisplayOptions.SubstituteHandling SUBSTITUTE

Returns a fallback value (e.g., the input code) when no data is available. This is the default behaviour.

Status:

Stable ICU 72.

NO_SUBSTITUTE

public static final DisplayOptions.SubstituteHandling NO_SUBSTITUTE

Returns a null value when no data is available.

Status:

Stable ICU 72.

Field Details

VALUES

public static final List<DisplayOptions.SubstituteHandling> VALUES

Unmodifiable List of all substitute handlings constants. List version of values().

Status:

Stable ICU 72.

Method Details

values

public static DisplayOptions.SubstituteHandling[] 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 DisplayOptions.SubstituteHandling 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