com.commercetools.history.models.change_value.EnumValueBuilder 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

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.change_value;

import java.util.*;

import io.vrap.rmf.base.client.Builder;
import io.vrap.rmf.base.client.utils.Generated;

/**
 * EnumValueBuilder
 * 
 * Example to create an instance using the builder pattern
 * 
 * 
 *     EnumValue enumValue = EnumValue.builder()
 *             .key("{key}")
 *             .label("{label}")
 *             .build()
 * 
 * 
 */
@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
public class EnumValueBuilder implements Builder {

    private String key;

    private String label;

    /**
     *  Key of the value used as a programmatic identifier.
     * @param key value to be set
     * @return Builder
     */

    public EnumValueBuilder key(final String key) {
        this.key = key;
        return this;
    }

    /**
     *  Descriptive label of the value.
     * @param label value to be set
     * @return Builder
     */

    public EnumValueBuilder label(final String label) {
        this.label = label;
        return this;
    }

    /**
     *  Key of the value used as a programmatic identifier.
     * @return key
     */

    public String getKey() {
        return this.key;
    }

    /**
     *  Descriptive label of the value.
     * @return label
     */

    public String getLabel() {
        return this.label;
    }

    /**
     * builds EnumValue with checking for non-null required values
     * @return EnumValue
     */
    public EnumValue build() {
        Objects.requireNonNull(key, EnumValue.class + ": key is missing");
        Objects.requireNonNull(label, EnumValue.class + ": label is missing");
        return new EnumValueImpl(key, label);
    }

    /**
     * builds EnumValue without checking for non-null required values
     * @return EnumValue
     */
    public EnumValue buildUnchecked() {
        return new EnumValueImpl(key, label);
    }

    /**
     * factory method for an instance of EnumValueBuilder
     * @return builder
     */
    public static EnumValueBuilder of() {
        return new EnumValueBuilder();
    }

    /**
     * create builder for EnumValue instance
     * @param template instance with prefilled values for the builder
     * @return builder
     */
    public static EnumValueBuilder of(final EnumValue template) {
        EnumValueBuilder builder = new EnumValueBuilder();
        builder.key = template.getKey();
        builder.label = template.getLabel();
        return builder;
    }

}