Package com.commercetools.api.models.error

Interface SyntaxErrorError

All Superinterfaces:

ErrorObject

All Known Implementing Classes:

SyntaxErrorErrorImpl

public interface SyntaxErrorError
extends ErrorObject

Returned when a Discount predicate, API Extension predicate, or search query does not have the correct syntax.

Example to create an instance using the builder pattern

     SyntaxErrorError syntaxErrorError = SyntaxErrorError.builder()
             .message("{message}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SYNTAX_ERROR	discriminator value for SyntaxErrorError

Method Summary

Modifier and Type	Method	Description
static SyntaxErrorErrorBuilder	builder()	builder factory method for SyntaxErrorError
static SyntaxErrorErrorBuilder	builder(SyntaxErrorError template)	create builder for SyntaxErrorError instance
static SyntaxErrorError	deepCopy(SyntaxErrorError template)	factory method to create a deep copy of SyntaxErrorError
@NotNull String	getCode()	Error identifier.
@NotNull String	getMessage()	"Syntax error while parsing $fieldDefinition."
static SyntaxErrorError	of()	factory method
static SyntaxErrorError	of(SyntaxErrorError template)	factory method to create a shallow copy SyntaxErrorError
void	setMessage(String message)	"Syntax error while parsing $fieldDefinition."
static com.fasterxml.jackson.core.type.TypeReference<SyntaxErrorError>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSyntaxErrorError(Function<SyntaxErrorError,T> helper)	accessor map function

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

setValue, values, withErrorObject

Field Details

SYNTAX_ERROR

static final String SYNTAX_ERROR

discriminator value for SyntaxErrorError

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

"Syntax error while parsing $fieldDefinition."

Specified by:

getMessage in interface ErrorObject

Returns:

message

setMessage

void setMessage(String message)

"Syntax error while parsing $fieldDefinition."

Specified by:

setMessage in interface ErrorObject

Parameters:

message - value to be set

of

static SyntaxErrorError of()

factory method

Returns:

instance of SyntaxErrorError

of

static SyntaxErrorError of(SyntaxErrorError template)

factory method to create a shallow copy SyntaxErrorError

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SyntaxErrorError deepCopy(@Nullable
 SyntaxErrorError template)

factory method to create a deep copy of SyntaxErrorError

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SyntaxErrorErrorBuilder builder()

builder factory method for SyntaxErrorError

Returns:

builder

builder

static SyntaxErrorErrorBuilder builder(SyntaxErrorError template)

create builder for SyntaxErrorError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSyntaxErrorError

default <T> T withSyntaxErrorError(Function<SyntaxErrorError,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<SyntaxErrorError> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference