Package com.commercetools.api.models.error

Interface DuplicateFieldError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

DuplicateFieldErrorImpl

public interface DuplicateFieldError
extends ErrorObject

Returned when a field value conflicts with an existing value causing a duplicate.

Example to create an instance using the builder pattern

     DuplicateFieldError duplicateFieldError = DuplicateFieldError.builder()
             .message("{message}")
             .field("{field}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DUPLICATE_FIELD	discriminator value for DuplicateFieldError

Method Summary

Modifier and Type	Method	Description
static DuplicateFieldErrorBuilder	builder()	builder factory method for DuplicateFieldError
static DuplicateFieldErrorBuilder	builder(DuplicateFieldError template)	create builder for DuplicateFieldError instance
static DuplicateFieldError	deepCopy(DuplicateFieldError template)	factory method to create a deep copy of DuplicateFieldError
@NotNull String	getCode()	Error identifier.
@NotNull Object	getDuplicateValue()	Conflicting duplicate value.
@NotNull String	getField()	Name of the conflicting field.
@NotNull String	getMessage()	"A duplicate value $duplicateValue exists for field $field."
static DuplicateFieldError	of()	factory method
static DuplicateFieldError	of(DuplicateFieldError template)	factory method to create a shallow copy DuplicateFieldError
void	setDuplicateValue(Object duplicateValue)	Conflicting duplicate value.
void	setField(String field)	Name of the conflicting field.
void	setMessage(String message)	"A duplicate value $duplicateValue exists for field $field."
static com.fasterxml.jackson.core.type.TypeReference<DuplicateFieldError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDuplicateFieldError(Function<DuplicateFieldError,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.error.ErrorObject

setValue, values, withErrorObject

Field Details

DUPLICATE_FIELD

static final String DUPLICATE_FIELD

discriminator value for DuplicateFieldError

See Also:

• Constant Field Values

Method Details

getCode

@NotNull
@NotNull String getCode()

Description copied from interface: ErrorObject

Error identifier.

Specified by:

getCode in interface ErrorObject

Returns:

code

getMessage

@NotNull
@NotNull String getMessage()

"A duplicate value $duplicateValue exists for field $field."

Specified by:

getMessage in interface ErrorObject

Returns:

message

getField

@NotNull
@NotNull String getField()

Name of the conflicting field.

Returns:

field

getDuplicateValue

@NotNull
@NotNull Object getDuplicateValue()

Conflicting duplicate value.

Returns:

duplicateValue

setMessage

void setMessage(String message)

"A duplicate value $duplicateValue exists for field $field."

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

setField

void setField(String field)

Name of the conflicting field.

Parameters:

field - value to be set

setDuplicateValue

void setDuplicateValue(Object duplicateValue)

Conflicting duplicate value.

Parameters:

duplicateValue - value to be set

of

static DuplicateFieldError of()

factory method

Returns:

instance of DuplicateFieldError

of

static DuplicateFieldError of(DuplicateFieldError template)

factory method to create a shallow copy DuplicateFieldError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static DuplicateFieldError deepCopy(@Nullable
 DuplicateFieldError template)

factory method to create a deep copy of DuplicateFieldError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DuplicateFieldErrorBuilder builder()

builder factory method for DuplicateFieldError

Returns:

builder

builder

static DuplicateFieldErrorBuilder builder(DuplicateFieldError template)

create builder for DuplicateFieldError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDuplicateFieldError

default <T> T withDuplicateFieldError(Function<DuplicateFieldError,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<DuplicateFieldError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference