org.springframework.core.env
Interface PropertyResolver

All Known Subinterfaces:

ConfigurableEnvironment, ConfigurablePropertyResolver, Environment

All Known Implementing Classes:

AbstractEnvironment, AbstractPropertyResolver, DefaultEnvironment, DefaultPortletEnvironment, DefaultWebEnvironment, PropertySourcesPropertyResolver

public interface PropertyResolver

Interface for resolving properties against any underlying source.

Since:

3.1

Author:

Chris Beams

Method Summary

boolean	containsProperty(String key) Return whether the given property key is available for resolution.
String	getProperty(String key) Return the property value associated with the given key.
<T> T	getProperty(String key, Class<T> targetType) Return the property value associated with the given key, or null if the key cannot be resolved.
String	getRequiredProperty(String key) Return the property value associated with the given key, converted to the given targetType (never null).
<T> T	getRequiredProperty(String key, Class<T> targetType) Return the property value associated with the given key, converted to the given targetType (never null).
String	resolvePlaceholders(String text) Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by getProperty(java.lang.String).
String	resolveRequiredPlaceholders(String text) Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by getProperty(java.lang.String).

Method Detail

containsProperty

boolean containsProperty(String key)

Return whether the given property key is available for resolution.

getProperty

String getProperty(String key)

Return the property value associated with the given key.

See Also:

getProperty(String, Class)

getProperty

<T> T getProperty(String key,
                  Class<T> targetType)

Return the property value associated with the given key, or null if the key cannot be resolved.

getRequiredProperty

String getRequiredProperty(String key)
                           throws IllegalStateException

Return the property value associated with the given key, converted to the given targetType (never null).

Throws:

IllegalStateException - if the key cannot be resolved

See Also:

getRequiredProperty(String, Class)

getRequiredProperty

<T> T getRequiredProperty(String key,
                          Class<T> targetType)
                      throws IllegalStateException

Return the property value associated with the given key, converted to the given targetType (never null).

Throws:

IllegalStateException - if the given key cannot be resolved

resolvePlaceholders

String resolvePlaceholders(String text)

Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by getProperty(java.lang.String). Unresolvable placeholders with no default value are ignored and passed through unchanged.

Parameters:

text - the String to resolve

Returns:

the resolved String (never null)

Throws:

IllegalArgumentException - if given text is null

See Also:

resolveRequiredPlaceholders(java.lang.String), SystemPropertyUtils.resolvePlaceholders(String)

resolveRequiredPlaceholders

String resolveRequiredPlaceholders(String text)
                                   throws IllegalArgumentException

Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by getProperty(java.lang.String). Unresolvable placeholders with no default value will cause an IllegalArgumentException to be thrown.

Returns:

the resolved String (never null)

Throws:

IllegalArgumentException - if given text is null

IllegalArgumentException - if any placeholders are unresolvable

See Also:

SystemPropertyUtils.resolvePlaceholders(String, boolean)