Package com.commercetools.history.models.change

Interface AddPlainEnumValueChange

All Superinterfaces:

Change

All Known Implementing Classes:

AddPlainEnumValueChangeImpl

public interface AddPlainEnumValueChange
extends Change

Change triggered by the Add PlainEnumValue to AttributeDefinition update action.

Example to create an instance using the builder pattern

     AddPlainEnumValueChange addPlainEnumValueChange = AddPlainEnumValueChange.builder()
             .change("{change}")
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .attributeName("{attributeName}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_PLAIN_ENUM_VALUE_CHANGE	discriminator value for AddPlainEnumValueChange

Method Summary

Modifier and Type	Method	Description
static AddPlainEnumValueChangeBuilder	builder()	builder factory method for AddPlainEnumValueChange
static AddPlainEnumValueChangeBuilder	builder(AddPlainEnumValueChange template)	create builder for AddPlainEnumValueChange instance
static AddPlainEnumValueChange	deepCopy(AddPlainEnumValueChange template)	factory method to create a deep copy of AddPlainEnumValueChange
@NotNull String	getAttributeName()	Name of the updated AttributeDefinition.
@NotNull String	getChange()	Type of change on a resource that is similar to the update action it relates to, where possible.
@NotNull @Valid EnumValue	getNextValue()	Value after the change.
@NotNull String	getType()	Unique discriminator value to reliably deserialize the data type.
static AddPlainEnumValueChange	of()	factory method
static AddPlainEnumValueChange	of(AddPlainEnumValueChange template)	factory method to create a shallow copy AddPlainEnumValueChange
void	setAttributeName(String attributeName)	Name of the updated AttributeDefinition.
void	setChange(String change)	set change
void	setNextValue(EnumValue nextValue)	Value after the change.
static com.fasterxml.jackson.core.type.TypeReference<AddPlainEnumValueChange>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withAddPlainEnumValueChange(Function<AddPlainEnumValueChange,T> helper)	accessor map function

Methods inherited from interface com.commercetools.history.models.change.Change

withChange

Field Details

ADD_PLAIN_ENUM_VALUE_CHANGE

static final String ADD_PLAIN_ENUM_VALUE_CHANGE

discriminator value for AddPlainEnumValueChange

See Also:

• Constant Field Values

Method Details

getType

@NotNull
@NotNull String getType()

Description copied from interface: Change

Unique discriminator value to reliably deserialize the data type.

Specified by:

getType in interface Change

Returns:

type

getChange

@NotNull
@NotNull String getChange()

Description copied from interface: Change

Type of change on a resource that is similar to the update action it relates to, where possible. It is not a unique identifier for the data structure, for example, the setDescription change can occur with a localized and non-localized representation.

Records can be filtered by this value using the changes query parameter.

Specified by:

getChange in interface Change

Returns:

change

getNextValue

@NotNull
@Valid
@NotNull @Valid EnumValue getNextValue()

Value after the change.

Returns:

nextValue

getAttributeName

@NotNull
@NotNull String getAttributeName()

Name of the updated AttributeDefinition.

Returns:

attributeName

setChange

void setChange(String change)

set change

Specified by:

setChange in interface Change

Parameters:

change - value to be set

setNextValue

void setNextValue(EnumValue nextValue)

Value after the change.

Parameters:

nextValue - value to be set

setAttributeName

void setAttributeName(String attributeName)

Name of the updated AttributeDefinition.

Parameters:

attributeName - value to be set

of

static AddPlainEnumValueChange of()

factory method

Returns:

instance of AddPlainEnumValueChange

of

static AddPlainEnumValueChange of(AddPlainEnumValueChange template)

factory method to create a shallow copy AddPlainEnumValueChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static AddPlainEnumValueChange deepCopy(@Nullable
 AddPlainEnumValueChange template)

factory method to create a deep copy of AddPlainEnumValueChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AddPlainEnumValueChangeBuilder builder()

builder factory method for AddPlainEnumValueChange

Returns:

builder

builder

static AddPlainEnumValueChangeBuilder builder(AddPlainEnumValueChange template)

create builder for AddPlainEnumValueChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAddPlainEnumValueChange

default <T> T withAddPlainEnumValueChange(Function<AddPlainEnumValueChange,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<AddPlainEnumValueChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference