com.commercetools.history.models.change_history.ErrorObject Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of commercetools-sdk-java-history Show documentation
The e-commerce SDK from commercetools Composable Commerce for Java
There is a newer version: 17.12.0
Show newest version

package com.commercetools.history.models.change_history;

import java.time.*;
import java.util.*;
import java.util.function.Function;

import javax.annotation.Nullable;
import javax.validation.constraints.NotNull;

import com.fasterxml.jackson.annotation.*;
import com.fasterxml.jackson.databind.annotation.*;

import io.vrap.rmf.base.client.utils.Generated;

/**
 * ErrorObject
 *
 * 
 * Example to create an instance using the builder pattern
 * 
 * 
 *     ErrorObject errorObject = ErrorObject.builder()
 *             .code("{code}")
 *             .message("{message}")
 *             .build()
 * 
 * 
 */
@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
@JsonDeserialize(as = ErrorObjectImpl.class)
public interface ErrorObject {

    /**
     *
     * @return code
     */
    @NotNull
    @JsonProperty("code")
    public String getCode();

    /**
     *
     * @return message
     */
    @NotNull
    @JsonProperty("message")
    public String getMessage();

    /**
     * set code
     * @param code value to be set
     */

    public void setCode(final String code);

    /**
     * set message
     * @param message value to be set
     */

    public void setMessage(final String message);

    /**
     * factory method
     * @return instance of ErrorObject
     */
    public static ErrorObject of() {
        return new ErrorObjectImpl();
    }

    /**
     * factory method to create a shallow copy ErrorObject
     * @param template instance to be copied
     * @return copy instance
     */
    public static ErrorObject of(final ErrorObject template) {
        ErrorObjectImpl instance = new ErrorObjectImpl();
        instance.setCode(template.getCode());
        instance.setMessage(template.getMessage());
        return instance;
    }

    /**
     * factory method to create a deep copy of ErrorObject
     * @param template instance to be copied
     * @return copy instance
     */
    @Nullable
    public static ErrorObject deepCopy(@Nullable final ErrorObject template) {
        if (template == null) {
            return null;
        }
        ErrorObjectImpl instance = new ErrorObjectImpl();
        instance.setCode(template.getCode());
        instance.setMessage(template.getMessage());
        return instance;
    }

    /**
     * builder factory method for ErrorObject
     * @return builder
     */
    public static ErrorObjectBuilder builder() {
        return ErrorObjectBuilder.of();
    }

    /**
     * create builder for ErrorObject instance
     * @param template instance with prefilled values for the builder
     * @return builder
     */
    public static ErrorObjectBuilder builder(final ErrorObject template) {
        return ErrorObjectBuilder.of(template);
    }

    /**
     * accessor map function
     * @param  mapped type
     * @param helper function to map the object
     * @return mapped value
     */
    default  T withErrorObject(Function helper) {
        return helper.apply(this);
    }

    /**
     * gives a TypeReference for usage with Jackson DataBind
     * @return TypeReference
     */
    public static com.fasterxml.jackson.core.type.TypeReference typeReference() {
        return new com.fasterxml.jackson.core.type.TypeReference() {
            @Override
            public String toString() {
                return "TypeReference";
            }
        };
    }
}