Utility class for working with Strings that have placeholder values in them. A placeholder takes the form ${name}. Using PropertyPlaceholderHelper these placeholders can be substituted for user-supplied values.

Values for substitution can be supplied using a Properties instance or using a PlaceholderResolver.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	PropertyPlaceholderHelper.PlaceholderResolver Strategy interface used to resolve replacement values for placeholders contained in Strings.

Field Summary

Modifier and Type	Field and Description
private final boolean	ignoreUnresolvablePlaceholders
private static final Log	logger
private final String	placeholderPrefix
private final String	placeholderSuffix
private final String	simplePrefix
private final String	valueSeparator
private static final Map<String, String>	wellKnownSimplePrefixes

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	PropertyPlaceholderHelper(String the prefix that denotes the start of a placeholder placeholderPrefix, String the suffix that denotes the end of a placeholder placeholderSuffix) Creates a new `PropertyPlaceholderHelper` that uses the supplied prefix and suffix.
public	PropertyPlaceholderHelper(String the prefix that denotes the start of a placeholder placeholderPrefix, String the suffix that denotes the end of a placeholder placeholderSuffix, String the separating character between the placeholder variable and the associated default value, if any valueSeparator, boolean indicates whether unresolvable placeholders should be ignored (`true`) or cause an exception (`false`) ignoreUnresolvablePlaceholders) Creates a new `PropertyPlaceholderHelper` that uses the supplied prefix and suffix.

public

PropertyPlaceholderHelper(String

the prefix that denotes the start of a placeholder

placeholderPrefix, String

the suffix that denotes the end of a placeholder

placeholderSuffix)

Creates a new PropertyPlaceholderHelper that uses the supplied prefix and suffix.

public

PropertyPlaceholderHelper(String

the prefix that denotes the start of a placeholder

placeholderPrefix, String

the suffix that denotes the end of a placeholder

placeholderSuffix, String

the separating character between the placeholder variable and the associated default value, if any

valueSeparator, boolean

indicates whether unresolvable placeholders should be ignored (true) or cause an exception (false)

ignoreUnresolvablePlaceholders)

Creates a new PropertyPlaceholderHelper that uses the supplied prefix and suffix.

Method Summary

Modifier and Type	Method and Description
private int	findPlaceholderEndIndex(CharSequence buf, int startIndex)
protected String	parseStringValue(String value, PropertyPlaceholderHelper.PlaceholderResolver placeholderResolver, Set<String> visitedPlaceholders)
public String	Returns: the supplied value with placeholders replaced inline replacePlaceholders(String the value containing the placeholders to be replaced value, final Properties the `Properties` to use for replacement properties) Replaces all placeholders of format `${name}` with the corresponding property from the supplied `Properties`.
public String	Returns: the supplied value with placeholders replaced inline replacePlaceholders(String the value containing the placeholders to be replaced value, PropertyPlaceholderHelper.PlaceholderResolver the `PlaceholderResolver` to use for replacement placeholderResolver) Replaces all placeholders of format `${name}` with the value returned from the supplied `PlaceholderResolver`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ignoreUnresolvablePlaceholders	back to summary
private final boolean ignoreUnresolvablePlaceholders

logger	back to summary
private static final Log logger

placeholderPrefix	back to summary
private final String placeholderPrefix

placeholderSuffix	back to summary
private final String placeholderSuffix

simplePrefix	back to summary
private final String simplePrefix

valueSeparator	back to summary
private final String valueSeparator Annotations @Nullable

wellKnownSimplePrefixes	back to summary
private static final Map<String, String> wellKnownSimplePrefixes

Constructor Detail

PropertyPlaceholderHelper back to summary

PropertyPlaceholderHelper	back to summary
public PropertyPlaceholderHelper(String placeholderPrefix, String placeholderSuffix) Creates a new `PropertyPlaceholderHelper` that uses the supplied prefix and suffix. Unresolvable placeholders are ignored. Parameters placeholderPrefix:String the prefix that denotes the start of a placeholder placeholderSuffix:String the suffix that denotes the end of a placeholder

public PropertyPlaceholderHelper(String placeholderPrefix, String placeholderSuffix)

Creates a new PropertyPlaceholderHelper that uses the supplied prefix and suffix. Unresolvable placeholders are ignored.

Parameters

placeholderPrefix:String: the prefix that denotes the start of a placeholder
placeholderSuffix:String: the suffix that denotes the end of a placeholder

PropertyPlaceholderHelper back to summary

PropertyPlaceholderHelper	back to summary
public PropertyPlaceholderHelper(String placeholderPrefix, String placeholderSuffix, String valueSeparator, boolean ignoreUnresolvablePlaceholders) Creates a new `PropertyPlaceholderHelper` that uses the supplied prefix and suffix. Parameters placeholderPrefix:String the prefix that denotes the start of a placeholder placeholderSuffix:String the suffix that denotes the end of a placeholder valueSeparator:String the separating character between the placeholder variable and the associated default value, if any ignoreUnresolvablePlaceholders:boolean indicates whether unresolvable placeholders should be ignored (`true`) or cause an exception (`false`)

public PropertyPlaceholderHelper(String placeholderPrefix, String placeholderSuffix, String valueSeparator, boolean ignoreUnresolvablePlaceholders)

Creates a new PropertyPlaceholderHelper that uses the supplied prefix and suffix.

Parameters

placeholderPrefix:String: the prefix that denotes the start of a placeholder
placeholderSuffix:String: the suffix that denotes the end of a placeholder
valueSeparator:String: the separating character between the placeholder variable and the associated default value, if any
ignoreUnresolvablePlaceholders:boolean: indicates whether unresolvable placeholders should be ignored (true) or cause an exception (false)

Method Detail

findPlaceholderEndIndex	back to summary
private int findPlaceholderEndIndex(CharSequence buf, int startIndex)

parseStringValue	back to summary
protected String parseStringValue(String value, PropertyPlaceholderHelper.PlaceholderResolver placeholderResolver, Set<String> visitedPlaceholders)

replacePlaceholders back to summary

replacePlaceholders	back to summary
public String replacePlaceholders(String value, final Properties properties) Replaces all placeholders of format `${name}` with the corresponding property from the supplied `Properties`. Parameters value:String the value containing the placeholders to be replaced properties:Properties the `Properties` to use for replacement Returns:String the supplied value with placeholders replaced inline

public String replacePlaceholders(String value, final Properties properties)

Replaces all placeholders of format ${name} with the corresponding property from the supplied Properties.

Parameters

value:String: the value containing the placeholders to be replaced
properties:Properties: the Properties to use for replacement

Returns:String

the supplied value with placeholders replaced inline

replacePlaceholders back to summary

replacePlaceholders	back to summary
public String replacePlaceholders(String value, PropertyPlaceholderHelper.PlaceholderResolver placeholderResolver) Replaces all placeholders of format `${name}` with the value returned from the supplied `PlaceholderResolver`. Parameters value:String the value containing the placeholders to be replaced placeholderResolver:PropertyPlaceholderHelper.PlaceholderResolver the `PlaceholderResolver` to use for replacement Returns:String the supplied value with placeholders replaced inline

public String replacePlaceholders(String value, PropertyPlaceholderHelper.PlaceholderResolver placeholderResolver)

Replaces all placeholders of format ${name} with the value returned from the supplied PlaceholderResolver.

Parameters

value:String: the value containing the placeholders to be replaced
placeholderResolver:PropertyPlaceholderHelper.PlaceholderResolver: the PlaceholderResolver to use for replacement

Returns:String

the supplied value with placeholders replaced inline

org.springframework.util back to summary

public Interface PropertyPlaceholderHelper.PlaceholderResolver

Known Direct Implementers

org.springframework.util.SystemPropertyUtils.SystemPropertyPlaceholderResolver

Annotations

@FunctionalInterface

Strategy interface used to resolve replacement values for placeholders contained in Strings.

Method Summary

Modifier and Type	Method and Description
public String	Returns: the replacement value, or `null` if no replacement is to be made resolvePlaceholder(String the name of the placeholder to resolve placeholderName) Resolve the supplied placeholder name to the replacement value.

Method Detail

resolvePlaceholder back to summary

resolvePlaceholder	back to summary
public String resolvePlaceholder(String placeholderName) Resolve the supplied placeholder name to the replacement value. Parameters placeholderName:String the name of the placeholder to resolve Returns:String the replacement value, or `null` if no replacement is to be made Annotations @Nullable

public String resolvePlaceholder(String placeholderName)

Resolve the supplied placeholder name to the replacement value.

Parameters

placeholderName:String: the name of the placeholder to resolve

Returns:String

the replacement value, or null if no replacement is to be made

Annotations

@Nullable

public Class PropertyPlaceholderHelper

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface PropertyPlaceholderHelper.PlaceholderResolver

Method Summary

Method Detail