Package com.commercetools.api.models.product

Interface SearchKeyword

public interface SearchKeyword
SearchKeyword
Example to create an instance using the builder pattern 

     SearchKeyword searchKeyword = SearchKeyword.builder()
             .text("{text}")
             .build()

  • Method Details

    • getText

      @NotNull @NotNull String getText()

      Text to return in the SuggestionResult.

      Returns:
      text

    • getSuggestTokenizer

      @Valid @Valid SuggestTokenizer getSuggestTokenizer()

      If no tokenizer is defined, the text is used as a single token.

      Returns:
      suggestTokenizer

    • setText

      void setText(String text)

      Text to return in the SuggestionResult.

      Parameters:
      text - value to be set

    • setSuggestTokenizer

      void setSuggestTokenizer(SuggestTokenizer suggestTokenizer)

      If no tokenizer is defined, the text is used as a single token.

      Parameters:
      suggestTokenizer - value to be set

    • of

      static SearchKeyword of()
      factory method
      Returns:
      instance of SearchKeyword

    • of

      static SearchKeyword of(SearchKeyword template)
      factory method to create a shallow copy SearchKeyword
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static SearchKeyword deepCopy(@Nullable SearchKeyword template)
      factory method to create a deep copy of SearchKeyword
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static SearchKeywordBuilder builder()
      builder factory method for SearchKeyword
      Returns:
      builder

    • builder

      static SearchKeywordBuilder builder(SearchKeyword template)
      create builder for SearchKeyword instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withSearchKeyword

      default <T> T withSearchKeyword(Function<SearchKeyword,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<SearchKeyword> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference