Package org.talend.sdk.component.api.configuration.action

Enum Class Suggestable.LabelDisplayMode

java.lang.Object

java.lang.Enum<Suggestable.LabelDisplayMode>

org.talend.sdk.component.api.configuration.action.Suggestable.LabelDisplayMode

All Implemented Interfaces:

Serializable, Comparable<Suggestable.LabelDisplayMode>, Constable

Enclosing class:

Suggestable

public static enum Suggestable.LabelDisplayMode
extends Enum<Suggestable.LabelDisplayMode>

Defines how suggestion options are displayed in the UI.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LABEL	Display the option label only.
LABEL_ID	Display both the label and the identifier, e.g.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LABEL

public static final Suggestable.LabelDisplayMode LABEL

Display the option label only. Default behaviour — use this when labels are unique.

LABEL_ID

public static final Suggestable.LabelDisplayMode LABEL_ID

Display both the label and the identifier, e.g. Paris (fr-paris-01). Use this when labels may not be unique so that the user can make an unambiguous choice.

Method Details

values

public static Suggestable.LabelDisplayMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Suggestable.LabelDisplayMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null