类 ConfigurationMetadataProperty
- java.lang.Object
 - org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
 
- 所有已实现的接口:
 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.- 从以下版本开始:
 - 1.3.0
 - 另请参阅:
 - 序列化表格
 
构造器概要
构造器 构造器 说明 ConfigurationMetadataProperty()
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 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. simple-property).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)
构造器详细资料
ConfigurationMetadataProperty
public ConfigurationMetadataProperty()
方法详细资料
getId
public String getId()
The full identifier of the property, in lowercase dashed form (e.g. my.group.simple-property)- 返回:
 - 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.- 返回:
 - 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.
- 返回:
 - the property type
 
getDescription
public String getDescription()
A description of the property, if any. Can be multi-lines.- 返回:
 - the property description
 - 另请参阅:
 getShortDescription()
setDescription
public void setDescription(String description)
getShortDescription
public String getShortDescription()
A single-line, single-sentence description of this property, if any.- 返回:
 - the property short description
 - 另请参阅:
 getDescription()
setShortDescription
public void setShortDescription(String shortDescription)
getDefaultValue
public Object getDefaultValue()
The default value, if any.- 返回:
 - the default value
 
setDefaultValue
public void setDefaultValue(Object defaultValue)
getDeprecation
public Deprecation getDeprecation()
TheDeprecationfor this property, if any.- 返回:
 - the deprecation
 - 另请参阅:
 isDeprecated()
setDeprecation
public void setDeprecation(Deprecation deprecation)
isDeprecated
public boolean isDeprecated()
Specify if the property is deprecated.- 返回:
 - if the property is deprecated
 - 另请参阅:
 getDeprecation()