org.springframework.boot.configurationmetadata

Class ConfigurationMetadataGroup

java.lang.Object

org.springframework.boot.configurationmetadata.ConfigurationMetadataGroup

All Implemented Interfaces:

java.io.Serializable

public class ConfigurationMetadataGroup
extends java.lang.Object
implements java.io.Serializable

Gather a collection of properties that are sharing a common prefix. Provide access to all the sources that have contributed properties to the group.

Since:

1.3.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfigurationMetadataGroup(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Return the id of the group, used as a common prefix for all properties associated to it.
java.util.Map<java.lang.String,ConfigurationMetadataProperty>	getProperties() Return the properties defined in this group.
java.util.Map<java.lang.String,ConfigurationMetadataSource>	getSources() Return the sources defining the properties of this group.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationMetadataGroup

public ConfigurationMetadataGroup(java.lang.String id)

Method Detail

getId

public java.lang.String getId()

Return the id of the group, used as a common prefix for all properties associated to it.

Returns:

the id of the group

getSources

public java.util.Map<java.lang.String,ConfigurationMetadataSource> getSources()

Return the sources defining the properties of this group.

Returns:

the sources of the group

getProperties

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

Return the properties defined in this group.

A property may appear more than once for a given source, potentially with conflicting type or documentation. This is a "merged" view of the properties of this group.

Returns:

the properties of the group

See Also:

ConfigurationMetadataSource.getProperties()