com.commercetools.history.models.common.ShippingRate 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.common;

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

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;

/**
 * ShippingRate
 *
 * 
 * Example to create an instance using the builder pattern
 * 
 * 
 *     ShippingRate shippingRate = ShippingRate.builder()
 *             .price(priceBuilder -> priceBuilder)
 *             .freeAbove(freeAboveBuilder -> freeAboveBuilder)
 *             .isMatching(true)
 *             .plusTiers(tiersBuilder -> tiersBuilder)
 *             .build()
 * 
 * 
 */
@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
@JsonDeserialize(as = ShippingRateImpl.class)
public interface ShippingRate {

    /**
     *
     * @return price
     */
    @NotNull
    @Valid
    @JsonProperty("price")
    public Money getPrice();

    /**
     *
     * @return freeAbove
     */
    @NotNull
    @Valid
    @JsonProperty("freeAbove")
    public Money getFreeAbove();

    /**
     *  Only appears in response to requests for ShippingMethods by Cart or location to mark this shipping rate as one that matches the Cart or location.
     * @return isMatching
     */
    @NotNull
    @JsonProperty("isMatching")
    public Boolean getIsMatching();

    /**
     *
     * @return tiers
     */
    @NotNull
    @Valid
    @JsonProperty("tiers")
    public List getTiers();

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

    public void setPrice(final Money price);

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

    public void setFreeAbove(final Money freeAbove);

    /**
     *  Only appears in response to requests for ShippingMethods by Cart or location to mark this shipping rate as one that matches the Cart or location.
     * @param isMatching value to be set
     */

    public void setIsMatching(final Boolean isMatching);

    /**
     * set tiers
     * @param tiers values to be set
     */

    @JsonIgnore
    public void setTiers(final ShippingRatePriceTier... tiers);

    /**
     * set tiers
     * @param tiers values to be set
     */

    public void setTiers(final List tiers);

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

    /**
     * factory method to create a shallow copy ShippingRate
     * @param template instance to be copied
     * @return copy instance
     */
    public static ShippingRate of(final ShippingRate template) {
        ShippingRateImpl instance = new ShippingRateImpl();
        instance.setPrice(template.getPrice());
        instance.setFreeAbove(template.getFreeAbove());
        instance.setIsMatching(template.getIsMatching());
        instance.setTiers(template.getTiers());
        return instance;
    }

    /**
     * factory method to create a deep copy of ShippingRate
     * @param template instance to be copied
     * @return copy instance
     */
    @Nullable
    public static ShippingRate deepCopy(@Nullable final ShippingRate template) {
        if (template == null) {
            return null;
        }
        ShippingRateImpl instance = new ShippingRateImpl();
        instance.setPrice(com.commercetools.history.models.common.Money.deepCopy(template.getPrice()));
        instance.setFreeAbove(com.commercetools.history.models.common.Money.deepCopy(template.getFreeAbove()));
        instance.setIsMatching(template.getIsMatching());
        instance.setTiers(Optional.ofNullable(template.getTiers())
                .map(t -> t.stream()
                        .map(com.commercetools.history.models.common.ShippingRatePriceTier::deepCopy)
                        .collect(Collectors.toList()))
                .orElse(null));
        return instance;
    }

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

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

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