Package com.commercetools.api.models.type

Interface TypeAddEnumValueAction

All Superinterfaces:

ResourceUpdateAction<TypeUpdateAction>, TypeUpdateAction

All Known Implementing Classes:

TypeAddEnumValueActionImpl

public interface TypeAddEnumValueAction
extends TypeUpdateAction

Adds a value to an EnumType. This update action can be used to update an EnumType FieldDefinition and a SetType FieldDefinition of EnumType.

Example to create an instance using the builder pattern

     TypeAddEnumValueAction typeAddEnumValueAction = TypeAddEnumValueAction.builder()
             .fieldName("{fieldName}")
             .value(valueBuilder -> valueBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_ENUM_VALUE	discriminator value for TypeAddEnumValueAction

Method Summary

Modifier and Type	Method	Description
static TypeAddEnumValueActionBuilder	builder()	builder factory method for TypeAddEnumValueAction
static TypeAddEnumValueActionBuilder	builder(TypeAddEnumValueAction template)	create builder for TypeAddEnumValueAction instance
static TypeAddEnumValueAction	deepCopy(TypeAddEnumValueAction template)	factory method to create a deep copy of TypeAddEnumValueAction
@NotNull String	getFieldName()	name of the Field Definition to update.
@NotNull @Valid CustomFieldEnumValue	getValue()	Value to append to the array.
static TypeAddEnumValueAction	of()	factory method
static TypeAddEnumValueAction	of(TypeAddEnumValueAction template)	factory method to create a shallow copy TypeAddEnumValueAction
void	setFieldName(String fieldName)	name of the Field Definition to update.
void	setValue(CustomFieldEnumValue value)	Value to append to the array.
static com.fasterxml.jackson.core.type.TypeReference<TypeAddEnumValueAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withTypeAddEnumValueAction(Function<TypeAddEnumValueAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Methods inherited from interface com.commercetools.api.models.type.TypeUpdateAction

getAction, withTypeUpdateAction

Field Details

ADD_ENUM_VALUE

static final String ADD_ENUM_VALUE

discriminator value for TypeAddEnumValueAction

See Also:

• Constant Field Values

Method Details

getFieldName

@NotNull
@NotNull String getFieldName()

name of the Field Definition to update.

Returns:

fieldName

getValue

@NotNull
@Valid
@NotNull @Valid CustomFieldEnumValue getValue()

Value to append to the array.

Returns:

value

setFieldName

void setFieldName(String fieldName)

name of the Field Definition to update.

Parameters:

fieldName - value to be set

setValue

void setValue(CustomFieldEnumValue value)

Value to append to the array.

Parameters:

value - value to be set

of

static TypeAddEnumValueAction of()

factory method

Returns:

instance of TypeAddEnumValueAction

of

static TypeAddEnumValueAction of(TypeAddEnumValueAction template)

factory method to create a shallow copy TypeAddEnumValueAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static TypeAddEnumValueAction deepCopy(@Nullable
 TypeAddEnumValueAction template)

factory method to create a deep copy of TypeAddEnumValueAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static TypeAddEnumValueActionBuilder builder()

builder factory method for TypeAddEnumValueAction

Returns:

builder

builder

static TypeAddEnumValueActionBuilder builder(TypeAddEnumValueAction template)

create builder for TypeAddEnumValueAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withTypeAddEnumValueAction

default <T> T withTypeAddEnumValueAction(Function<TypeAddEnumValueAction,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<TypeAddEnumValueAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference