Package com.commercetools.api.models.product

Interface SearchKeywords

public interface SearchKeywords

Search keywords are JSON objects primarily used by Search Term Suggestions, but are also considered for a full text search in the Product Projection Search API. The keys are of type Locale, and the values are an array of SearchKeyword.

Example to create an instance using the builder pattern 

     SearchKeywords searchKeywords = SearchKeywords.builder()
             .plus/^[a-z]{2}(-[A-Z]{2})?$/(/^[a-z]{2}(-[A-Z]{2})?$/Builder -> /^[a-z]{2}(-[A-Z]{2})?$/Builder)
             .build()

  • Method Details

    • values

      @NotNull @Valid @NotNull @Valid Map<String,List<SearchKeyword>> values()

      Key-value pair where the keys are of type Locale and the values are an array of SearchKeyword.

      Returns:
      map of the pattern property values

    • setValue

      void setValue(String key, List<SearchKeyword> value)

      Key-value pair where the keys are of type Locale and the values are an array of SearchKeyword.

      Parameters:
      key - property name
      value - property value

    • of

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

    • of

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

    • copyDeep

      SearchKeywords copyDeep()

    • deepCopy

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

    • builder

      static SearchKeywordsBuilder builder()
      builder factory method for SearchKeywords
      Returns:
      builder

    • builder

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

    • withSearchKeywords

      default <T> T withSearchKeywords(Function<SearchKeywords,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<SearchKeywords> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference