com.commercetools.history.models.label.PaymentLabel Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commercetools-sdk-java-history Show documentation
Show all versions of commercetools-sdk-java-history Show documentation
The e-commerce SDK from commercetools Composable Commerce for Java
package com.commercetools.history.models.label;
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.Money;
import com.fasterxml.jackson.annotation.*;
import com.fasterxml.jackson.databind.annotation.*;
import io.vrap.rmf.base.client.utils.Generated;
/**
* PaymentLabel
*
*
* Example to create an instance using the builder pattern
*
*
* PaymentLabel paymentLabel = PaymentLabel.builder()
* .key("{key}")
* .amountPlanned(amountPlannedBuilder -> amountPlannedBuilder)
* .build()
*
*
*/
@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
@JsonDeserialize(as = PaymentLabelImpl.class)
public interface PaymentLabel extends Label {
/**
* discriminator value for PaymentLabel
*/
String PAYMENT_LABEL = "PaymentLabel";
/**
*
* @return type
*/
@NotNull
@JsonProperty("type")
public String getType();
/**
* User-defined unique identifier of the Payment.
* @return key
*/
@NotNull
@JsonProperty("key")
public String getKey();
/**
* Money value the Payment intends to receive from the Customer.
* @return amountPlanned
*/
@NotNull
@Valid
@JsonProperty("amountPlanned")
public Money getAmountPlanned();
/**
* User-defined unique identifier of the Payment.
* @param key value to be set
*/
public void setKey(final String key);
/**
* Money value the Payment intends to receive from the Customer.
* @param amountPlanned value to be set
*/
public void setAmountPlanned(final Money amountPlanned);
/**
* factory method
* @return instance of PaymentLabel
*/
public static PaymentLabel of() {
return new PaymentLabelImpl();
}
/**
* factory method to create a shallow copy PaymentLabel
* @param template instance to be copied
* @return copy instance
*/
public static PaymentLabel of(final PaymentLabel template) {
PaymentLabelImpl instance = new PaymentLabelImpl();
instance.setKey(template.getKey());
instance.setAmountPlanned(template.getAmountPlanned());
return instance;
}
/**
* factory method to create a deep copy of PaymentLabel
* @param template instance to be copied
* @return copy instance
*/
@Nullable
public static PaymentLabel deepCopy(@Nullable final PaymentLabel template) {
if (template == null) {
return null;
}
PaymentLabelImpl instance = new PaymentLabelImpl();
instance.setKey(template.getKey());
instance.setAmountPlanned(com.commercetools.history.models.common.Money.deepCopy(template.getAmountPlanned()));
return instance;
}
/**
* builder factory method for PaymentLabel
* @return builder
*/
public static PaymentLabelBuilder builder() {
return PaymentLabelBuilder.of();
}
/**
* create builder for PaymentLabel instance
* @param template instance with prefilled values for the builder
* @return builder
*/
public static PaymentLabelBuilder builder(final PaymentLabel template) {
return PaymentLabelBuilder.of(template);
}
/**
* accessor map function
* @param mapped type
* @param helper function to map the object
* @return mapped value
*/
default T withPaymentLabel(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";
}
};
}
}