com.commercetools.history.models.label.CustomObjectLabel 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.15.1
Show newest version

package com.commercetools.history.models.label;

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;

/**
 * CustomObjectLabel
 *
 * 
 * Example to create an instance using the builder pattern
 * 
 * 
 *     CustomObjectLabel customObjectLabel = CustomObjectLabel.builder()
 *             .key("{key}")
 *             .container("{container}")
 *             .build()
 * 
 * 
 */
@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
@JsonDeserialize(as = CustomObjectLabelImpl.class)
public interface CustomObjectLabel extends Label {

    /**
     * discriminator value for CustomObjectLabel
     */
    String CUSTOM_OBJECT_LABEL = "CustomObjectLabel";

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

    /**
     *  User-defined unique identifier of the CustomObject within the defined container.
     * @return key
     */
    @NotNull
    @JsonProperty("key")
    public String getKey();

    /**
     *  Namespace to group Custom Objects.
     * @return container
     */
    @NotNull
    @JsonProperty("container")
    public String getContainer();

    /**
     *  User-defined unique identifier of the CustomObject within the defined container.
     * @param key value to be set
     */

    public void setKey(final String key);

    /**
     *  Namespace to group Custom Objects.
     * @param container value to be set
     */

    public void setContainer(final String container);

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

    /**
     * factory method to create a shallow copy CustomObjectLabel
     * @param template instance to be copied
     * @return copy instance
     */
    public static CustomObjectLabel of(final CustomObjectLabel template) {
        CustomObjectLabelImpl instance = new CustomObjectLabelImpl();
        instance.setKey(template.getKey());
        instance.setContainer(template.getContainer());
        return instance;
    }

    /**
     * factory method to create a deep copy of CustomObjectLabel
     * @param template instance to be copied
     * @return copy instance
     */
    @Nullable
    public static CustomObjectLabel deepCopy(@Nullable final CustomObjectLabel template) {
        if (template == null) {
            return null;
        }
        CustomObjectLabelImpl instance = new CustomObjectLabelImpl();
        instance.setKey(template.getKey());
        instance.setContainer(template.getContainer());
        return instance;
    }

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

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

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