org.springframework.boot.configurationprocessor.metadata

Class ItemHint

java.lang.Object

org.springframework.boot.configurationprocessor.metadata.ItemHint

All Implemented Interfaces:

Comparable<ItemHint>

public class ItemHint
extends Object
implements Comparable<ItemHint>

Provide hints on an ItemMetadata. Defines the list of possible values for a particular item as ItemHint.ValueHint instances.

The name of the hint is the name of the related property with one major exception for map types as both the keys and values of the map can have hints. In such a case, the hint should be suffixed by ".keys" or ".values" respectively. Creating a hint for a map using its property name is therefore invalid.

Since:

1.3.0

Author:

Stephane Nicoll

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ItemHint.ValueHint A hint for a value.
static class	ItemHint.ValueProvider A value provider.

Constructor Summary

Constructors

Constructor and Description
ItemHint(String name, List<ItemHint.ValueHint> values, List<ItemHint.ValueProvider> providers)

Method Summary

Modifier and Type	Method and Description
int	compareTo(ItemHint other)
String	getName()
List<ItemHint.ValueProvider>	getProviders()
List<ItemHint.ValueHint>	getValues()
static ItemHint	newHint(String name, ItemHint.ValueHint... values)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ItemHint

public ItemHint(String name,
                List<ItemHint.ValueHint> values,
                List<ItemHint.ValueProvider> providers)

Method Detail

getName

public String getName()

getValues

public List<ItemHint.ValueHint> getValues()

getProviders

public List<ItemHint.ValueProvider> getProviders()

compareTo

public int compareTo(ItemHint other)

Specified by:

compareTo in interface Comparable<ItemHint>

newHint

public static ItemHint newHint(String name,
                               ItemHint.ValueHint... values)

toString

public String toString()

Overrides:

toString in class Object