Package com.commercetools.history.models.change

Interface RemoveFieldDefinitionChange

All Superinterfaces:

Change

All Known Implementing Classes:

RemoveFieldDefinitionChangeImpl

public interface RemoveFieldDefinitionChange
extends Change

Change triggered by the Remove FieldDefinition update action.

Example to create an instance using the builder pattern

     RemoveFieldDefinitionChange removeFieldDefinitionChange = RemoveFieldDefinitionChange.builder()
             .change("{change}")
             .previousValue(previousValueBuilder -> previousValueBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_FIELD_DEFINITION_CHANGE	discriminator value for RemoveFieldDefinitionChange

Method Summary

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

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

withChange

Field Details

REMOVE_FIELD_DEFINITION_CHANGE

static final String REMOVE_FIELD_DEFINITION_CHANGE

discriminator value for RemoveFieldDefinitionChange

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

getPreviousValue

@NotNull
@Valid
@NotNull @Valid FieldDefinition getPreviousValue()

Value before the change.

Returns:

previousValue

setChange

void setChange(String change)

set change

Specified by:

setChange in interface Change

Parameters:

change - value to be set

setPreviousValue

void setPreviousValue(FieldDefinition previousValue)

Value before the change.

Parameters:

previousValue - value to be set

of

static RemoveFieldDefinitionChange of()

factory method

Returns:

instance of RemoveFieldDefinitionChange

of

static RemoveFieldDefinitionChange of(RemoveFieldDefinitionChange template)

factory method to create a shallow copy RemoveFieldDefinitionChange

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static RemoveFieldDefinitionChange deepCopy(@Nullable
 RemoveFieldDefinitionChange template)

factory method to create a deep copy of RemoveFieldDefinitionChange

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static RemoveFieldDefinitionChangeBuilder builder()

builder factory method for RemoveFieldDefinitionChange

Returns:

builder

builder

static RemoveFieldDefinitionChangeBuilder builder(RemoveFieldDefinitionChange template)

create builder for RemoveFieldDefinitionChange instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withRemoveFieldDefinitionChange

default <T> T withRemoveFieldDefinitionChange(Function<RemoveFieldDefinitionChange,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<RemoveFieldDefinitionChange> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference