Package com.commercetools.api.models.type

Interface CustomFieldLocalizedEnumValue

All Superinterfaces:

WithKey

All Known Implementing Classes:

CustomFieldLocalizedEnumValueImpl

public interface CustomFieldLocalizedEnumValue
extends WithKey

Defines an allowed value of a CustomFieldLocalizedEnumType field.

Example to create an instance using the builder pattern

     CustomFieldLocalizedEnumValue customFieldLocalizedEnumValue = CustomFieldLocalizedEnumValue.builder()
             .key("{key}")
             .label(labelBuilder -> labelBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static CustomFieldLocalizedEnumValueBuilder	builder()	builder factory method for CustomFieldLocalizedEnumValue
static CustomFieldLocalizedEnumValueBuilder	builder(CustomFieldLocalizedEnumValue template)	create builder for CustomFieldLocalizedEnumValue instance
static CustomFieldLocalizedEnumValue	deepCopy(CustomFieldLocalizedEnumValue template)	factory method to create a deep copy of CustomFieldLocalizedEnumValue
@NotNull String	getKey()	Key of the value used as a programmatic identifier.
@NotNull @Valid LocalizedString	getLabel()	Descriptive localized label of the value.
static CustomFieldLocalizedEnumValue	of()	factory method
static CustomFieldLocalizedEnumValue	of(CustomFieldLocalizedEnumValue template)	factory method to create a shallow copy CustomFieldLocalizedEnumValue
void	setKey(String key)	Key of the value used as a programmatic identifier.
void	setLabel(LocalizedString label)	Descriptive localized label of the value.
static com.fasterxml.jackson.core.type.TypeReference<CustomFieldLocalizedEnumValue>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomFieldLocalizedEnumValue(Function<CustomFieldLocalizedEnumValue,T> helper)	accessor map function

Method Details

getKey

@NotNull
@NotNull String getKey()

Key of the value used as a programmatic identifier.

Specified by:

getKey in interface WithKey

Returns:

key

getLabel

@NotNull
@Valid
@NotNull @Valid LocalizedString getLabel()

Descriptive localized label of the value.

Returns:

label

setKey

void setKey(String key)

Key of the value used as a programmatic identifier.

Parameters:

key - value to be set

setLabel

void setLabel(LocalizedString label)

Descriptive localized label of the value.

Parameters:

label - value to be set

of

static CustomFieldLocalizedEnumValue of()

factory method

Returns:

instance of CustomFieldLocalizedEnumValue

of

static CustomFieldLocalizedEnumValue of(CustomFieldLocalizedEnumValue template)

factory method to create a shallow copy CustomFieldLocalizedEnumValue

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CustomFieldLocalizedEnumValue deepCopy(@Nullable
 CustomFieldLocalizedEnumValue template)

factory method to create a deep copy of CustomFieldLocalizedEnumValue

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomFieldLocalizedEnumValueBuilder builder()

builder factory method for CustomFieldLocalizedEnumValue

Returns:

builder

builder

static CustomFieldLocalizedEnumValueBuilder builder(CustomFieldLocalizedEnumValue template)

create builder for CustomFieldLocalizedEnumValue instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomFieldLocalizedEnumValue

default <T> T withCustomFieldLocalizedEnumValue(Function<CustomFieldLocalizedEnumValue,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<CustomFieldLocalizedEnumValue> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference