Class Hints

java.lang.Object
org.springframework.boot.configurationmetadata.Hints
public class Hints extends Object
Hints of an item to provide the list of values and/or the name of the provider responsible to identify suitable values. If the type of the related item is a Map it can have both key and value hints.
Since:
1.4.0

  • Constructor Details

    • Hints

      public Hints()

  • Method Details

    • getKeyHints

      public List<ValueHint> getKeyHints()
      The list of well-defined keys, if any. Only applicable if the type of the related item is a Map. If no extra provider is specified, these values are to be considered a closed-set of the available keys for the map.
      Returns:
      the key hints

    • getKeyProviders

      public List<ValueProvider> getKeyProviders()
      The value providers that are applicable to the keys of this item. Only applicable if the type of the related item is a Map. Only one ValueProvider is enabled for a key: the first in the list that is supported should be used.
      Returns:
      the key providers

    • getValueHints

      public List<ValueHint> getValueHints()
      The list of well-defined values, if any. If no extra provider is specified, these values are to be considered a closed-set of the available values for this item.
      Returns:
      the value hints

    • getValueProviders

      public List<ValueProvider> getValueProviders()
      The value providers that are applicable to this item. Only one ValueProvider is enabled for an item: the first in the list that is supported should be used.
      Returns:
      the value providers