Uses of Class
org.springframework.boot.context.properties.source.ConfigurationPropertyName
Packages that use ConfigurationPropertyName
Package
Description
External configuration support allowing 'application.properties' to be loaded and used
within a Spring Boot application.
Support for external configuration properties.
Support for
@ConfigurationProperties binding.General
BindHandler implementations.Binding validation support.
Sources for external configuration properties.
-
Uses of ConfigurationPropertyName in org.springframework.boot.context.config
Methods in org.springframework.boot.context.config that return ConfigurationPropertyNameModifier and TypeMethodDescriptionInvalidConfigDataPropertyException.getReplacement()Return the replacement property that should be used instead ornullif not replacement is available. -
Uses of ConfigurationPropertyName in org.springframework.boot.context.properties
Methods in org.springframework.boot.context.properties that return types with arguments of type ConfigurationPropertyNameModifier and TypeMethodDescriptionBoundConfigurationProperties.getAll()Get all bound properties.Methods in org.springframework.boot.context.properties with parameters of type ConfigurationPropertyNameModifier and TypeMethodDescriptionBoundConfigurationProperties.get(ConfigurationPropertyName name) Get the configuration property bound to the given name. -
Uses of ConfigurationPropertyName in org.springframework.boot.context.properties.bind
Methods in org.springframework.boot.context.properties.bind that return ConfigurationPropertyNameModifier and TypeMethodDescriptionBindException.getName()Return the name of the configuration property being bound.Methods in org.springframework.boot.context.properties.bind with parameters of type ConfigurationPropertyNameModifier and TypeMethodDescription<T> BindResult<T>Binder.bind(ConfigurationPropertyName name, Bindable<T> target) Bind the specified targetBindableusing this binder'sproperty sources.<T> BindResult<T>Binder.bind(ConfigurationPropertyName name, Bindable<T> target, BindHandler handler) Bind the specified targetBindableusing this binder'sproperty sources.<T> TBinder.bindOrCreate(ConfigurationPropertyName name, Bindable<T> target, BindHandler handler) Bind the specified targetBindableusing this binder'sproperty sourcesor create a new instance using the type of theBindableif the result of the binding isnull.default ObjectBindHandler.onCreate(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result) Called when binding of an element ends with an unbound result and a newly created instance is about to be returned.AbstractBindHandler.onFailure(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Exception error) default ObjectBindHandler.onFailure(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Exception error) Called when binding fails for any reason (including failures fromBindHandler.onSuccess(org.springframework.boot.context.properties.source.ConfigurationPropertyName, org.springframework.boot.context.properties.bind.Bindable<?>, org.springframework.boot.context.properties.bind.BindContext, java.lang.Object)orBindHandler.onCreate(org.springframework.boot.context.properties.source.ConfigurationPropertyName, org.springframework.boot.context.properties.bind.Bindable<?>, org.springframework.boot.context.properties.bind.BindContext, java.lang.Object)calls).voidAbstractBindHandler.onFinish(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result) default voidBindHandler.onFinish(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result) Called when binding finishes with either bound or unbound result.<T> Bindable<T>AbstractBindHandler.onStart(ConfigurationPropertyName name, Bindable<T> target, BindContext context) default <T> Bindable<T>BindHandler.onStart(ConfigurationPropertyName name, Bindable<T> target, BindContext context) Called when binding of an element starts but before any result has been determined.AbstractBindHandler.onSuccess(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result) default ObjectBindHandler.onSuccess(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result) Called when binding of an element ends with a successful result.BoundPropertiesTrackingBindHandler.onSuccess(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result) -
Uses of ConfigurationPropertyName in org.springframework.boot.context.properties.bind.handler
Methods in org.springframework.boot.context.properties.bind.handler with parameters of type ConfigurationPropertyNameModifier and TypeMethodDescriptionIgnoreErrorsBindHandler.onFailure(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Exception error) IgnoreTopLevelConverterNotFoundBindHandler.onFailure(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Exception error) NoUnboundElementsBindHandler.onFailure(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Exception error) voidNoUnboundElementsBindHandler.onFinish(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result) <T> Bindable<T>NoUnboundElementsBindHandler.onStart(ConfigurationPropertyName name, Bindable<T> target, BindContext context) NoUnboundElementsBindHandler.onSuccess(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result) -
Uses of ConfigurationPropertyName in org.springframework.boot.context.properties.bind.validation
Methods in org.springframework.boot.context.properties.bind.validation that return ConfigurationPropertyNameModifier and TypeMethodDescriptionValidationErrors.getName()Return the name of the item that was being validated.Methods in org.springframework.boot.context.properties.bind.validation with parameters of type ConfigurationPropertyNameModifier and TypeMethodDescriptionValidationBindHandler.onFailure(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Exception error) voidValidationBindHandler.onFinish(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result) <T> Bindable<T>ValidationBindHandler.onStart(ConfigurationPropertyName name, Bindable<T> target, BindContext context) ValidationBindHandler.onSuccess(ConfigurationPropertyName name, Bindable<?> target, BindContext context, Object result) -
Uses of ConfigurationPropertyName in org.springframework.boot.context.properties.source
Fields in org.springframework.boot.context.properties.source declared as ConfigurationPropertyNameModifier and TypeFieldDescriptionstatic final ConfigurationPropertyNameConfigurationPropertyName.EMPTYAn emptyConfigurationPropertyName.Methods in org.springframework.boot.context.properties.source that return ConfigurationPropertyNameModifier and TypeMethodDescriptionstatic ConfigurationPropertyNameConfigurationPropertyName.adapt(CharSequence name, char separator) Create aConfigurationPropertyNameby adapting the given source.Create a newConfigurationPropertyNameby appending the given suffix.ConfigurationPropertyName.append(ConfigurationPropertyName suffix) Create a newConfigurationPropertyNameby appending the given suffix.ConfigurationPropertyName.chop(int size) Return a newConfigurationPropertyNameby chopping this name to the givensize.ConfigurationProperty.getName()Return the name of the configuration property.ConfigurationPropertyNameAliases.getNameForAlias(ConfigurationPropertyName alias) ConfigurationPropertyName.getParent()Return the parent of thisConfigurationPropertyNameorEMPTYif there is no parent.static ConfigurationPropertyNameConfigurationPropertyName.of(CharSequence name) Return aConfigurationPropertyNamefor the specified string.static ConfigurationPropertyNameConfigurationPropertyName.ofIfValid(CharSequence name) Return aConfigurationPropertyNamefor the specified string ornullif the name is not valid.ConfigurationPropertyName.subName(int offset) Return a newConfigurationPropertyNameby based on this name offset by specific element index.Methods in org.springframework.boot.context.properties.source that return types with arguments of type ConfigurationPropertyNameModifier and TypeMethodDescriptionConfigurationPropertyNameAliases.getAliases(ConfigurationPropertyName name) ConfigurationPropertyNameAliases.iterator()default Iterator<ConfigurationPropertyName>IterableConfigurationPropertySource.iterator()Return an iterator for thenamesmanaged by this source.MapConfigurationPropertySource.iterator()IterableConfigurationPropertySource.stream()Returns a sequentialStreamfor thenamesmanaged by this source.MapConfigurationPropertySource.stream()Methods in org.springframework.boot.context.properties.source with parameters of type ConfigurationPropertyNameModifier and TypeMethodDescriptionvoidConfigurationPropertyNameAliases.addAliases(ConfigurationPropertyName name, ConfigurationPropertyName... aliases) ConfigurationPropertyName.append(ConfigurationPropertyName suffix) Create a newConfigurationPropertyNameby appending the given suffix.intConfigurationPropertyName.compareTo(ConfigurationPropertyName other) default ConfigurationPropertyStateConfigurationPropertySource.containsDescendantOf(ConfigurationPropertyName name) Returns if the source contains any descendants of the specified name.default ConfigurationPropertyStateIterableConfigurationPropertySource.containsDescendantOf(ConfigurationPropertyName name) ConfigurationPropertyNameAliases.getAliases(ConfigurationPropertyName name) ConfigurationPropertySource.getConfigurationProperty(ConfigurationPropertyName name) Return a singleConfigurationPropertyfrom the source ornullif no property can be found.MapConfigurationPropertySource.getConfigurationProperty(ConfigurationPropertyName name) ConfigurationPropertyNameAliases.getNameForAlias(ConfigurationPropertyName alias) booleanConfigurationPropertyName.isAncestorOf(ConfigurationPropertyName name) Returnstrueif this element is an ancestor (immediate or nested parent) of the specified name.booleanConfigurationPropertyName.isParentOf(ConfigurationPropertyName name) Returnstrueif this element is an immediate parent of the specified name.Method parameters in org.springframework.boot.context.properties.source with type arguments of type ConfigurationPropertyNameModifier and TypeMethodDescriptiondefault ConfigurationPropertySourceConfigurationPropertySource.filter(Predicate<ConfigurationPropertyName> filter) Return a filtered variant of this source, containing only names that match the givenPredicate.IterableConfigurationPropertySource.filter(Predicate<ConfigurationPropertyName> filter) Constructors in org.springframework.boot.context.properties.source with parameters of type ConfigurationPropertyNameModifierConstructorDescriptionConfigurationProperty(ConfigurationPropertyName name, Object value, Origin origin) ConfigurationPropertyNameAliases(ConfigurationPropertyName name, ConfigurationPropertyName... aliases)