Package com.commercetools.api.models.product_type

Interface AttributeLocalizedEnumValue

All Superinterfaces:

WithKey

All Known Implementing Classes:

AttributeLocalizedEnumValueImpl

public interface AttributeLocalizedEnumValue
extends WithKey

A localized enum value must be unique within the enum, else a DuplicateEnumValues error is returned.

Example to create an instance using the builder pattern

     AttributeLocalizedEnumValue attributeLocalizedEnumValue = AttributeLocalizedEnumValue.builder()
             .key("{key}")
             .label(labelBuilder -> labelBuilder)
             .build()
 

Method Summary

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

Method Details

getKey

@NotNull
@NotNull String getKey()

Key of the value used as a programmatic identifier, for example in facets & filters.

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, for example in facets & filters.

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 AttributeLocalizedEnumValue of()

factory method

Returns:

instance of AttributeLocalizedEnumValue

of

static AttributeLocalizedEnumValue of(AttributeLocalizedEnumValue template)

factory method to create a shallow copy AttributeLocalizedEnumValue

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static AttributeLocalizedEnumValue deepCopy(@Nullable
 AttributeLocalizedEnumValue template)

factory method to create a deep copy of AttributeLocalizedEnumValue

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AttributeLocalizedEnumValueBuilder builder()

builder factory method for AttributeLocalizedEnumValue

Returns:

builder

builder

static AttributeLocalizedEnumValueBuilder builder(AttributeLocalizedEnumValue template)

create builder for AttributeLocalizedEnumValue instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAttributeLocalizedEnumValue

default <T> T withAttributeLocalizedEnumValue(Function<AttributeLocalizedEnumValue,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<AttributeLocalizedEnumValue> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference