org.springframework.boot.configurationmetadata

Class ConfigurationMetadataSource

java.lang.Object

org.springframework.boot.configurationmetadata.ConfigurationMetadataSource

All Implemented Interfaces:

java.io.Serializable

public class ConfigurationMetadataSource
extends java.lang.Object
implements java.io.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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfigurationMetadataSource()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() A description of this source, if any.
java.lang.String	getGroupId() The identifier of the group to which this source is associated.
java.util.Map<java.lang.String,ConfigurationMetadataProperty>	getProperties() Return the properties defined by this source.
java.lang.String	getShortDescription() A single-line, single-sentence description of this source, if any.
java.lang.String	getSourceMethod() The method name that defines this source, if any.
java.lang.String	getSourceType() The type where this source is defined.
java.lang.String	getType() The type of the source.
void	setShortDescription(java.lang.String shortDescription)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigurationMetadataSource

public ConfigurationMetadataSource()

Method Detail

getGroupId

public java.lang.String getGroupId()

The identifier of the group to which this source is associated.

Returns:

the group id

getType

public java.lang.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 java.lang.String getDescription()

A description of this source, if any. Can be multi-lines.

Returns:

the description

See Also:

getShortDescription()

getShortDescription

public java.lang.String getShortDescription()

A single-line, single-sentence description of this source, if any.

Returns:

the short description

See Also:

getDescription()

setShortDescription

public void setShortDescription(java.lang.String shortDescription)

getSourceType

public java.lang.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 java.lang.String getSourceMethod()

The method name that defines this source, if any.

Returns:

the source method

getProperties

public java.util.Map<java.lang.String,ConfigurationMetadataProperty> getProperties()

Return the properties defined by this source.

Returns:

the properties