Package com.commercetools.history.models.change_history

Interface ErrorResponse

All Known Implementing Classes:

ErrorResponseImpl

public interface ErrorResponse

ErrorResponse Example to create an instance using the builder pattern

     ErrorResponse errorResponse = ErrorResponse.builder()
             .statusCode(1)
             .message("{message}")
             .build()
 

Method Summary

Modifier and Type	Method	Description
static ErrorResponseBuilder	builder()	builder factory method for ErrorResponse
static ErrorResponseBuilder	builder(ErrorResponse template)	create builder for ErrorResponse instance
static ErrorResponse	deepCopy(ErrorResponse template)	factory method to create a deep copy of ErrorResponse
String	getError()
String	getErrorDescription()
@Valid List<ErrorObject>	getErrors()
@NotNull String	getMessage()
@NotNull Integer	getStatusCode()
static ErrorResponse	of()	factory method
static ErrorResponse	of(ErrorResponse template)	factory method to create a shallow copy ErrorResponse
void	setError(String error)	set error
void	setErrorDescription(String errorDescription)	set error_description
void	setErrors(ErrorObject... errors)	set errors
void	setErrors(List<ErrorObject> errors)	set errors
void	setMessage(String message)	set message
void	setStatusCode(Integer statusCode)	set statusCode
static com.fasterxml.jackson.core.type.TypeReference<ErrorResponse>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withErrorResponse(Function<ErrorResponse,T> helper)	accessor map function

Method Details

getStatusCode

@NotNull
@NotNull Integer getStatusCode()

Returns:

statusCode

getMessage

@NotNull
@NotNull String getMessage()

Returns:

message

getError

String getError()

Returns:

error

getErrorDescription

String getErrorDescription()

Returns:

error_description

getErrors

@Valid
@Valid List<ErrorObject> getErrors()

Returns:

errors

setStatusCode

void setStatusCode(Integer statusCode)

set statusCode

Parameters:

statusCode - value to be set

setMessage

void setMessage(String message)

set message

Parameters:

message - value to be set

setError

void setError(String error)

set error

Parameters:

error - value to be set

setErrorDescription

void setErrorDescription(String errorDescription)

set error_description

Parameters:

errorDescription - value to be set

setErrors

void setErrors(ErrorObject... errors)

set errors

Parameters:

errors - values to be set

setErrors

void setErrors(List<ErrorObject> errors)

set errors

Parameters:

errors - values to be set

of

static ErrorResponse of()

factory method

Returns:

instance of ErrorResponse

of

static ErrorResponse of(ErrorResponse template)

factory method to create a shallow copy ErrorResponse

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ErrorResponse deepCopy(@Nullable
 ErrorResponse template)

factory method to create a deep copy of ErrorResponse

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ErrorResponseBuilder builder()

builder factory method for ErrorResponse

Returns:

builder

builder

static ErrorResponseBuilder builder(ErrorResponse template)

create builder for ErrorResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withErrorResponse

default <T> T withErrorResponse(Function<ErrorResponse,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<ErrorResponse> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference