cn.sliew.milky.common.environment

类 AbstractPropertyResolver

java.lang.Object

cn.sliew.milky.common.environment.AbstractPropertyResolver

所有已实现的接口:

PropertyResolver

直接已知子类:

PropertySourcesPropertyResolver

public abstract class AbstractPropertyResolver
extends Object
implements PropertyResolver

字段概要

字段

限定符和类型	字段和说明
protected Logger	log

构造器概要

构造器

构造器和说明
AbstractPropertyResolver()

方法概要

限定符和类型	方法和说明
boolean	containsProperty(String key) Whether the given property key is available.
<R,T> T	getProperty(String key, Function<R,T> mappingFunction, T defaultValue) Find the property value associated with the given key.
String	getProperty(String key, String defaultValue) Find the property value associated with the given key.
protected abstract Optional<String>	getPropertyAsRawString(String key) Retrieve the specified property as a raw String, i.e. without resolution of nested placeholders.
String	getRequiredProperty(String key) Find the property value associated with the given key (never null).
<R,T> T	getRequiredProperty(String key, Function<R,T> mappingFunction) Find the property value associated with the given key (never null).
protected String	resolveNestedPlaceholders(String value) Resolve placeholders within the given string.
String	resolvePlaceholders(String text) Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by PropertyResolver.getProperty(java.lang.String).
String	resolveRequiredPlaceholders(String text) Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by PropertyResolver.getProperty(java.lang.String).
void	setPlaceholderPrefix(String placeholderPrefix) Set the prefix that placeholders replaced by this resolver must begin with.
void	setPlaceholderSuffix(String placeholderSuffix) Set the suffix that placeholders replaced by this resolver must end with.
void	setValueSeparator(String valueSeparator) Specify the separating character between the placeholders replaced by this resolver and their associated default value, or null if no such special character should be processed as a value separator.

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

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

从接口继承的方法 cn.sliew.milky.common.environment.PropertyResolver

getProperty, getProperty

字段详细资料

log

protected final Logger log

构造器详细资料

AbstractPropertyResolver

public AbstractPropertyResolver()

方法详细资料

containsProperty

public boolean containsProperty(String key)

从接口复制的说明: PropertyResolver

Whether the given property key is available.

指定者:

containsProperty 在接口中 PropertyResolver

返回:

true if the given property key is available for resolution otherwise false.

getProperty

public String getProperty(String key,
                          String defaultValue)

从接口复制的说明: PropertyResolver

Find the property value associated with the given key. If the associated property value not found, defaultValue will be returned.

指定者:

getProperty 在接口中 PropertyResolver

参数:

key - the property name to resolve

defaultValue - the default value to return if no value is found

返回:

property value

另请参阅:

PropertyResolver.getRequiredProperty(String), PropertyResolver.getProperty(String, Function)

getProperty

public <R,T> T getProperty(String key,
                           Function<R,T> mappingFunction,
                           T defaultValue)

从接口复制的说明: PropertyResolver

Find the property value associated with the given key. If the associated property value not found, defaultValue will be returned.

指定者:

getProperty 在接口中 PropertyResolver

参数:

key - the property name to resolve

mappingFunction - the mapping function convert original object to target objet

defaultValue - the default value to return if no value is found

返回:

property value

另请参阅:

PropertyResolver.getRequiredProperty(String, Function)

getRequiredProperty

public String getRequiredProperty(String key)
                           throws IllegalStateException

从接口复制的说明: PropertyResolver

Find the property value associated with the given key (never null).

指定者:

getRequiredProperty 在接口中 PropertyResolver

参数:

key - the property name to resolve

返回:

property value

抛出:

IllegalStateException - if the key cannot be resolved

另请参阅:

PropertyResolver.getRequiredProperty(String, Function)

getRequiredProperty

public <R,T> T getRequiredProperty(String key,
                                   Function<R,T> mappingFunction)
                            throws IllegalStateException

从接口复制的说明: PropertyResolver

Find the property value associated with the given key (never null).

指定者:

getRequiredProperty 在接口中 PropertyResolver

参数:

key - the property name to resolve

mappingFunction - the mapping function convert original object to target objet

返回:

property value

抛出:

IllegalStateException - if the given key cannot be resolved

resolvePlaceholders

public String resolvePlaceholders(String text)

从接口复制的说明: PropertyResolver

Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by PropertyResolver.getProperty(java.lang.String). Unresolvable placeholders with no default value are ignored and passed through unchanged.

指定者:

resolvePlaceholders 在接口中 PropertyResolver

参数:

text - the String to resolve

返回:

the resolved String (never null)

另请参阅:

PropertyResolver.resolveRequiredPlaceholders(java.lang.String)

resolveRequiredPlaceholders

public String resolveRequiredPlaceholders(String text)
                                   throws IllegalArgumentException

从接口复制的说明: PropertyResolver

Resolve ${...} placeholders in the given text, replacing them with corresponding property values as resolved by PropertyResolver.getProperty(java.lang.String). Unresolvable placeholders with no default value will cause an IllegalArgumentException to be thrown.

指定者:

resolveRequiredPlaceholders 在接口中 PropertyResolver

返回:

the resolved String (never null)

抛出:

IllegalArgumentException - if given text is null or if any placeholders are unresolvable

resolveNestedPlaceholders

protected String resolveNestedPlaceholders(String value)

Resolve placeholders within the given string.

setPlaceholderPrefix

public void setPlaceholderPrefix(String placeholderPrefix)

从接口复制的说明: PropertyResolver

Set the prefix that placeholders replaced by this resolver must begin with.

指定者:

setPlaceholderPrefix 在接口中 PropertyResolver

setPlaceholderSuffix

public void setPlaceholderSuffix(String placeholderSuffix)

从接口复制的说明: PropertyResolver

Set the suffix that placeholders replaced by this resolver must end with.

指定者:

setPlaceholderSuffix 在接口中 PropertyResolver

setValueSeparator

public void setValueSeparator(String valueSeparator)

从接口复制的说明: PropertyResolver

Specify the separating character between the placeholders replaced by this resolver and their associated default value, or null if no such special character should be processed as a value separator.

指定者:

setValueSeparator 在接口中 PropertyResolver

getPropertyAsRawString

protected abstract Optional<String> getPropertyAsRawString(String key)

Retrieve the specified property as a raw String, i.e. without resolution of nested placeholders.

参数:

key - the property name to resolve

返回:

the property value or Optional.empty() if none found