com.jn.langx.text.placeholder

类 PropertyPlaceholderHandler

java.lang.Object

com.jn.langx.text.placeholder.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 PropertyPlaceholderHelper these placeholders can be substituted for user-supplied values.

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

构造器概要

构造器

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

方法概要

限定符和类型	方法和说明
protected String	parseStringValue(String template, PlaceholderParser placeholderResolver, Set<String> visitedPlaceholders)
String	replacePlaceholders(String template, PlaceholderParser placeholderResolver) Replaces all placeholders of format ${name} with the value returned from the supplied PlaceholderParser.
String	replacePlaceholders(String template, Properties properties) Replaces all placeholders of format ${name} with the corresponding property from the supplied Properties.

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

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

构造器详细资料

PropertyPlaceholderHandler

public PropertyPlaceholderHandler(String placeholderPrefix,
                                  String placeholderSuffix)

Creates a new PropertyPlaceholderHelper 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,
                                  boolean ignoreUnresolvablePlaceholders)

Creates 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

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

方法详细资料

replacePlaceholders

public String replacePlaceholders(String template,
                                  Properties properties)

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

参数:

template - 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 template,
                                  PlaceholderParser placeholderResolver)

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

参数:

template - 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 template,
                                  PlaceholderParser placeholderResolver,
                                  @Nullable
                                  Set<String> visitedPlaceholders)