程序包 cn.taketoday.util

类 PropertyPlaceholderHandler

java.lang.Object

cn.taketoday.util.PropertyPlaceholderHandler

public class PropertyPlaceholderHandler
extends Object

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

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

从以下版本开始:

4.0 2021/9/28 22:26

作者:

Juergen Hoeller, Rob Harrop, Harry Yang

字段概要

字段

修饰符和类型	字段	说明
static final char	ESCAPE_CHARACTER	Default escape character: '\'.
static final PropertyPlaceholderHandler	nonStrict
private final PlaceholderParser	parser
static final String	PLACEHOLDER_PREFIX	Prefix for property placeholders: "${".
static final String	PLACEHOLDER_SUFFIX	Suffix for property placeholders: "}".
static final PropertyPlaceholderHandler	strict
static final String	VALUE_SEPARATOR	Value separator for property placeholders: ":".

构造器概要

构造器

构造器	说明
PropertyPlaceholderHandler(String placeholderPrefix, String placeholderSuffix)	Creates a new PropertyPlaceholderHandler that uses the supplied prefix and suffix.
PropertyPlaceholderHandler(String placeholderPrefix, String placeholderSuffix, String valueSeparator, Character escapeCharacter, boolean ignoreUnresolvablePlaceholders)	Create a new PropertyPlaceholderHelper that uses the supplied prefix and suffix.

方法概要

修饰符和类型	方法	说明
protected String	parseStringValue(String value, PlaceholderResolver placeholderResolver)
String	replacePlaceholders(String value, PlaceholderResolver placeholderResolver)	Replaces all placeholders of format ${name} with the value returned from the supplied PlaceholderResolver.
String	replacePlaceholders(String value, Properties properties)	Replaces all placeholders of format ${name} with the corresponding property from the supplied Properties.
static PropertyPlaceholderHandler	shared(boolean ignoreUnresolvablePlaceholders)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

PLACEHOLDER_SUFFIX

public static final String PLACEHOLDER_SUFFIX

Suffix for property placeholders: "}".

另请参阅:

• 常量字段值

PLACEHOLDER_PREFIX

public static final String PLACEHOLDER_PREFIX

Prefix for property placeholders: "${".

另请参阅:

• 常量字段值

VALUE_SEPARATOR

public static final String VALUE_SEPARATOR

Value separator for property placeholders: ":".

另请参阅:

• 常量字段值

ESCAPE_CHARACTER

public static final char ESCAPE_CHARACTER

Default escape character: '\'.

另请参阅:

• 常量字段值

strict

public static final PropertyPlaceholderHandler strict

nonStrict

public static final PropertyPlaceholderHandler nonStrict

parser

private final PlaceholderParser parser

构造器详细资料

PropertyPlaceholderHandler

public PropertyPlaceholderHandler(String placeholderPrefix,
 String placeholderSuffix)

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

参数:

placeholderPrefix - the prefix that denotes the start of a placeholder

placeholderSuffix - the suffix that denotes the end of a placeholder

PropertyPlaceholderHandler

public PropertyPlaceholderHandler(String placeholderPrefix,
 String placeholderSuffix,
 @Nullable
 String valueSeparator,
 @Nullable
 Character escapeCharacter,
 boolean ignoreUnresolvablePlaceholders)

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

参数:

placeholderPrefix - the prefix that denotes the start of a placeholder

placeholderSuffix - the suffix that denotes the end of a placeholder

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

escapeCharacter - the escape character to use to ignore placeholder prefix or value separator, if any

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

方法详细资料

replacePlaceholders

public String replacePlaceholders(String value,
 Properties properties)

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

参数:

value - the value containing the placeholders to be replaced

properties - the Properties to use for replacement

返回:

the supplied value with placeholders replaced inline

replacePlaceholders

public String replacePlaceholders(String value,
 PlaceholderResolver placeholderResolver)

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

参数:

value - the value containing the placeholders to be replaced

placeholderResolver - the PlaceholderResolver to use for replacement

返回:

the supplied value with placeholders replaced inline

parseStringValue

protected String parseStringValue(String value,
 PlaceholderResolver placeholderResolver)

shared

public static PropertyPlaceholderHandler shared(boolean ignoreUnresolvablePlaceholders)