com.commercetools.importapi.models.customfields.StringField Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commercetools-sdk-java-importapi Show documentation

The e-commerce SDK from commercetools for Java

There is a newer version: 17.22.0

Show newest version


package com.commercetools.importapi.models.customfields;

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

import javax.annotation.Nullable;

import com.fasterxml.jackson.annotation.*;
import com.fasterxml.jackson.databind.annotation.*;

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

import jakarta.validation.constraints.NotNull;

/**
 *  A field with a string value.
 *
 * 
 * Example to create an instance using the builder pattern
 * 
 * 
 *     StringField stringField = StringField.builder()
 *             .value("{value}")
 *             .build()
 * 
 * 
 */
@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
@JsonDeserialize(as = StringFieldImpl.class)
public interface StringField extends CustomField {

    /**
     * discriminator value for StringField
     */
    String STRING = "String";

    /**
     *
     * @return value
     */
    @NotNull
    @JsonProperty("value")
    public String getValue();

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

    public void setValue(final String value);

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

    /**
     * factory method to create a shallow copy StringField
     * @param template instance to be copied
     * @return copy instance
     */
    public static StringField of(final StringField template) {
        StringFieldImpl instance = new StringFieldImpl();
        instance.setValue(template.getValue());
        return instance;
    }

    /**
     * factory method to create a deep copy of StringField
     * @param template instance to be copied
     * @return copy instance
     */
    @Nullable
    public static StringField deepCopy(@Nullable final StringField template) {
        if (template == null) {
            return null;
        }
        StringFieldImpl instance = new StringFieldImpl();
        instance.setValue(template.getValue());
        return instance;
    }

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

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

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