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 its id which is composed of a namespace prefix (the group id), if any and the name of the property.
Since:
1.3.0
See Also:

  • Constructor Details

    • ConfigurationMetadataProperty

      public ConfigurationMetadataProperty()

  • Method Details

    • getId

      public String getId()
      The full identifier of the property, in lowercase dashed form (e.g. my.group.simple-property)
      Returns:
      the property id

    • setId

      public void setId(String 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

    • setName

      public void setName(String 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. boolean becomes java.lang.Boolean. If the type holds generic information, these are provided as well, i.e. a HashMap of String to Integer would be defined as java.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

    • setType

      public void setType(String type)

    • getDescription

      public String getDescription()
      A description of the property, if any. Can be multi-lines.
      Returns:
      the property description
      See Also:

    • 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:

    • 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)

    • getHints

      public Hints getHints()
      Return the hints of this item.
      Returns:
      the hints

    • getDeprecation

      public Deprecation getDeprecation()
      The Deprecation for this property, if any.
      Returns:
      the deprecation
      See Also:

    • setDeprecation

      public void setDeprecation(Deprecation deprecation)

    • isDeprecated

      public boolean isDeprecated()
      Specify if the property is deprecated.
      Returns:
      if the property is deprecated
      See Also: