Package org.springframework.boot.configurationmetadata

Class ConfigurationMetadataSource

java.lang.Object
org.springframework.boot.configurationmetadata.ConfigurationMetadataSource
All Implemented Interfaces:
Serializable
public class ConfigurationMetadataSource extends Object implements Serializable
A source of configuration metadata. Also defines where the source is declared, for instance if it is defined as a @Bean.
Since:
1.3.0
See Also:

  • Constructor Details

    • ConfigurationMetadataSource

      public ConfigurationMetadataSource()

  • Method Details

    • getGroupId

      public String getGroupId()
      The identifier of the group to which this source is associated.
      Returns:
      the group id

    • getType

      public String getType()
      The type of the source. Usually this is the fully qualified name of a class that defines configuration items. This class may or may not be available at runtime.
      Returns:
      the type

    • getDescription

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

    • getShortDescription

      public String getShortDescription()
      A single-line, single-sentence description of this source, if any.
      Returns:
      the short description
      See Also:

    • setShortDescription

      public void setShortDescription(String shortDescription)

    • getSourceType

      public String getSourceType()
      The type where this source is defined. This can be identical to the type if the source is self-defined.
      Returns:
      the source type

    • getSourceMethod

      public String getSourceMethod()
      The method name that defines this source, if any.
      Returns:
      the source method

    • getProperties

      public Map<String,ConfigurationMetadataProperty> getProperties()
      Return the properties defined by this source.
      Returns:
      the properties