com.commercetools.history.models.common.CustomFields Maven / Gradle / Ivy

Go to download
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.15.1
Show newest version

package com.commercetools.history.models.common;

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

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

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

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

/**
 * CustomFields
 *
 * 
 * Example to create an instance using the builder pattern
 * 
 * 
 *     CustomFields customFields = CustomFields.builder()
 *             .type(typeBuilder -> typeBuilder)
 *             .fields(fieldsBuilder -> fieldsBuilder)
 *             .build()
 * 
 * 
 */
@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
@JsonDeserialize(as = CustomFieldsImpl.class)
public interface CustomFields {

    /**
     *
     * @return type
     */
    @NotNull
    @Valid
    @JsonProperty("type")
    public Reference getType();

    /**
     *  A valid JSON object, based on FieldDefinition.
     * @return fields
     */
    @NotNull
    @Valid
    @JsonProperty("fields")
    public Object getFields();

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

    public void setType(final Reference type);

    /**
     *  A valid JSON object, based on FieldDefinition.
     * @param fields value to be set
     */

    public void setFields(final Object fields);

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

    /**
     * factory method to create a shallow copy CustomFields
     * @param template instance to be copied
     * @return copy instance
     */
    public static CustomFields of(final CustomFields template) {
        CustomFieldsImpl instance = new CustomFieldsImpl();
        instance.setType(template.getType());
        instance.setFields(template.getFields());
        return instance;
    }

    /**
     * factory method to create a deep copy of CustomFields
     * @param template instance to be copied
     * @return copy instance
     */
    @Nullable
    public static CustomFields deepCopy(@Nullable final CustomFields template) {
        if (template == null) {
            return null;
        }
        CustomFieldsImpl instance = new CustomFieldsImpl();
        instance.setType(com.commercetools.history.models.common.Reference.deepCopy(template.getType()));
        instance.setFields(template.getFields());
        return instance;
    }

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

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

    /**
     * accessor map function
     * @param  mapped type
     * @param helper function to map the object
     * @return mapped value
     */
    default  T withCustomFields(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";
            }
        };
    }
}