Package com.commercetools.history.models.change

Interface AddFieldDefinitionChange

All Superinterfaces:

Change

All Known Implementing Classes:

AddFieldDefinitionChangeImpl

public interface AddFieldDefinitionChange
extends Change

Change triggered by the Add FieldDefinition update action.

Example to create an instance using the builder pattern

     AddFieldDefinitionChange addFieldDefinitionChange = AddFieldDefinitionChange.builder()
             .change("{change}")
             .nextValue(nextValueBuilder -> nextValueBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_FIELD_DEFINITION_CHANGE	discriminator value for AddFieldDefinitionChange

Method Summary

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

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

withChange

Field Details

ADD_FIELD_DEFINITION_CHANGE

static final String ADD_FIELD_DEFINITION_CHANGE

discriminator value for AddFieldDefinitionChange

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 FieldDefinition getNextValue()

Value after the change.

Returns:

nextValue

setChange

void setChange(String change)

set change

Specified by:

setChange in interface Change

Parameters:

change - value to be set

setNextValue

void setNextValue(FieldDefinition nextValue)

Value after the change.

Parameters:

nextValue - value to be set

of

static AddFieldDefinitionChange of()

factory method

Returns:

instance of AddFieldDefinitionChange

of

static AddFieldDefinitionChange of(AddFieldDefinitionChange template)

factory method to create a shallow copy AddFieldDefinitionChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static AddFieldDefinitionChange deepCopy(@Nullable
 AddFieldDefinitionChange template)

factory method to create a deep copy of AddFieldDefinitionChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static AddFieldDefinitionChangeBuilder builder()

builder factory method for AddFieldDefinitionChange

Returns:

builder

builder

static AddFieldDefinitionChangeBuilder builder(AddFieldDefinitionChange template)

create builder for AddFieldDefinitionChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withAddFieldDefinitionChange

default <T> T withAddFieldDefinitionChange(Function<AddFieldDefinitionChange,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<AddFieldDefinitionChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference