程序包 org.springframework.boot.env

类 ConfigTreePropertySource

java.lang.Object

org.springframework.core.env.PropertySource<Path>

org.springframework.core.env.EnumerablePropertySource<Path>

org.springframework.boot.env.ConfigTreePropertySource

所有已实现的接口:

OriginLookup<String>

public class ConfigTreePropertySource
extends EnumerablePropertySource<Path>
implements OriginLookup<String>

PropertySource backed by a directory tree that contains files for each value. The PropertySource will recursively scan a given source directory and expose a property for each file found. The property name will be the filename, and the property value will be the contents of the file.

Directories are only scanned when the source is first created. The directory is not monitored for updates, so files should not be added or removed. However, the contents of a file can be updated as long as the property source was created with a ConfigTreePropertySource.Option.ALWAYS_READ option. Nested directories are included in the source, but with a '.' rather than '/' used as the path separator.

Property values are returned as ConfigTreePropertySource.Value instances which allows them to be treated either as an InputStreamSource or as a CharSequence. In addition, if used with an Environment configured with an ApplicationConversionService, property values can be converted to a String or byte[].

This property source is typically used to read Kubernetes configMap volume mounts.

从以下版本开始:

2.4.0

作者:

Phillip Webb

嵌套类概要

嵌套类

修饰符和类型	类	说明
static enum	ConfigTreePropertySource.Option	Property source options.
static interface	ConfigTreePropertySource.Value	A value returned from the property source which exposes the contents of the property file.

从类继承的嵌套类/接口 org.springframework.core.env.PropertySource

PropertySource.StubPropertySource

字段概要

从类继承的字段 org.springframework.core.env.PropertySource

logger, name, source

构造器概要

构造器

构造器	说明
ConfigTreePropertySource(String name, Path sourceDirectory)	Create a new ConfigTreePropertySource instance.
ConfigTreePropertySource(String name, Path sourceDirectory, ConfigTreePropertySource.Option... options)	Create a new ConfigTreePropertySource instance.

方法概要

修饰符和类型	方法	说明
Origin	getOrigin(String name)	Return the origin of the given key or null if the origin cannot be determined.
ConfigTreePropertySource.Value	getProperty(String name)
String[]	getPropertyNames()
boolean	isImmutable()	Return true if this lookup is immutable and has contents that will never change.

从类继承的方法 org.springframework.core.env.EnumerablePropertySource

containsProperty

从类继承的方法 org.springframework.core.env.PropertySource

equals, getName, getSource, hashCode, named, toString

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 org.springframework.boot.origin.OriginLookup

getPrefix

构造器详细资料

ConfigTreePropertySource

public ConfigTreePropertySource(String name,
 Path sourceDirectory)

Create a new ConfigTreePropertySource instance.

参数:

name - the name of the property source

sourceDirectory - the underlying source directory

ConfigTreePropertySource

public ConfigTreePropertySource(String name,
 Path sourceDirectory,
 ConfigTreePropertySource.Option... options)

Create a new ConfigTreePropertySource instance.

参数:

name - the name of the property source

sourceDirectory - the underlying source directory

options - the property source options

方法详细资料

getPropertyNames

public String[] getPropertyNames()

指定者:

getPropertyNames 在类中 EnumerablePropertySource<Path>

getProperty

public ConfigTreePropertySource.Value getProperty(String name)

指定者:

getProperty 在类中 PropertySource<Path>

getOrigin

public Origin getOrigin(String name)

从接口复制的说明: OriginLookup

Return the origin of the given key or null if the origin cannot be determined.

指定者:

getOrigin 在接口中 OriginLookup<String>

参数:

name - the key to lookup

返回:

the origin of the key or null

isImmutable

public boolean isImmutable()

从接口复制的说明: OriginLookup

Return true if this lookup is immutable and has contents that will never change.

指定者:

isImmutable 在接口中 OriginLookup<String>

返回:

if the lookup is immutable