001
002package com.commercetools.api.models.attribute_group;
003
004import java.time.*;
005import java.util.*;
006import java.util.function.Function;
007
008import javax.annotation.Nullable;
009import javax.validation.Valid;
010
011import com.commercetools.api.models.common.LocalizedString;
012import com.fasterxml.jackson.annotation.*;
013import com.fasterxml.jackson.databind.annotation.*;
014
015import io.vrap.rmf.base.client.utils.Generated;
016
017/**
018 * AttributeGroupSetDescriptionAction
019 *
020 * <hr>
021 * Example to create an instance using the builder pattern
022 * <div class=code-example>
023 * <pre><code class='java'>
024 *     AttributeGroupSetDescriptionAction attributeGroupSetDescriptionAction = AttributeGroupSetDescriptionAction.builder()
025 *             .build()
026 * </code></pre>
027 * </div>
028 */
029@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
030@JsonDeserialize(as = AttributeGroupSetDescriptionActionImpl.class)
031public interface AttributeGroupSetDescriptionAction extends AttributeGroupUpdateAction {
032
033    /**
034     * discriminator value for AttributeGroupSetDescriptionAction
035     */
036    String SET_DESCRIPTION = "setDescription";
037
038    /**
039     *  <p>Value to set. If empty, any existing value will be removed.</p>
040     * @return description
041     */
042    @Valid
043    @JsonProperty("description")
044    public LocalizedString getDescription();
045
046    /**
047     *  <p>Value to set. If empty, any existing value will be removed.</p>
048     * @param description value to be set
049     */
050
051    public void setDescription(final LocalizedString description);
052
053    /**
054     * factory method
055     * @return instance of AttributeGroupSetDescriptionAction
056     */
057    public static AttributeGroupSetDescriptionAction of() {
058        return new AttributeGroupSetDescriptionActionImpl();
059    }
060
061    /**
062     * factory method to create a shallow copy AttributeGroupSetDescriptionAction
063     * @param template instance to be copied
064     * @return copy instance
065     */
066    public static AttributeGroupSetDescriptionAction of(final AttributeGroupSetDescriptionAction template) {
067        AttributeGroupSetDescriptionActionImpl instance = new AttributeGroupSetDescriptionActionImpl();
068        instance.setDescription(template.getDescription());
069        return instance;
070    }
071
072    /**
073     * factory method to create a deep copy of AttributeGroupSetDescriptionAction
074     * @param template instance to be copied
075     * @return copy instance
076     */
077    @Nullable
078    public static AttributeGroupSetDescriptionAction deepCopy(
079            @Nullable final AttributeGroupSetDescriptionAction template) {
080        if (template == null) {
081            return null;
082        }
083        AttributeGroupSetDescriptionActionImpl instance = new AttributeGroupSetDescriptionActionImpl();
084        instance.setDescription(
085            com.commercetools.api.models.common.LocalizedString.deepCopy(template.getDescription()));
086        return instance;
087    }
088
089    /**
090     * builder factory method for AttributeGroupSetDescriptionAction
091     * @return builder
092     */
093    public static AttributeGroupSetDescriptionActionBuilder builder() {
094        return AttributeGroupSetDescriptionActionBuilder.of();
095    }
096
097    /**
098     * create builder for AttributeGroupSetDescriptionAction instance
099     * @param template instance with prefilled values for the builder
100     * @return builder
101     */
102    public static AttributeGroupSetDescriptionActionBuilder builder(final AttributeGroupSetDescriptionAction template) {
103        return AttributeGroupSetDescriptionActionBuilder.of(template);
104    }
105
106    /**
107     * accessor map function
108     * @param <T> mapped type
109     * @param helper function to map the object
110     * @return mapped value
111     */
112    default <T> T withAttributeGroupSetDescriptionAction(Function<AttributeGroupSetDescriptionAction, T> helper) {
113        return helper.apply(this);
114    }
115
116    /**
117     * gives a TypeReference for usage with Jackson DataBind
118     * @return TypeReference
119     */
120    public static com.fasterxml.jackson.core.type.TypeReference<AttributeGroupSetDescriptionAction> typeReference() {
121        return new com.fasterxml.jackson.core.type.TypeReference<AttributeGroupSetDescriptionAction>() {
122            @Override
123            public String toString() {
124                return "TypeReference<AttributeGroupSetDescriptionAction>";
125            }
126        };
127    }
128}