Package org.springframework.util
Class PropertyPlaceholderHelper
- java.lang.Object
- org.springframework.util.PropertyPlaceholderHelper
public class PropertyPlaceholderHelper extends Object
Utility class for working with Strings that have placeholder values in them. A placeholder takes the form${name}
. UsingPropertyPlaceholderHelper
these placeholders can be substituted for user-supplied values.Values for substitution can be supplied using a
Properties
instance or using aPropertyPlaceholderHelper.PlaceholderResolver
.- Since:
- 3.0
- Author:
- Juergen Hoeller, Rob Harrop
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
PropertyPlaceholderHelper.PlaceholderResolver
Strategy interface used to resolve replacement values for placeholders contained in Strings.
Constructor Summary
Constructors Constructor Description PropertyPlaceholderHelper(String placeholderPrefix, String placeholderSuffix)
Creates a newPropertyPlaceholderHelper
that uses the supplied prefix and suffix.PropertyPlaceholderHelper(String placeholderPrefix, String placeholderSuffix, String valueSeparator, boolean ignoreUnresolvablePlaceholders)
Creates a newPropertyPlaceholderHelper
that uses the supplied prefix and suffix.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected String
parseStringValue(String value, PropertyPlaceholderHelper.PlaceholderResolver placeholderResolver, Set<String> visitedPlaceholders)
String
replacePlaceholders(String value, Properties properties)
Replaces all placeholders of format${name}
with the corresponding property from the suppliedProperties
.String
replacePlaceholders(String value, PropertyPlaceholderHelper.PlaceholderResolver placeholderResolver)
Replaces all placeholders of format${name}
with the value returned from the suppliedPropertyPlaceholderHelper.PlaceholderResolver
.
Constructor Detail
PropertyPlaceholderHelper
public PropertyPlaceholderHelper(String placeholderPrefix, String placeholderSuffix)
Creates a newPropertyPlaceholderHelper
that uses the supplied prefix and suffix. Unresolvable placeholders are ignored.- Parameters:
placeholderPrefix
- the prefix that denotes the start of a placeholderplaceholderSuffix
- the suffix that denotes the end of a placeholder
PropertyPlaceholderHelper
public PropertyPlaceholderHelper(String placeholderPrefix, String placeholderSuffix, String valueSeparator, boolean ignoreUnresolvablePlaceholders)
Creates a newPropertyPlaceholderHelper
that uses the supplied prefix and suffix.- Parameters:
placeholderPrefix
- the prefix that denotes the start of a placeholderplaceholderSuffix
- the suffix that denotes the end of a placeholdervalueSeparator
- the separating character between the placeholder variable and the associated default value, if anyignoreUnresolvablePlaceholders
- indicates whether unresolvable placeholders should be ignored (true
) or cause an exception (false
)
Method Detail
replacePlaceholders
public String replacePlaceholders(String value, Properties properties)
Replaces all placeholders of format${name}
with the corresponding property from the suppliedProperties
.- Parameters:
value
- the value containing the placeholders to be replacedproperties
- theProperties
to use for replacement- Returns:
- the supplied value with placeholders replaced inline
replacePlaceholders
public String replacePlaceholders(String value, PropertyPlaceholderHelper.PlaceholderResolver placeholderResolver)
Replaces all placeholders of format${name}
with the value returned from the suppliedPropertyPlaceholderHelper.PlaceholderResolver
.- Parameters:
value
- the value containing the placeholders to be replacedplaceholderResolver
- thePlaceholderResolver
to use for replacement- Returns:
- the supplied value with placeholders replaced inline
parseStringValue
protected String parseStringValue(String value, PropertyPlaceholderHelper.PlaceholderResolver placeholderResolver, Set<String> visitedPlaceholders)