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