Package io.microsphere.spring.util

Class PropertySourcesUtils

java.lang.Object

io.microsphere.spring.util.PropertySourcesUtils

public abstract class PropertySourcesUtils
extends java.lang.Object

PropertySources Utilities

Since:

1.0.0

Author:

Mercy

See Also:

PropertySources

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	BOOTSTRAP_PROPERTY_SOURCE_NAME	The PropertySource name of Spring Cloud Bootstrap context
static java.lang.String	DEFAULT_PROPERTIES_PROPERTY_SOURCE_NAME	The PropertySource name of Spring Boot default poperties

Constructor Summary

Constructors

Constructor	Description
PropertySourcesUtils()

Method Summary

Modifier and Type	Method	Description
static void	addDefaultProperties(org.springframework.core.env.ConfigurableEnvironment environment, java.lang.String key, java.lang.Object value, java.lang.Object... others)
static boolean	containsBootstrapPropertySource(org.springframework.core.env.ConfigurableEnvironment environment)	Contains the Bootstrap PropertySource or not
static boolean	containsPropertySource(org.springframework.core.env.ConfigurableEnvironment environment, java.lang.String propertySourceName)	Contains the specified PropertySource or not
static org.springframework.core.env.PropertySource	findConfiguredPropertySource(java.lang.Iterable<org.springframework.core.env.PropertySource<?>> propertySources, java.lang.String propertyName)
static org.springframework.core.env.PropertySource	findConfiguredPropertySource(org.springframework.core.env.ConfigurableEnvironment environment, java.lang.String propertyName)
static java.lang.String	findConfiguredPropertySourceName(java.lang.Iterable<org.springframework.core.env.PropertySource<?>> propertySources, java.lang.String propertyName)
static java.lang.String	findConfiguredPropertySourceName(org.springframework.core.env.ConfigurableEnvironment environment, java.lang.String propertyName)
static java.util.Set<java.lang.String>	findPropertyNames(org.springframework.core.env.ConfigurableEnvironment environment, java.util.function.Predicate<java.lang.String> propertyNameFilter)
static java.util.Set<java.lang.String>	findPropertyNamesByPrefix(org.springframework.core.env.ConfigurableEnvironment environment, java.lang.String propertyNamePrefix)
static java.util.Map<java.lang.String,java.lang.Object>	getDefaultProperties(org.springframework.core.env.ConfigurableEnvironment environment)	Get the Map properties from the "default" PropertySource that is the lowest order one of the Spring PropertySources is created if absent
static java.util.Map<java.lang.String,java.lang.Object>	getDefaultProperties(org.springframework.core.env.ConfigurableEnvironment environment, boolean createIfAbsent)	Get the Map properties from the "default" PropertySource that is the lowest order one of the Spring PropertySources is created if specified.
static org.springframework.core.env.MapPropertySource	getDefaultPropertiesPropertySource(org.springframework.core.env.ConfigurableEnvironment environment)	Get the "default" PropertySource that is the lowest order one of the Spring PropertySources is created if absent
static org.springframework.core.env.MapPropertySource	getDefaultPropertiesPropertySource(org.springframework.core.env.ConfigurableEnvironment environment, boolean createIfAbsent)	Get the "default" PropertySource that is the lowest order one of the Spring PropertySources is created if specified
static org.springframework.core.env.MapPropertySource	getMapPropertySource(org.springframework.core.env.ConfigurableEnvironment environment, java.lang.String propertySourceName)
static org.springframework.core.env.MapPropertySource	getMapPropertySource(org.springframework.core.env.ConfigurableEnvironment environment, java.lang.String propertySourceName, boolean created)
static java.util.Map<java.lang.String,java.lang.Object>	getProperties(org.springframework.core.env.PropertySource propertySource)	Get the Map as the properties from the specified PropertySource
static java.lang.String[]	getPropertyNames(org.springframework.core.env.PropertySource propertySource)	Get the property names as the array from the specified PropertySource instance.
static <T extends org.springframework.core.env.PropertySource<?>> T	getPropertySource(org.springframework.core.env.ConfigurableEnvironment environment, java.lang.String propertySourceName, java.lang.Class<T> propertySourceType)
static <T extends org.springframework.core.env.PropertySource<?>> T	getPropertySource(org.springframework.core.env.ConfigurableEnvironment environment, java.lang.String propertySourceName, java.lang.Class<T> propertySourceType, java.util.function.Supplier<T> propertySourceSupplierIfAbsent)
static java.util.Map<java.lang.String,java.lang.Object>	getSubProperties(java.lang.Iterable<org.springframework.core.env.PropertySource<?>> propertySources, java.lang.String prefix)	Get Sub Properties
static java.util.Map<java.lang.String,java.lang.Object>	getSubProperties(org.springframework.core.env.ConfigurableEnvironment environment, java.lang.String prefix)	Get Sub Properties
static java.util.Map<java.lang.String,java.lang.Object>	getSubProperties(org.springframework.core.env.PropertySources propertySources, java.lang.String prefix)	Get prefixed Properties
static java.util.Map<java.lang.String,java.lang.Object>	getSubProperties(org.springframework.core.env.PropertySources propertySources, org.springframework.core.env.PropertyResolver propertyResolver, java.lang.String prefix)	Get prefixed Properties
static java.lang.String	normalizePrefix(java.lang.String prefix)	Normalize the prefix

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PROPERTIES_PROPERTY_SOURCE_NAME

public static final java.lang.String DEFAULT_PROPERTIES_PROPERTY_SOURCE_NAME

The PropertySource name of Spring Boot default poperties

See Also:

org.springframework.boot.DefaultPropertiesPropertySource#addOrMerge(Map, MutablePropertySources), org.springframework.boot.DefaultPropertiesPropertySource#NAME, Constant Field Values

BOOTSTRAP_PROPERTY_SOURCE_NAME

public static final java.lang.String BOOTSTRAP_PROPERTY_SOURCE_NAME

The PropertySource name of Spring Cloud Bootstrap context

See Also:

org.springframework.cloud.bootstrap.BootstrapApplicationListener#BOOTSTRAP_PROPERTY_SOURCE_NAME, Constant Field Values

Constructor Detail

PropertySourcesUtils

public PropertySourcesUtils()

Method Detail

getPropertySource

public static <T extends org.springframework.core.env.PropertySource<?>> T getPropertySource(org.springframework.core.env.ConfigurableEnvironment environment,
                                                                                             java.lang.String propertySourceName,
                                                                                             java.lang.Class<T> propertySourceType)

getPropertySource

public static <T extends org.springframework.core.env.PropertySource<?>> T getPropertySource(org.springframework.core.env.ConfigurableEnvironment environment,
                                                                                             java.lang.String propertySourceName,
                                                                                             java.lang.Class<T> propertySourceType,
                                                                                             java.util.function.Supplier<T> propertySourceSupplierIfAbsent)

getMapPropertySource

public static org.springframework.core.env.MapPropertySource getMapPropertySource(org.springframework.core.env.ConfigurableEnvironment environment,
                                                                                  java.lang.String propertySourceName)

getMapPropertySource

public static org.springframework.core.env.MapPropertySource getMapPropertySource(org.springframework.core.env.ConfigurableEnvironment environment,
                                                                                  java.lang.String propertySourceName,
                                                                                  boolean created)

findConfiguredPropertySource

public static org.springframework.core.env.PropertySource findConfiguredPropertySource(org.springframework.core.env.ConfigurableEnvironment environment,
                                                                                       java.lang.String propertyName)

findConfiguredPropertySource

public static org.springframework.core.env.PropertySource findConfiguredPropertySource(java.lang.Iterable<org.springframework.core.env.PropertySource<?>> propertySources,
                                                                                       java.lang.String propertyName)

findConfiguredPropertySourceName

public static java.lang.String findConfiguredPropertySourceName(org.springframework.core.env.ConfigurableEnvironment environment,
                                                                java.lang.String propertyName)

findConfiguredPropertySourceName

public static java.lang.String findConfiguredPropertySourceName(java.lang.Iterable<org.springframework.core.env.PropertySource<?>> propertySources,
                                                                java.lang.String propertyName)

findPropertyNamesByPrefix

public static java.util.Set<java.lang.String> findPropertyNamesByPrefix(org.springframework.core.env.ConfigurableEnvironment environment,
                                                                        java.lang.String propertyNamePrefix)

findPropertyNames

public static java.util.Set<java.lang.String> findPropertyNames(org.springframework.core.env.ConfigurableEnvironment environment,
                                                                java.util.function.Predicate<java.lang.String> propertyNameFilter)

getSubProperties

public static java.util.Map<java.lang.String,java.lang.Object> getSubProperties(java.lang.Iterable<org.springframework.core.env.PropertySource<?>> propertySources,
                                                                                      java.lang.String prefix)

Get Sub Properties

Parameters:

propertySources - PropertySource Iterable

prefix - the prefix of property name

Returns:

Map

See Also:

Properties

getSubProperties

public static java.util.Map<java.lang.String,java.lang.Object> getSubProperties(org.springframework.core.env.ConfigurableEnvironment environment,
                                                                                      java.lang.String prefix)

Get Sub Properties

Parameters:

environment - ConfigurableEnvironment

prefix - the prefix of property name

Returns:

Map

See Also:

Properties

normalizePrefix

public static java.lang.String normalizePrefix(java.lang.String prefix)

Normalize the prefix

Parameters:

prefix - the prefix

Returns:

the prefix

getSubProperties

public static java.util.Map<java.lang.String,java.lang.Object> getSubProperties(org.springframework.core.env.PropertySources propertySources,
                                                                                      java.lang.String prefix)

Get prefixed Properties

Parameters:

propertySources - PropertySources

prefix - the prefix of property name

Returns:

Map

Since:

1.0.0

See Also:

Properties

getSubProperties

public static java.util.Map<java.lang.String,java.lang.Object> getSubProperties(org.springframework.core.env.PropertySources propertySources,
                                                                                      org.springframework.core.env.PropertyResolver propertyResolver,
                                                                                      java.lang.String prefix)

Get prefixed Properties

Parameters:

propertySources - PropertySources

propertyResolver - PropertyResolver to resolve the placeholder if present

prefix - the prefix of property name

Returns:

Map

Since:

1.0.0

See Also:

Properties

getPropertyNames

@NonNull
public static java.lang.String[] getPropertyNames(org.springframework.core.env.PropertySource propertySource)

Get the property names as the array from the specified PropertySource instance.

Parameters:

propertySource - PropertySource instance

Returns:

non-null

Since:

1.0.0

getProperties

@NonNull
public static java.util.Map<java.lang.String,java.lang.Object> getProperties(org.springframework.core.env.PropertySource propertySource)

Get the Map as the properties from the specified PropertySource

Parameters:

propertySource - the specified PropertySource

Returns:

non-null read-only Map

addDefaultProperties

public static void addDefaultProperties(org.springframework.core.env.ConfigurableEnvironment environment,
                                        java.lang.String key,
                                        java.lang.Object value,
                                        java.lang.Object... others)

getDefaultProperties

public static java.util.Map<java.lang.String,java.lang.Object> getDefaultProperties(org.springframework.core.env.ConfigurableEnvironment environment)

Get the Map properties from the "default" PropertySource that is the lowest order one of the Spring PropertySources is created if absent

Parameters:

environment - ConfigurableEnvironment

Returns:

non-null mutable Map

See Also:

DEFAULT_PROPERTIES_PROPERTY_SOURCE_NAME, getDefaultProperties(ConfigurableEnvironment, boolean)

getDefaultProperties

public static java.util.Map<java.lang.String,java.lang.Object> getDefaultProperties(org.springframework.core.env.ConfigurableEnvironment environment,
                                                                                          boolean createIfAbsent)

Get the Map properties from the "default" PropertySource that is the lowest order one of the Spring PropertySources is created if specified.

Parameters:

environment - ConfigurableEnvironment

createIfAbsent - true indicates the "default" PropertySource will be created if absent

Returns:

non-null mutable Map

See Also:

DEFAULT_PROPERTIES_PROPERTY_SOURCE_NAME, getDefaultProperties(ConfigurableEnvironment, boolean)

getDefaultPropertiesPropertySource

public static org.springframework.core.env.MapPropertySource getDefaultPropertiesPropertySource(org.springframework.core.env.ConfigurableEnvironment environment)

Get the "default" PropertySource that is the lowest order one of the Spring PropertySources is created if absent

Parameters:

environment - ConfigurableEnvironment

Returns:

non-null MapPropertySource

getDefaultPropertiesPropertySource

public static org.springframework.core.env.MapPropertySource getDefaultPropertiesPropertySource(org.springframework.core.env.ConfigurableEnvironment environment,
                                                                                                boolean createIfAbsent)

Get the "default" PropertySource that is the lowest order one of the Spring PropertySources is created if specified

Parameters:

environment - ConfigurableEnvironment

createIfAbsent - true indicates the "default" PropertySource will be created if absent

Returns:

non-null MapPropertySource

containsPropertySource

public static boolean containsPropertySource(org.springframework.core.env.ConfigurableEnvironment environment,
                                             java.lang.String propertySourceName)

Contains the specified PropertySource or not

Parameters:

environment - ConfigurableEnvironment

propertySourceName - the PropertySource name

Returns:

if contains, return true, otherwise false

containsBootstrapPropertySource

public static boolean containsBootstrapPropertySource(org.springframework.core.env.ConfigurableEnvironment environment)

Contains the Bootstrap PropertySource or not

Parameters:

environment - ConfigurableEnvironment

Returns:

if contains, return true, otherwise false