Package io.micronaut.context.env

Class DefaultPropertyPlaceholderResolver

java.lang.Object

io.micronaut.context.env.DefaultPropertyPlaceholderResolver

All Implemented Interfaces:

PropertyPlaceholderResolver, AutoCloseable

public class DefaultPropertyPlaceholderResolver
extends Object
implements PropertyPlaceholderResolver, AutoCloseable

The default PropertyPlaceholderResolver.

Since:

1.0

Author:

graemerocher

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DefaultPropertyPlaceholderResolver.PlaceholderSegment	A segment that represents one or more expressions that should be searched for in the environment.
class	DefaultPropertyPlaceholderResolver.RawSegment	A segment that represents static text.
static interface	DefaultPropertyPlaceholderResolver.Segment	A segment of placeholder resolution.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX	Prefix for placeholder in properties.
static final String	SUFFIX	Suffix for placeholder in properties.

Constructor Summary

Constructors

Constructor	Description
DefaultPropertyPlaceholderResolver(PropertyResolver environment, ConversionService conversionService)

Method Summary

Modifier and Type	Method	Description
List<DefaultPropertyPlaceholderResolver.Segment>	buildSegments(String str)	Split a placeholder value into logic segments.
void	close()
String	getPrefix()
protected <T> T	resolveExpression(String context, String expression, Class<T> type)	Resolves a single expression.
<T> Optional<T>	resolveOptionalPlaceholder(String str, Class<T> type)	Resolves the optional value of a single placeholder.
Optional<String>	resolvePlaceholders(String str)	Resolve the placeholders and return an Optional String if it was possible to resolve them.
<T> T	resolveRequiredPlaceholder(String str, Class<T> type)	Resolves the value of a single placeholder.
String	resolveRequiredPlaceholders(String str)	Resolve the placeholders and return a string if it was possible to resolve them.
Object	resolveRequiredPlaceholdersObject(String str)	Resolve the placeholders in the given string.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

Prefix for placeholder in properties.

See Also:

• Constant Field Values

SUFFIX

public static final String SUFFIX

Suffix for placeholder in properties.

See Also:

• Constant Field Values

Constructor Details

DefaultPropertyPlaceholderResolver

public DefaultPropertyPlaceholderResolver(PropertyResolver environment,
 ConversionService conversionService)

Parameters:

environment - The property resolver for the environment

conversionService - The conversion service

Method Details

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface PropertyPlaceholderResolver

Returns:

The prefix used

resolvePlaceholders

public Optional<String> resolvePlaceholders(String str)

Description copied from interface: PropertyPlaceholderResolver

Resolve the placeholders and return an Optional String if it was possible to resolve them.

Specified by:

resolvePlaceholders in interface PropertyPlaceholderResolver

Parameters:

str - The placeholder to resolve

Returns:

The optional string or Optional.empty() if resolution was not possible

resolveRequiredPlaceholders

public String resolveRequiredPlaceholders(String str)
                                   throws ConfigurationException

Description copied from interface: PropertyPlaceholderResolver

Resolve the placeholders and return a string if it was possible to resolve them.

Specified by:

resolveRequiredPlaceholders in interface PropertyPlaceholderResolver

Parameters:

str - The placeholder to resolve

Returns:

The resolved string

Throws:

ConfigurationException - If the placeholders could not be resolved

resolveRequiredPlaceholdersObject

public Object resolveRequiredPlaceholdersObject(String str)
                                         throws ConfigurationException

Description copied from interface: PropertyPlaceholderResolver

Resolve the placeholders in the given string. This behaves like PropertyPlaceholderResolver.resolveRequiredPlaceholders(String), except that when the whole input is a placeholder, the value is not converted to String but returned as-is.

Specified by:

resolveRequiredPlaceholdersObject in interface PropertyPlaceholderResolver

Parameters:

str - The placeholder to resolve

Returns:

The resolved object or string

Throws:

ConfigurationException - If the placeholders could not be resolved

resolveRequiredPlaceholder

public <T> T resolveRequiredPlaceholder(String str,
 Class<T> type)
                                 throws ConfigurationException

Description copied from interface: PropertyPlaceholderResolver

Resolves the value of a single placeholder.

Specified by:

resolveRequiredPlaceholder in interface PropertyPlaceholderResolver

Type Parameters:

T - The type the value should be converted to

Parameters:

str - The string containing the placeholder

type - The class of the type

Returns:

The resolved value

Throws:

ConfigurationException - If multiple placeholders are found or if the placeholder could not be converted to the requested type

resolveOptionalPlaceholder

public <T> Optional<T> resolveOptionalPlaceholder(String str,
 Class<T> type)
                                           throws ConfigurationException

Description copied from interface: PropertyPlaceholderResolver

Resolves the optional value of a single placeholder.

Specified by:

resolveOptionalPlaceholder in interface PropertyPlaceholderResolver

Type Parameters:

T - The type the value should be converted to

Parameters:

str - The string containing the placeholder

type - The class of the type

Returns:

The resolved optional value

Throws:

ConfigurationException

buildSegments

public List<DefaultPropertyPlaceholderResolver.Segment> buildSegments(String str)

Split a placeholder value into logic segments.

Parameters:

str - The placeholder

Returns:

The list of segments

resolveExpression

@Nullable
protected <T> T resolveExpression(String context,
 String expression,
 Class<T> type)

Resolves a single expression.

Type Parameters:

T - The type the expression should be converted to

Parameters:

context - The context of the expression

expression - The expression

type - The class

Returns:

The resolved and converted expression

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception