Class ConfigurationMetadataProperty
- java.lang.Object
- org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
- All Implemented Interfaces:
Serializable
public class ConfigurationMetadataProperty extends Object implements Serializable
Define a configuration property. Each property is fully identified by itsidwhich is composed of a namespace prefix (thegroup id), if any and thenameof the property.- Since:
- 1.3.0
- See Also:
- Serialized Form
Constructor Summary
Constructors Constructor Description ConfigurationMetadataProperty()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ObjectgetDefaultValue()The default value, if any.DeprecationgetDeprecation()TheDeprecationfor this property, if any.StringgetDescription()A description of the property, if any.HintsgetHints()Return the hints of this item.StringgetId()The full identifier of the property, in lowercase dashed form (e.g.StringgetName()The name of the property, in lowercase dashed form (e.g.StringgetShortDescription()A single-line, single-sentence description of this property, if any.StringgetType()The class name of the data type of the property.booleanisDeprecated()Specify if the property is deprecated.voidsetDefaultValue(Object defaultValue)voidsetDeprecation(Deprecation deprecation)voidsetDescription(String description)voidsetId(String id)voidsetName(String name)voidsetShortDescription(String shortDescription)voidsetType(String type)
Constructor Detail
ConfigurationMetadataProperty
public ConfigurationMetadataProperty()
Method Detail
getId
public String getId()
The full identifier of the property, in lowercase dashed form (e.g. my.group.simple-property)- Returns:
- the property id
getName
public String getName()
The name of the property, in lowercase dashed form (e.g. simple-property). If this item does not belong to any group, the id is returned.- Returns:
- the property name
getType
public String getType()
The class name of the data type of the property. For example,java.lang.String.For consistency, the type of a primitive is specified using its wrapper counterpart, i.e.
booleanbecomesjava.lang.Boolean. If the type holds generic information, these are provided as well, i.e. aHashMapof String to Integer would be defined asjava.util.HashMap <java.lang.String,java.lang.Integer>.Note that this class may be a complex type that gets converted from a String as values are bound.
- Returns:
- the property type
getDescription
public String getDescription()
A description of the property, if any. Can be multi-lines.- Returns:
- the property description
- See Also:
getShortDescription()
setDescription
public void setDescription(String description)
getShortDescription
public String getShortDescription()
A single-line, single-sentence description of this property, if any.- Returns:
- the property short description
- See Also:
getDescription()
setShortDescription
public void setShortDescription(String shortDescription)
getDefaultValue
public Object getDefaultValue()
The default value, if any.- Returns:
- the default value
setDefaultValue
public void setDefaultValue(Object defaultValue)
getDeprecation
public Deprecation getDeprecation()
TheDeprecationfor this property, if any.- Returns:
- the deprecation
- See Also:
isDeprecated()
setDeprecation
public void setDeprecation(Deprecation deprecation)
isDeprecated
public boolean isDeprecated()
Specify if the property is deprecated.- Returns:
- if the property is deprecated
- See Also:
getDeprecation()