Package com.commercetools.api.models.type

Interface TypeChangeInputHintAction

All Superinterfaces:

ResourceUpdateAction<TypeUpdateAction>, TypeUpdateAction

public interface TypeChangeInputHintAction
extends TypeUpdateAction

Changes the inputHint of CustomFieldStringType FieldDefinition, a CustomFieldLocalizedStringType FieldDefinition, and CustomFieldSetType FieldDefinition of these string-based FieldTypes.

Example to create an instance using the builder pattern

     TypeChangeInputHintAction typeChangeInputHintAction = TypeChangeInputHintAction.builder()
             .fieldName("{fieldName}")
             .inputHint(TypeTextInputHint.SINGLE_LINE)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_INPUT_HINT	discriminator value for TypeChangeInputHintAction

Method Summary

Modifier and Type	Method	Description
static TypeChangeInputHintActionBuilder	builder()	builder factory method for TypeChangeInputHintAction
static TypeChangeInputHintActionBuilder	builder(TypeChangeInputHintAction template)	create builder for TypeChangeInputHintAction instance
TypeChangeInputHintAction	copyDeep()
static TypeChangeInputHintAction	deepCopy(TypeChangeInputHintAction template)	factory method to create a deep copy of TypeChangeInputHintAction
@NotNull String	getFieldName()	name of the Field Definition to update.
@NotNull TypeTextInputHint	getInputHint()	New value to set.
static TypeChangeInputHintAction	of()	factory method
static TypeChangeInputHintAction	of(TypeChangeInputHintAction template)	factory method to create a shallow copy TypeChangeInputHintAction
void	setFieldName(String fieldName)	name of the Field Definition to update.
void	setInputHint(TypeTextInputHint inputHint)	New value to set.
static com.fasterxml.jackson.core.type.TypeReference<TypeChangeInputHintAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withTypeChangeInputHintAction(Function<TypeChangeInputHintAction,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

CHANGE_INPUT_HINT

static final String CHANGE_INPUT_HINT

discriminator value for TypeChangeInputHintAction

See Also:

• Constant Field Values

Method Details

getFieldName

@NotNull
@NotNull String getFieldName()

name of the Field Definition to update.

Returns:

fieldName

getInputHint

@NotNull
@NotNull TypeTextInputHint getInputHint()

New value to set. Must not be empty.

Returns:

inputHint

setFieldName

void setFieldName(String fieldName)

name of the Field Definition to update.

Parameters:

fieldName - value to be set

setInputHint

void setInputHint(TypeTextInputHint inputHint)

New value to set. Must not be empty.

Parameters:

inputHint - value to be set

of

static TypeChangeInputHintAction of()

factory method

Returns:

instance of TypeChangeInputHintAction

of

static TypeChangeInputHintAction of(TypeChangeInputHintAction template)

factory method to create a shallow copy TypeChangeInputHintAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

TypeChangeInputHintAction copyDeep()

Specified by:

copyDeep in interface TypeUpdateAction

deepCopy

@Nullable
static TypeChangeInputHintAction deepCopy(@Nullable
 TypeChangeInputHintAction template)

factory method to create a deep copy of TypeChangeInputHintAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static TypeChangeInputHintActionBuilder builder()

builder factory method for TypeChangeInputHintAction

Returns:

builder

builder

static TypeChangeInputHintActionBuilder builder(TypeChangeInputHintAction template)

create builder for TypeChangeInputHintAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withTypeChangeInputHintAction

default <T> T withTypeChangeInputHintAction(Function<TypeChangeInputHintAction,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<TypeChangeInputHintAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference