Helper class for resolving placeholders in texts. Usually applied to file paths.

A text may contain ${...} placeholders, to be resolved as system properties: e.g. ${user.dir}. Default values can be supplied using the ":" separator between key and value.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	SystemPropertyUtils.SystemPropertyPlaceholderResolver PlaceholderResolver implementation that resolves against system properties and system environment variables.

Field Summary

Modifier and Type	Field and Description
private static final PropertyPlaceholderHelper	nonStrictHelper
public static final String	PLACEHOLDER_PREFIX Prefix for system property placeholders: ${.
public static final String	PLACEHOLDER_SUFFIX Suffix for system property placeholders: }.
private static final PropertyPlaceholderHelper	strictHelper
public static final String	VALUE_SEPARATOR Value separator for system property placeholders: :.

Access	Constructor and Description
public	SystemPropertyUtils()

Method Summary

Modifier and Type	Method and Description
public static String	Returns: the resolved String resolvePlaceholders(String the String to resolve text) Resolve `${...}` placeholders in the given text, replacing them with corresponding system property values.
public static String	Returns: the resolved String resolvePlaceholders(String the String to resolve text, boolean whether unresolved placeholders are to be ignored ignoreUnresolvablePlaceholders) Resolve `${...}` placeholders in the given text, replacing them with corresponding system property values.

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

Field Detail

nonStrictHelper	back to summary
private static final PropertyPlaceholderHelper nonStrictHelper

PLACEHOLDER_PREFIX	back to summary
public static final String PLACEHOLDER_PREFIX Prefix for system property placeholders: ${.

PLACEHOLDER_SUFFIX	back to summary
public static final String PLACEHOLDER_SUFFIX Suffix for system property placeholders: }.

strictHelper	back to summary
private static final PropertyPlaceholderHelper strictHelper

VALUE_SEPARATOR	back to summary
public static final String VALUE_SEPARATOR Value separator for system property placeholders: :.

SystemPropertyUtils	back to summary
public SystemPropertyUtils()

Method Detail

resolvePlaceholders back to summary

resolvePlaceholders	back to summary
public static String resolvePlaceholders(String text) Resolve `${...}` placeholders in the given text, replacing them with corresponding system property values. Parameters text:String the String to resolve Returns:String the resolved String Exceptions IllegalArgumentException: if there is an unresolvable placeholder See Also `PLACEHOLDER_PREFIX`, `PLACEHOLDER_SUFFIX`

public static String resolvePlaceholders(String text)

Resolve ${...} placeholders in the given text, replacing them with corresponding system property values.

Parameters

text:String: the String to resolve

Returns:String

the resolved String

Exceptions

IllegalArgumentException:: if there is an unresolvable placeholder

resolvePlaceholders back to summary

resolvePlaceholders	back to summary
public static String resolvePlaceholders(String text, boolean ignoreUnresolvablePlaceholders) Resolve `${...}` placeholders in the given text, replacing them with corresponding system property values. Unresolvable placeholders with no default value are ignored and passed through unchanged if the flag is set to `true`. Parameters text:String the String to resolve ignoreUnresolvablePlaceholders:boolean whether unresolved placeholders are to be ignored Returns:String the resolved String Exceptions IllegalArgumentException: if there is an unresolvable placeholder See Also `PLACEHOLDER_PREFIX`, `and the "ignoreUnresolvablePlaceholders" flag is false`

public static String resolvePlaceholders(String text, boolean ignoreUnresolvablePlaceholders)

Resolve ${...} placeholders in the given text, replacing them with corresponding system property values. Unresolvable placeholders with no default value are ignored and passed through unchanged if the flag is set to true.

Parameters

text:String: the String to resolve
ignoreUnresolvablePlaceholders:boolean: whether unresolved placeholders are to be ignored

Returns:String

the resolved String

Exceptions

IllegalArgumentException:: if there is an unresolvable placeholder

org.springframework.util back to summary

private Class SystemPropertyUtils.SystemPropertyPlaceholderResolver

Class Inheritance

extends Object
implements PlaceholderResolver

java.lang.Object
org.springframework.util.SystemPropertyUtils.SystemPropertyPlaceholderResolver

All Implemented Interfaces

org.springframework.util.PropertyPlaceholderHelper.PlaceholderResolver

PlaceholderResolver implementation that resolves against system properties and system environment variables.

Field Summary

Modifier and Type	Field and Description
private final String	text

Constructor Summary

Access	Constructor and Description
public	SystemPropertyPlaceholderResolver(String text)

Method Summary

Modifier and Type	Method and Description
public String	resolvePlaceholder(String the name of the placeholder to resolve placeholderName) Implements org.springframework.util.PropertyPlaceholderHelper.PlaceholderResolver.resolvePlaceholder. Resolve the supplied placeholder name to the replacement value.

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

Field Detail

text	back to summary
private final String text

Constructor Detail

SystemPropertyPlaceholderResolver	back to summary
public SystemPropertyPlaceholderResolver(String text)

Method Detail

resolvePlaceholder back to summary

resolvePlaceholder	back to summary
public String resolvePlaceholder(String placeholderName) Implements org.springframework.util.PropertyPlaceholderHelper.PlaceholderResolver.resolvePlaceholder. Doc from org.springframework.util.PropertyPlaceholderHelper.PlaceholderResolver.resolvePlaceholder. 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 @Override @Nullable

public String resolvePlaceholder(String placeholderName)

Implements org.springframework.util.PropertyPlaceholderHelper.PlaceholderResolver.resolvePlaceholder.

Doc from org.springframework.util.PropertyPlaceholderHelper.PlaceholderResolver.resolvePlaceholder.

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

@Override
@Nullable

public abstract Class SystemPropertyUtils

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class SystemPropertyUtils.SystemPropertyPlaceholderResolver

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail