Interface SuggestionResult


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

     SuggestionResult suggestionResult = SuggestionResult.builder()
             .plus/searchKeywords.[a-z]{2}(-[A-Z]{2})?/(/searchKeywords.[a-z]{2}(-[A-Z]{2})?/Builder -> /searchKeywords.[a-z]{2}(-[A-Z]{2})?/Builder)
             .build()
 
  • Method Details

    • values

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

      The result may contain multiple Suggestions identified by their Locale. See Suggestions for two languages.

      Returns:
      map of the pattern property values
    • setValue

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

      The result may contain multiple Suggestions identified by their Locale. See Suggestions for two languages.

      Parameters:
      key - property name
      value - property value
    • of

      static SuggestionResult of()
      factory method
      Returns:
      instance of SuggestionResult
    • of

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

      factory method to create a deep copy of SuggestionResult
      Parameters:
      template - instance to be copied
      Returns:
      copy instance
    • builder

      static SuggestionResultBuilder builder()
      builder factory method for SuggestionResult
      Returns:
      builder
    • builder

      static SuggestionResultBuilder builder(SuggestionResult template)
      create builder for SuggestionResult instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder
    • withSuggestionResult

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