com.commercetools.history.models.change_value.CustomFieldExpandedValue 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_value;

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.commercetools.history.models.common.LocalizedString;
import com.fasterxml.jackson.annotation.*;
import com.fasterxml.jackson.databind.annotation.*;

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

/**
 *  Only present if expand is set to true.
 *
 * 
 * Example to create an instance using the builder pattern
 * 
 * 
 *     CustomFieldExpandedValue customFieldExpandedValue = CustomFieldExpandedValue.builder()
 *             .name("{name}")
 *             .label(labelBuilder -> labelBuilder)
 *             .build()
 * 
 * 
 */
@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
@JsonDeserialize(as = CustomFieldExpandedValueImpl.class)
public interface CustomFieldExpandedValue {

    /**
     *  Name of the Custom Field.
     * @return name
     */
    @NotNull
    @JsonProperty("name")
    public String getName();

    /**
     *  CustomFieldValue based on the FieldType.
     * @return value
     */
    @NotNull
    @JsonProperty("value")
    public Object getValue();

    /**
     *  User-defined label of the Custom Field.
     * @return label
     */
    @NotNull
    @Valid
    @JsonProperty("label")
    public LocalizedString getLabel();

    /**
     *  Name of the Custom Field.
     * @param name value to be set
     */

    public void setName(final String name);

    /**
     *  CustomFieldValue based on the FieldType.
     * @param value value to be set
     */

    public void setValue(final Object value);

    /**
     *  User-defined label of the Custom Field.
     * @param label value to be set
     */

    public void setLabel(final LocalizedString label);

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

    /**
     * factory method to create a shallow copy CustomFieldExpandedValue
     * @param template instance to be copied
     * @return copy instance
     */
    public static CustomFieldExpandedValue of(final CustomFieldExpandedValue template) {
        CustomFieldExpandedValueImpl instance = new CustomFieldExpandedValueImpl();
        instance.setName(template.getName());
        instance.setValue(template.getValue());
        instance.setLabel(template.getLabel());
        return instance;
    }

    /**
     * factory method to create a deep copy of CustomFieldExpandedValue
     * @param template instance to be copied
     * @return copy instance
     */
    @Nullable
    public static CustomFieldExpandedValue deepCopy(@Nullable final CustomFieldExpandedValue template) {
        if (template == null) {
            return null;
        }
        CustomFieldExpandedValueImpl instance = new CustomFieldExpandedValueImpl();
        instance.setName(template.getName());
        instance.setValue(template.getValue());
        instance.setLabel(com.commercetools.history.models.common.LocalizedString.deepCopy(template.getLabel()));
        return instance;
    }

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

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

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