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

/**
 * SearchKeyword
 *
 * 
 * Example to create an instance using the builder pattern
 * 
 * 
 *     SearchKeyword searchKeyword = SearchKeyword.builder()
 *             .text("{text}")
 *             .suggestTokenizer(suggestTokenizerBuilder -> suggestTokenizerBuilder)
 *             .build()
 * 
 * 
 */
@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
@JsonDeserialize(as = SearchKeywordImpl.class)
public interface SearchKeyword {

    /**
     *
     * @return text
     */
    @NotNull
    @JsonProperty("text")
    public String getText();

    /**
     *
     * @return suggestTokenizer
     */
    @NotNull
    @Valid
    @JsonProperty("suggestTokenizer")
    public SuggestTokenizer getSuggestTokenizer();

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

    public void setText(final String text);

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

    public void setSuggestTokenizer(final SuggestTokenizer suggestTokenizer);

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

    /**
     * factory method to create a shallow copy SearchKeyword
     * @param template instance to be copied
     * @return copy instance
     */
    public static SearchKeyword of(final SearchKeyword template) {
        SearchKeywordImpl instance = new SearchKeywordImpl();
        instance.setText(template.getText());
        instance.setSuggestTokenizer(template.getSuggestTokenizer());
        return instance;
    }

    /**
     * factory method to create a deep copy of SearchKeyword
     * @param template instance to be copied
     * @return copy instance
     */
    @Nullable
    public static SearchKeyword deepCopy(@Nullable final SearchKeyword template) {
        if (template == null) {
            return null;
        }
        SearchKeywordImpl instance = new SearchKeywordImpl();
        instance.setText(template.getText());
        instance.setSuggestTokenizer(
            com.commercetools.history.models.common.SuggestTokenizer.deepCopy(template.getSuggestTokenizer()));
        return instance;
    }

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

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

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