io.micronaut.context.env

Class PropertySourcePropertyResolver

java.lang.Object

io.micronaut.context.env.PropertySourcePropertyResolver

All Implemented Interfaces:

PropertyResolver, ValueResolver<String>, AutoCloseable

Direct Known Subclasses:

DefaultEnvironment

public class PropertySourcePropertyResolver
extends Object
implements PropertyResolver, AutoCloseable

A PropertyResolver that resolves from one or many PropertySource instances.

Since:

1.0

Author:

Graeme Rocher

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PropertySourcePropertyResolver.PropertyCatalog The property catalog to use.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>[]	catalog
protected ConversionService<?>	conversionService
protected org.slf4j.Logger	log
protected Map<String,Object>[]	nonGenerated
protected PropertyPlaceholderResolver	propertyPlaceholderResolver
protected Map<String,PropertySource>	propertySources
protected Map<String,Object>[]	rawCatalog

Constructor Summary

Constructors

Constructor and Description
PropertySourcePropertyResolver() Creates a new, initially empty, PropertySourcePropertyResolver.
PropertySourcePropertyResolver(ConversionService<?> conversionService) Creates a new, initially empty, PropertySourcePropertyResolver for the given ConversionService.
PropertySourcePropertyResolver(ConversionService<?> conversionService, boolean logEnabled) Creates a new, initially empty, PropertySourcePropertyResolver for the given ConversionService.
PropertySourcePropertyResolver(PropertySource... propertySources) Creates a new PropertySourcePropertyResolver for the given PropertySource instances.

Method Summary

Modifier and Type	Method and Description
PropertySourcePropertyResolver	addPropertySource(PropertySource propertySource) Add a PropertySource to this resolver.
PropertySourcePropertyResolver	addPropertySource(String name, Map<String,? super Object> values) Add a property source for the given map.
void	close()
boolean	containsProperties(String name) Whether the given property or any nested properties exist for the key given key within this resolver.
boolean	containsProperty(String name) Whether the given property is contained within this resolver.
Map<String,Object>	getAllProperties(StringConvention keyConvention, MapFormat.MapTransformation transformation) Returns a combined Map of all properties in the catalog.
Map<String,Object>	getProperties(String name, StringConvention keyFormat) Return all the properties under the given key.
<T> Optional<T>	getProperty(String name, ArgumentConversionContext<T> conversionContext) Resolve the given property for the given name, type and generic type arguments.
Collection<String>	getPropertyEntries(String name) Returns a collection of properties entries under the given key.
boolean	isLogEnabled() Deprecated. don't need to have this method
protected void	processPropertySource(PropertySource properties, PropertySource.PropertyConvention convention)
protected void	resetCaches() Subclasses can override to reset caches.
protected Map<String,Object>	resolveEntriesForKey(String name, boolean allowCreate)
protected Map<String,Object>	resolveEntriesForKey(String name, boolean allowCreate, PropertySourcePropertyResolver.PropertyCatalog propertyCatalog)
protected Map<String,Object>	resolveSubMap(String name, Map<String,Object> entries, ArgumentConversionContext<?> conversionContext)
protected Map<String,Object>	resolveSubMap(String name, Map<String,Object> entries, ArgumentConversionContext<?> conversionContext, StringConvention keyConvention, MapFormat.MapTransformation transformation) Resolves a submap for the given name and parameters.
protected Properties	resolveSubProperties(String name, Map<String,Object> entries, ArgumentConversionContext<?> conversionContext)
void	setLogEnabled(boolean logEnabled) Deprecated. set logEnabled value by constructor

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.value.PropertyResolver

get, getProperties, getProperty, getProperty, getProperty, getProperty, getRequiredProperty, nameOf

Methods inherited from interface io.micronaut.core.value.ValueResolver

get, get, get

Field Detail

conversionService

protected final ConversionService<?> conversionService

propertyPlaceholderResolver

protected final PropertyPlaceholderResolver propertyPlaceholderResolver

propertySources

protected final Map<String,PropertySource> propertySources

catalog

protected final Map<String,Object>[] catalog

rawCatalog

protected final Map<String,Object>[] rawCatalog

nonGenerated

protected final Map<String,Object>[] nonGenerated

log

protected org.slf4j.Logger log

Constructor Detail

PropertySourcePropertyResolver

public PropertySourcePropertyResolver(ConversionService<?> conversionService,
                                      boolean logEnabled)

Creates a new, initially empty, PropertySourcePropertyResolver for the given ConversionService.

Parameters:

conversionService - The ConversionService

logEnabled - logEnabled flag to enable or disable logger

PropertySourcePropertyResolver

public PropertySourcePropertyResolver(ConversionService<?> conversionService)

Creates a new, initially empty, PropertySourcePropertyResolver for the given ConversionService.

Parameters:

conversionService - The ConversionService

PropertySourcePropertyResolver

public PropertySourcePropertyResolver()

Creates a new, initially empty, PropertySourcePropertyResolver.

PropertySourcePropertyResolver

public PropertySourcePropertyResolver(PropertySource... propertySources)

Creates a new PropertySourcePropertyResolver for the given PropertySource instances.

Parameters:

propertySources - The PropertySource instances

Method Detail

addPropertySource

public PropertySourcePropertyResolver addPropertySource(@Nullable
                                                        PropertySource propertySource)

Add a PropertySource to this resolver.

Parameters:

propertySource - The PropertySource to add

Returns:

This PropertySourcePropertyResolver

addPropertySource

public PropertySourcePropertyResolver addPropertySource(String name,
                                                        @Nullable
                                                        Map<String,? super Object> values)

Add a property source for the given map.

Parameters:

name - The name of the property source

values - The values

Returns:

This environment

containsProperty

public boolean containsProperty(@Nullable
                                String name)

Description copied from interface: PropertyResolver

Whether the given property is contained within this resolver.

Note that this method will return false for nested properties. In other words given a key of foo.bar this method will return false for: resolver.containsProperty("foo")

To check for nested properties using PropertyResolver.containsProperties(String) instead.

Specified by:

containsProperty in interface PropertyResolver

Parameters:

name - The name of the property

Returns:

True if it is

containsProperties

public boolean containsProperties(@Nullable
                                  String name)

Description copied from interface: PropertyResolver

Whether the given property or any nested properties exist for the key given key within this resolver.

Specified by:

containsProperties in interface PropertyResolver

Parameters:

name - The name of the property

Returns:

True if it is

getPropertyEntries

@NonNull
public Collection<String> getPropertyEntries(@NonNull
                                                      String name)

Description copied from interface: PropertyResolver

Returns a collection of properties entries under the given key. For example given the following keys:

 datasource.default.url=localhost
 datasource.another.url=someother
 

Calling getPropertyEntries(String) with a value of datasource will result in a collection containing default and other.

Specified by:

getPropertyEntries in interface PropertyResolver

Parameters:

name - The name to resolve

Returns:

The property entries.

getProperties

@NonNull
public Map<String,Object> getProperties(String name,
                                                 StringConvention keyFormat)

Description copied from interface: PropertyResolver

Return all the properties under the given key. By default Micronaut stores keys in keb-case, such that normalized lookups are more efficient. You can obtain the raw key values by passing in StringConvention.RAW.

Specified by:

getProperties in interface PropertyResolver

Parameters:

name - The name

keyFormat - The key format to use for the keys. Default is kebab-case.

Returns:

The properties

getProperty

public <T> Optional<T> getProperty(@NonNull
                                   String name,
                                   @NonNull
                                   ArgumentConversionContext<T> conversionContext)

Description copied from interface: PropertyResolver

Resolve the given property for the given name, type and generic type arguments.

Implementers can choose to implement more intelligent type conversion by analyzing the typeArgument.

Specified by:

getProperty in interface PropertyResolver

Type Parameters:

T - The concrete type

Parameters:

name - The name

conversionContext - The conversion context

Returns:

An optional containing the property value if it exists

getAllProperties

public Map<String,Object> getAllProperties(StringConvention keyConvention,
                                           MapFormat.MapTransformation transformation)

Returns a combined Map of all properties in the catalog.

Parameters:

keyConvention - The map key convention

transformation - The map format

Returns:

Map of all properties

resolveSubProperties

protected Properties resolveSubProperties(String name,
                                          Map<String,Object> entries,
                                          ArgumentConversionContext<?> conversionContext)

Parameters:

name - The property name

entries - The entries

conversionContext - The conversion context

Returns:

The subproperties

resolveSubMap

protected Map<String,Object> resolveSubMap(String name,
                                           Map<String,Object> entries,
                                           ArgumentConversionContext<?> conversionContext)

Parameters:

name - The property name

entries - The entries

conversionContext - The conversion context

Returns:

The submap

resolveSubMap

@NonNull
protected Map<String,Object> resolveSubMap(String name,
                                                    Map<String,Object> entries,
                                                    ArgumentConversionContext<?> conversionContext,
                                                    @Nullable
                                                    StringConvention keyConvention,
                                                    MapFormat.MapTransformation transformation)

Resolves a submap for the given name and parameters.

Parameters:

name - The name

entries - The entries

conversionContext - The conversion context

keyConvention - The key convention to use

transformation - The map transformation to apply

Returns:

The resulting map

processPropertySource

protected void processPropertySource(PropertySource properties,
                                     PropertySource.PropertyConvention convention)

Parameters:

properties - The property source

convention - The property convention

resolveEntriesForKey

protected Map<String,Object> resolveEntriesForKey(String name,
                                                  boolean allowCreate)

Parameters:

name - The name

allowCreate - Whether allows creation

Returns:

The map with the resolved entries for the name

resolveEntriesForKey

protected Map<String,Object> resolveEntriesForKey(String name,
                                                  boolean allowCreate,
                                                  @Nullable
                                                  PropertySourcePropertyResolver.PropertyCatalog propertyCatalog)

Parameters:

name - The name

allowCreate - Whether allows creation

propertyCatalog - The string convention

Returns:

The map with the resolved entries for the name

resetCaches

protected void resetCaches()

Subclasses can override to reset caches.

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

isLogEnabled

@Deprecated
public boolean isLogEnabled()

Deprecated. don't need to have this method

Return logEnabled value.

Returns:

is log enabled

Since:

3.9.0

setLogEnabled

@Deprecated
public void setLogEnabled(boolean logEnabled)

Deprecated. set logEnabled value by constructor

Setter for logEnabled.

Parameters:

logEnabled - is log enabled

Since:

3.9.0