Spring Framework 6.1.4 · org.springframework.core.env.ConfigurablePropertyResolver

Method Summary

Modifier and Type	Method and Description
public ConfigurableConversionService	getConversionService() Return the `ConfigurableConversionService` used when performing type conversions on properties.
public void	setConversionService(ConfigurableConversionService conversionService) Set the `ConfigurableConversionService` to be used when performing type conversions on properties.
public void	setIgnoreUnresolvableNestedPlaceholders(boolean ignoreUnresolvableNestedPlaceholders) Set whether to throw an exception when encountering an unresolvable placeholder nested within the value of a given property.
public void	setPlaceholderPrefix(String placeholderPrefix) Set the prefix that placeholders replaced by this resolver must begin with.
public void	setPlaceholderSuffix(String placeholderSuffix) Set the suffix that placeholders replaced by this resolver must end with.
public void	setRequiredProperties(String... requiredProperties) Specify which properties must be present, to be verified by `validateRequiredProperties()`.
public void	setValueSeparator(String valueSeparator) Specify the separating character between the placeholders replaced by this resolver and their associated default value, or `null` if no such special character should be processed as a value separator.
public void	validateRequiredProperties() Validate that each of the properties specified by `setRequiredProperties` is present and resolves to a non-`null` value.

Inherited from org.springframework.core.env.PropertyResolver:: containsProperty getProperty getProperty getProperty getProperty getRequiredProperty getRequiredProperty resolvePlaceholders resolveRequiredPlaceholders

Method Detail

getConversionService back to summary

getConversionService	back to summary
public ConfigurableConversionService getConversionService() Return the `ConfigurableConversionService` used when performing type conversions on properties. The configurable nature of the returned conversion service allows for the convenient addition and removal of individual `Converter` instances: ConfigurableConversionService cs = env.getConversionService(); cs.addConverter(new FooConverter()); See Also `PropertyResolver#getProperty(String, Class)`, `org.springframework.core.convert.converter.ConverterRegistry#addConverter`

public ConfigurableConversionService getConversionService()

Return the ConfigurableConversionService used when performing type conversions on properties.

The configurable nature of the returned conversion service allows for the convenient addition and removal of individual Converter instances:

ConfigurableConversionService cs = env.getConversionService();
cs.addConverter(new FooConverter());

See Also: PropertyResolver#getProperty(String, Class), org.springframework.core.convert.converter.ConverterRegistry#addConverter

setConversionService back to summary

setConversionService	back to summary
public void setConversionService(ConfigurableConversionService conversionService) Set the `ConfigurableConversionService` to be used when performing type conversions on properties. Note as an alternative to fully replacing the `ConversionService`, consider adding or removing individual `Converter` instances by drilling into `getConversionService()` and calling methods such as `#addConverter`. See Also `PropertyResolver#getProperty(String, Class)`, `getConversionService()`, `org.springframework.core.convert.converter.ConverterRegistry#addConverter`

public void setConversionService(ConfigurableConversionService conversionService)

Set the ConfigurableConversionService to be used when performing type conversions on properties.

Note

as an alternative to fully replacing the ConversionService, consider adding or removing individual Converter instances by drilling into getConversionService() and calling methods such as #addConverter.

See Also: PropertyResolver#getProperty(String, Class), getConversionService(), org.springframework.core.convert.converter.ConverterRegistry#addConverter

setIgnoreUnresolvableNestedPlaceholders back to summary

setIgnoreUnresolvableNestedPlaceholders	back to summary
public void setIgnoreUnresolvableNestedPlaceholders(boolean ignoreUnresolvableNestedPlaceholders) Set whether to throw an exception when encountering an unresolvable placeholder nested within the value of a given property. A `false` value indicates strict resolution, i.e. that an exception will be thrown. A `true` value indicates that unresolvable nested placeholders should be passed through in their unresolved ${...} form. Implementations of `getProperty(String)` and its variants must inspect the value set here to determine correct behavior when property values contain unresolvable placeholders. Since 3.2

public void setIgnoreUnresolvableNestedPlaceholders(boolean ignoreUnresolvableNestedPlaceholders)

Set whether to throw an exception when encountering an unresolvable placeholder nested within the value of a given property. A false value indicates strict resolution, i.e. that an exception will be thrown. A true value indicates that unresolvable nested placeholders should be passed through in their unresolved ${...} form.

Implementations of getProperty(String) and its variants must inspect the value set here to determine correct behavior when property values contain unresolvable placeholders.

Since: 3.2

setPlaceholderPrefix	back to summary
public void setPlaceholderPrefix(String placeholderPrefix) Set the prefix that placeholders replaced by this resolver must begin with.

setPlaceholderSuffix	back to summary
public void setPlaceholderSuffix(String placeholderSuffix) Set the suffix that placeholders replaced by this resolver must end with.

setRequiredProperties	back to summary
public void setRequiredProperties(String... requiredProperties) Specify which properties must be present, to be verified by `validateRequiredProperties()`.

setValueSeparator	back to summary
public void setValueSeparator(String valueSeparator) Specify the separating character between the placeholders replaced by this resolver and their associated default value, or `null` if no such special character should be processed as a value separator.

validateRequiredProperties back to summary

validateRequiredProperties	back to summary
public void validateRequiredProperties() throws MissingRequiredPropertiesException Validate that each of the properties specified by `setRequiredProperties` is present and resolves to a non-`null` value. Exceptions MissingRequiredPropertiesException: if any of the required properties are not resolvable.

public void validateRequiredProperties() throws MissingRequiredPropertiesException

Validate that each of the properties specified by setRequiredProperties is present and resolves to a non-null value.

Exceptions

MissingRequiredPropertiesException:: if any of the required properties are not resolvable.

public Interface ConfigurablePropertyResolver

Method Summary

Method Detail