Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- add(Collection<ConfigurationMetadataSource>) - Method in class org.springframework.boot.configurationmetadata.SimpleConfigurationMetadataRepository
-
Register the specified
sources
. - add(ConfigurationMetadataProperty, ConfigurationMetadataSource) - Method in class org.springframework.boot.configurationmetadata.SimpleConfigurationMetadataRepository
-
Add a
ConfigurationMetadataProperty
with thesource
that defines it, if any.
B
- build() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataRepositoryJsonBuilder
-
Build a
ConfigurationMetadataRepository
with the current state of this builder.
C
- ConfigurationMetadataGroup - Class in org.springframework.boot.configurationmetadata
-
Gather a collection of
properties
that are sharing acommon prefix
. - ConfigurationMetadataGroup(String) - Constructor for class org.springframework.boot.configurationmetadata.ConfigurationMetadataGroup
- ConfigurationMetadataProperty - Class in org.springframework.boot.configurationmetadata
-
Define a configuration property.
- ConfigurationMetadataProperty() - Constructor for class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
- ConfigurationMetadataRepository - Interface in org.springframework.boot.configurationmetadata
-
A repository of configuration metadata.
- ConfigurationMetadataRepositoryJsonBuilder - Class in org.springframework.boot.configurationmetadata
-
Load a
ConfigurationMetadataRepository
from the content of arbitrary resource(s). - ConfigurationMetadataSource - Class in org.springframework.boot.configurationmetadata
-
A source of configuration metadata.
- ConfigurationMetadataSource() - Constructor for class org.springframework.boot.configurationmetadata.ConfigurationMetadataSource
- create() - Static method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataRepositoryJsonBuilder
-
Create a new builder instance using
StandardCharsets.UTF_8
as the default charset. - create(InputStream...) - Static method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataRepositoryJsonBuilder
-
Create a new builder instance using
StandardCharsets.UTF_8
as the default charset and the specified json resource. - create(Charset) - Static method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataRepositoryJsonBuilder
-
Create a new builder instance using the specified default
Charset
.
D
- Deprecation - Class in org.springframework.boot.configurationmetadata
-
Indicate that a property is deprecated.
- Deprecation() - Constructor for class org.springframework.boot.configurationmetadata.Deprecation
- Deprecation.Level - Enum Class in org.springframework.boot.configurationmetadata
-
Define the deprecation level.
E
- ERROR - Enum constant in enum class org.springframework.boot.configurationmetadata.Deprecation.Level
-
The property has been removed and is no longer bound.
G
- getAllGroups() - Method in interface org.springframework.boot.configurationmetadata.ConfigurationMetadataRepository
-
Return the groups, indexed by id.
- getAllGroups() - Method in class org.springframework.boot.configurationmetadata.SimpleConfigurationMetadataRepository
- getAllProperties() - Method in interface org.springframework.boot.configurationmetadata.ConfigurationMetadataRepository
-
Return the properties, indexed by id.
- getAllProperties() - Method in class org.springframework.boot.configurationmetadata.SimpleConfigurationMetadataRepository
- getDefaultValue() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
-
The default value, if any.
- getDeprecation() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
-
The
Deprecation
for this property, if any. - getDescription() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
-
A description of the property, if any.
- getDescription() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataSource
-
A description of this source, if any.
- getDescription() - Method in class org.springframework.boot.configurationmetadata.ValueHint
-
A description of this value, if any.
- getGroupId() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataSource
-
The identifier of the group to which this source is associated.
- getHints() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
-
Return the hints of this item.
- getId() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataGroup
-
Return the id of the group, used as a common prefix for all properties associated to it.
- getId() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
-
The full identifier of the property, in lowercase dashed form (e.g.
- getKeyHints() - Method in class org.springframework.boot.configurationmetadata.Hints
-
The list of well-defined keys, if any.
- getKeyProviders() - Method in class org.springframework.boot.configurationmetadata.Hints
-
The value providers that are applicable to the keys of this item.
- getLevel() - Method in class org.springframework.boot.configurationmetadata.Deprecation
-
Define the
Deprecation.Level
of deprecation. - getName() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
-
The name of the property, in lowercase dashed form (e.g.
- getName() - Method in class org.springframework.boot.configurationmetadata.ValueProvider
-
Return the name of the provider.
- getParameters() - Method in class org.springframework.boot.configurationmetadata.ValueProvider
-
Return the parameters.
- getProperties() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataGroup
-
Return the
properties
defined in this group. - getProperties() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataSource
-
Return the properties defined by this source.
- getReason() - Method in class org.springframework.boot.configurationmetadata.Deprecation
-
A reason why the related property is deprecated, if any.
- getReplacement() - Method in class org.springframework.boot.configurationmetadata.Deprecation
-
The full name of the property that replaces the related deprecated property, if any.
- getShortDescription() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
-
A single-line, single-sentence description of this property, if any.
- getShortDescription() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataSource
-
A single-line, single-sentence description of this source, if any.
- getShortDescription() - Method in class org.springframework.boot.configurationmetadata.ValueHint
-
A single-line, single-sentence description of this hint, if any.
- getShortReason() - Method in class org.springframework.boot.configurationmetadata.Deprecation
-
A single-line, single-sentence reason why the related property is deprecated, if any.
- getSourceMethod() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataSource
-
The method name that defines this source, if any.
- getSources() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataGroup
-
Return the
sources
defining the properties of this group. - getSourceType() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataSource
-
The type where this source is defined.
- getType() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
-
The class name of the data type of the property.
- getType() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataSource
-
The type of the source.
- getValue() - Method in class org.springframework.boot.configurationmetadata.ValueHint
-
Return the hint value.
- getValueHints() - Method in class org.springframework.boot.configurationmetadata.Hints
-
The list of well-defined values, if any.
- getValueProviders() - Method in class org.springframework.boot.configurationmetadata.Hints
-
The value providers that are applicable to this item.
H
- Hints - Class in org.springframework.boot.configurationmetadata
-
Hints of an item to provide the list of values and/or the name of the provider responsible to identify suitable values.
- Hints() - Constructor for class org.springframework.boot.configurationmetadata.Hints
I
- include(ConfigurationMetadataRepository) - Method in class org.springframework.boot.configurationmetadata.SimpleConfigurationMetadataRepository
-
Merge the content of the specified repository to this repository.
- isDeprecated() - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
-
Specify if the property is deprecated.
O
- org.springframework.boot.configurationmetadata - package org.springframework.boot.configurationmetadata
-
Spring Boot configuration meta-data parser.
R
- ROOT_GROUP - Static variable in interface org.springframework.boot.configurationmetadata.ConfigurationMetadataRepository
-
Defines the name of the "root" group, that is the group that gathers all the properties that aren't attached to a specific group.
S
- setDefaultValue(Object) - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
- setDeprecation(Deprecation) - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
- setDescription(String) - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
- setDescription(String) - Method in class org.springframework.boot.configurationmetadata.ValueHint
- setId(String) - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
- setLevel(Deprecation.Level) - Method in class org.springframework.boot.configurationmetadata.Deprecation
- setName(String) - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
- setName(String) - Method in class org.springframework.boot.configurationmetadata.ValueProvider
- setReason(String) - Method in class org.springframework.boot.configurationmetadata.Deprecation
- setReplacement(String) - Method in class org.springframework.boot.configurationmetadata.Deprecation
- setShortDescription(String) - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
- setShortDescription(String) - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataSource
- setShortDescription(String) - Method in class org.springframework.boot.configurationmetadata.ValueHint
- setShortReason(String) - Method in class org.springframework.boot.configurationmetadata.Deprecation
- setType(String) - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty
- setValue(Object) - Method in class org.springframework.boot.configurationmetadata.ValueHint
- SimpleConfigurationMetadataRepository - Class in org.springframework.boot.configurationmetadata
-
The default
ConfigurationMetadataRepository
implementation. - SimpleConfigurationMetadataRepository() - Constructor for class org.springframework.boot.configurationmetadata.SimpleConfigurationMetadataRepository
T
- toString() - Method in class org.springframework.boot.configurationmetadata.Deprecation
- toString() - Method in class org.springframework.boot.configurationmetadata.ValueHint
- toString() - Method in class org.springframework.boot.configurationmetadata.ValueProvider
V
- ValueHint - Class in org.springframework.boot.configurationmetadata
-
Hint for a value a given property may have.
- ValueHint() - Constructor for class org.springframework.boot.configurationmetadata.ValueHint
- valueOf(String) - Static method in enum class org.springframework.boot.configurationmetadata.Deprecation.Level
-
Returns the enum constant of this class with the specified name.
- ValueProvider - Class in org.springframework.boot.configurationmetadata
-
Define a component that is able to provide the values of a property.
- ValueProvider() - Constructor for class org.springframework.boot.configurationmetadata.ValueProvider
- values() - Static method in enum class org.springframework.boot.configurationmetadata.Deprecation.Level
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- WARNING - Enum constant in enum class org.springframework.boot.configurationmetadata.Deprecation.Level
-
The property is still bound.
- withJsonResource(InputStream) - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataRepositoryJsonBuilder
-
Add the content of a
ConfigurationMetadataRepository
defined by the specifiedInputStream
json document using the default charset. - withJsonResource(InputStream, Charset) - Method in class org.springframework.boot.configurationmetadata.ConfigurationMetadataRepositoryJsonBuilder
-
Add the content of a
ConfigurationMetadataRepository
defined by the specifiedInputStream
json document using the specifiedCharset
.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form