Class ValueHint
- java.lang.Object
- org.springframework.boot.configurationmetadata.ValueHint
- All Implemented Interfaces:
Serializable
public class ValueHint extends Object implements Serializable
Hint for a value a given property may have. Provide the value and an optional description.- Since:
- 1.3.0
- See Also:
- Serialized Form
Constructor Summary
Constructors Constructor Description ValueHint()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDescription()
A description of this value, if any.String
getShortDescription()
A single-line, single-sentence description of this hint, if any.Object
getValue()
Return the hint value.void
setDescription(String description)
void
setShortDescription(String shortDescription)
void
setValue(Object value)
String
toString()
Constructor Detail
ValueHint
public ValueHint()
Method Detail
getDescription
public String getDescription()
A description of this value, if any. Can be multi-lines.- Returns:
- the description
- See Also:
getShortDescription()
setDescription
public void setDescription(String description)
getShortDescription
public String getShortDescription()
A single-line, single-sentence description of this hint, if any.- Returns:
- the short description
- See Also:
getDescription()
setShortDescription
public void setShortDescription(String shortDescription)