public interface PropertyResolver
Environment
,
PropertySourcesPropertyResolver
Modifier and Type | Method and Description |
---|---|
boolean |
containsProperty(String key)
Return whether the given property key is available for resolution, i.e.,
the value for the given key is not
null . |
String |
getProperty(String key)
Return the property value associated with the given key, or
null
if the key cannot be resolved. |
<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. |
<T> T |
getProperty(String key,
Class<T> targetType,
T defaultValue)
Return the property value associated with the given key, or
defaultValue if the key cannot be resolved. |
String |
getProperty(String key,
String defaultValue)
Return the property value associated with the given key, or
defaultValue if the key cannot be resolved. |
<T> Class<T> |
getPropertyAsClass(String key,
Class<T> targetType)
Convert the property value associated with the given key to a
Class
of type T or null if the key cannot be resolved. |
String |
getRequiredProperty(String key)
Return the property value associated with the given key (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) . |
boolean containsProperty(String key)
null
.String getProperty(String key)
null
if the key cannot be resolved.key
- the property name to resolvegetProperty(String, String)
,
getProperty(String, Class)
,
getRequiredProperty(String)
String getProperty(String key, String defaultValue)
defaultValue
if the key cannot be resolved.key
- the property name to resolvedefaultValue
- the default value to return if no value is foundgetRequiredProperty(String)
,
getProperty(String, Class)
<T> T getProperty(String key, Class<T> targetType)
null
if the key cannot be resolved.key
- the property name to resolvetargetType
- the expected type of the property valuegetRequiredProperty(String, Class)
<T> T getProperty(String key, Class<T> targetType, T defaultValue)
defaultValue
if the key cannot be resolved.key
- the property name to resolvetargetType
- the expected type of the property valuedefaultValue
- the default value to return if no value is foundgetRequiredProperty(String, Class)
<T> Class<T> getPropertyAsClass(String key, Class<T> targetType)
Class
of type T
or null
if the key cannot be resolved.ConversionException
- if class specified
by property value cannot be found or loaded or if targetType is not assignable
from class specified by property valuegetProperty(String, Class)
String getRequiredProperty(String key) throws IllegalStateException
null
).IllegalStateException
- if the key cannot be resolvedgetRequiredProperty(String, Class)
<T> T getRequiredProperty(String key, Class<T> targetType) throws IllegalStateException
null
).IllegalStateException
- if the given key cannot be resolvedString resolvePlaceholders(String text)
getProperty(java.lang.String)
. Unresolvable placeholders with
no default value are ignored and passed through unchanged.text
- the String to resolvenull
)IllegalArgumentException
- if given text is null
resolveRequiredPlaceholders(java.lang.String)
,
SystemPropertyUtils.resolvePlaceholders(String)
String resolveRequiredPlaceholders(String text) throws IllegalArgumentException
getProperty(java.lang.String)
. Unresolvable placeholders with
no default value will cause an IllegalArgumentException to be thrown.null
)IllegalArgumentException
- if given text is null
or if any placeholders are unresolvableSystemPropertyUtils.resolvePlaceholders(String, boolean)