Package com.commercetools.history.models.change_value

Interface CustomFieldExpandedValue

All Known Implementing Classes:

CustomFieldExpandedValueImpl

public interface CustomFieldExpandedValue

Only present if expand is set to true.

Example to create an instance using the builder pattern

     CustomFieldExpandedValue customFieldExpandedValue = CustomFieldExpandedValue.builder()
             .name("{name}")
             .label(labelBuilder -> labelBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static CustomFieldExpandedValueBuilder	builder()	builder factory method for CustomFieldExpandedValue
static CustomFieldExpandedValueBuilder	builder(CustomFieldExpandedValue template)	create builder for CustomFieldExpandedValue instance
static CustomFieldExpandedValue	deepCopy(CustomFieldExpandedValue template)	factory method to create a deep copy of CustomFieldExpandedValue
@NotNull @Valid LocalizedString	getLabel()	User-defined label of the Custom Field.
@NotNull String	getName()	Name of the Custom Field.
@NotNull Object	getValue()	CustomFieldValue based on the FieldType.
static CustomFieldExpandedValue	of()	factory method
static CustomFieldExpandedValue	of(CustomFieldExpandedValue template)	factory method to create a shallow copy CustomFieldExpandedValue
void	setLabel(LocalizedString label)	User-defined label of the Custom Field.
void	setName(String name)	Name of the Custom Field.
void	setValue(Object value)	CustomFieldValue based on the FieldType.
static com.fasterxml.jackson.core.type.TypeReference<CustomFieldExpandedValue>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomFieldExpandedValue(Function<CustomFieldExpandedValue,T> helper)	accessor map function

Method Details

getName

@NotNull
@NotNull String getName()

Name of the Custom Field.

Returns:

name

getValue

@NotNull
@NotNull Object getValue()

CustomFieldValue based on the FieldType.

Returns:

value

getLabel

@NotNull
@Valid
@NotNull @Valid LocalizedString getLabel()

User-defined label of the Custom Field.

Returns:

label

setName

void setName(String name)

Name of the Custom Field.

Parameters:

name - value to be set

setValue

void setValue(Object value)

CustomFieldValue based on the FieldType.

Parameters:

value - value to be set

setLabel

void setLabel(LocalizedString label)

User-defined label of the Custom Field.

Parameters:

label - value to be set

of

static CustomFieldExpandedValue of()

factory method

Returns:

instance of CustomFieldExpandedValue

of

static CustomFieldExpandedValue of(CustomFieldExpandedValue template)

factory method to create a shallow copy CustomFieldExpandedValue

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CustomFieldExpandedValue deepCopy(@Nullable
 CustomFieldExpandedValue template)

factory method to create a deep copy of CustomFieldExpandedValue

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomFieldExpandedValueBuilder builder()

builder factory method for CustomFieldExpandedValue

Returns:

builder

builder

static CustomFieldExpandedValueBuilder builder(CustomFieldExpandedValue template)

create builder for CustomFieldExpandedValue instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomFieldExpandedValue

default <T> T withCustomFieldExpandedValue(Function<CustomFieldExpandedValue,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<CustomFieldExpandedValue> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference