ConfigurationInterpolator.java
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.commons.configuration2.interpol;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Properties;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.function.Function;
import org.apache.commons.text.StringSubstitutor;
/**
* <p>
* A class that handles interpolation (variable substitution) for configuration objects.
* </p>
* <p>
* Each instance of {@code AbstractConfiguration} is associated with an object of this class. All interpolation tasks
* are delegated to this object.
* </p>
* <p>
* {@code ConfigurationInterpolator} internally uses the {@code StringSubstitutor} class from
* <a href="https://commons.apache.org/text">Commons Text</a>. Thus it supports the same syntax of variable expressions.
* </p>
* <p>
* The basic idea of this class is that it can maintain a set of primitive {@link Lookup} objects, each of which is
* identified by a special prefix. The variables to be processed have the form {@code ${prefix:name}}.
* {@code ConfigurationInterpolator} will extract the prefix and determine, which primitive lookup object is registered
* for it. Then the name of the variable is passed to this object to obtain the actual value. It is also possible to
* define an arbitrary number of default lookup objects, which are used for variables that do not have a prefix or that
* cannot be resolved by their associated lookup object. When adding default lookup objects their order matters; they
* are queried in this order, and the first non-<b>null</b> variable value is used.
* </p>
* <p>
* After an instance has been created it does not contain any {@code Lookup} objects. The current set of lookup objects
* can be modified using the {@code registerLookup()} and {@code deregisterLookup()} methods. Default lookup objects
* (that are invoked for variables without a prefix) can be added or removed with the {@code addDefaultLookup()} and
* {@code removeDefaultLookup()} methods respectively. (When a {@code ConfigurationInterpolator} instance is created by
* a configuration object, a default lookup object is added pointing to the configuration itself, so that variables are
* resolved using the configuration's properties.)
* </p>
* <p>
* The default usage scenario is that on a fully initialized instance the {@code interpolate()} method is called. It is
* passed an object value which may contain variables. All these variables are substituted if they can be resolved. The
* result is the passed in value with variables replaced. Alternatively, the {@code resolve()} method can be called to
* obtain the values of specific variables without performing interpolation.
* </p>
* <p><strong>String Conversion</strong></p>
* <p>
* When variables are part of larger interpolated strings, the variable values, which can be of any type, must be
* converted to strings to produce the full result. Each interpolator instance has a configurable
* {@link #setStringConverter(Function) string converter} to perform this conversion. The default implementation of this
* function simply uses the value's {@code toString} method in the majority of cases. However, for maximum
* consistency with
* {@link org.apache.commons.configuration2.convert.DefaultConversionHandler DefaultConversionHandler}, when a variable
* value is a container type (such as a collection or array), then only the first element of the container is converted
* to a string instead of the container itself. For example, if the variable {@code x} resolves to the integer array
* {@code [1, 2, 3]}, then the string <code>"my value = ${x}"</code> will by default be interpolated to
* {@code "my value = 1"}.
* </p>
* <p>
* <strong>Implementation note:</strong> This class is thread-safe. Lookup objects can be added or removed at any time
* concurrent to interpolation operations.
* </p>
*
* @since 1.4
*/
public class ConfigurationInterpolator {
/**
* Internal class used to construct the default {@link Lookup} map used by
* {@link ConfigurationInterpolator#getDefaultPrefixLookups()}.
*/
static final class DefaultPrefixLookupsHolder {
/** Singleton instance, initialized with the system properties. */
static final DefaultPrefixLookupsHolder INSTANCE = new DefaultPrefixLookupsHolder(System.getProperties());
/**
* Add the prefix and lookup from {@code lookup} to {@code map}.
* @param lookup lookup to add
* @param map map to add to
*/
private static void addLookup(final DefaultLookups lookup, final Map<String, Lookup> map) {
map.put(lookup.getPrefix(), lookup.getLookup());
}
/**
* Create the lookup map used when the user has requested no customization.
* @return default lookup map
*/
private static Map<String, Lookup> createDefaultLookups() {
final Map<String, Lookup> lookupMap = new HashMap<>();
addLookup(DefaultLookups.BASE64_DECODER, lookupMap);
addLookup(DefaultLookups.BASE64_ENCODER, lookupMap);
addLookup(DefaultLookups.CONST, lookupMap);
addLookup(DefaultLookups.DATE, lookupMap);
addLookup(DefaultLookups.ENVIRONMENT, lookupMap);
addLookup(DefaultLookups.FILE, lookupMap);
addLookup(DefaultLookups.JAVA, lookupMap);
addLookup(DefaultLookups.LOCAL_HOST, lookupMap);
addLookup(DefaultLookups.PROPERTIES, lookupMap);
addLookup(DefaultLookups.RESOURCE_BUNDLE, lookupMap);
addLookup(DefaultLookups.SYSTEM_PROPERTIES, lookupMap);
addLookup(DefaultLookups.URL_DECODER, lookupMap);
addLookup(DefaultLookups.URL_ENCODER, lookupMap);
addLookup(DefaultLookups.XML, lookupMap);
return lookupMap;
}
/**
* Constructs a lookup map by parsing the given string. The string is expected to contain
* comma or space-separated names of values from the {@link DefaultLookups} enum.
* @param str string to parse; not null
* @return lookup map parsed from the given string
* @throws IllegalArgumentException if the string does not contain a valid default lookup
* definition
*/
private static Map<String, Lookup> parseLookups(final String str) {
final Map<String, Lookup> lookupMap = new HashMap<>();
try {
for (final String lookupName : str.split("[\\s,]+")) {
if (!lookupName.isEmpty()) {
addLookup(DefaultLookups.valueOf(lookupName.toUpperCase()), lookupMap);
}
}
} catch (final IllegalArgumentException exc) {
throw new IllegalArgumentException("Invalid default lookups definition: " + str, exc);
}
return lookupMap;
}
/** Default lookup map. */
private final Map<String, Lookup> defaultLookups;
/**
* Constructs a new instance initialized with the given properties.
* @param props initialization properties
*/
DefaultPrefixLookupsHolder(final Properties props) {
final Map<String, Lookup> lookups = props.containsKey(DEFAULT_PREFIX_LOOKUPS_PROPERTY)
? parseLookups(props.getProperty(DEFAULT_PREFIX_LOOKUPS_PROPERTY))
: createDefaultLookups();
defaultLookups = Collections.unmodifiableMap(lookups);
}
/**
* Gets the default prefix lookups map.
* @return default prefix lookups map
*/
Map<String, Lookup> getDefaultPrefixLookups() {
return defaultLookups;
}
}
/** Class encapsulating the default logic to convert resolved variable values into strings.
* This class is thread-safe.
*/
private static final class DefaultStringConverter implements Function<Object, String> {
/** Shared instance. */
static final DefaultStringConverter INSTANCE = new DefaultStringConverter();
/** {@inheritDoc} */
@Override
public String apply(final Object obj) {
return Objects.toString(extractSimpleValue(obj), null);
}
/** Attempt to extract a simple value from {@code obj} for use in string conversion.
* If the input represents a collection of some sort (e.g., an iterable or array),
* the first item from the collection is returned.
* @param obj input object
* @return extracted simple object
*/
private Object extractSimpleValue(final Object obj) {
if (!(obj instanceof String)) {
if (obj instanceof Iterable) {
return nextOrNull(((Iterable<?>) obj).iterator());
}
if (obj instanceof Iterator) {
return nextOrNull((Iterator<?>) obj);
}
if (obj.getClass().isArray()) {
return Array.getLength(obj) > 0
? Array.get(obj, 0)
: null;
}
}
return obj;
}
/** Return the next value from {@code it} or {@code null} if no values remain.
* @param <T> iterated type
* @param it iterator
* @return next value from {@code it} or {@code null} if no values remain
*/
private <T> T nextOrNull(final Iterator<T> it) {
return it.hasNext()
? it.next()
: null;
}
}
/**
* Name of the system property used to determine the lookups added by the
* {@link #getDefaultPrefixLookups()} method. Use of this property is only required
* in cases where the set of default lookups must be modified.
*
* @since 2.8.0
*/
public static final String DEFAULT_PREFIX_LOOKUPS_PROPERTY =
"org.apache.commons.configuration2.interpol.ConfigurationInterpolator.defaultPrefixLookups";
/** Constant for the prefix separator. */
private static final char PREFIX_SEPARATOR = ':';
/** The variable prefix. */
private static final String VAR_START = "${";
/** The length of {@link #VAR_START}. */
private static final int VAR_START_LENGTH = VAR_START.length();
/** The variable suffix. */
private static final String VAR_END = "}";
/** The length of {@link #VAR_END}. */
private static final int VAR_END_LENGTH = VAR_END.length();
/**
* Creates a new instance based on the properties in the given specification object.
*
* @param spec the {@code InterpolatorSpecification}
* @return the newly created instance
*/
private static ConfigurationInterpolator createInterpolator(final InterpolatorSpecification spec) {
final ConfigurationInterpolator ci = new ConfigurationInterpolator();
ci.addDefaultLookups(spec.getDefaultLookups());
ci.registerLookups(spec.getPrefixLookups());
ci.setParentInterpolator(spec.getParentInterpolator());
ci.setStringConverter(spec.getStringConverter());
return ci;
}
/**
* Extracts the variable name from a value that consists of a single variable.
*
* @param strValue the value
* @return the extracted variable name
*/
private static String extractVariableName(final String strValue) {
return strValue.substring(VAR_START_LENGTH, strValue.length() - VAR_END_LENGTH);
}
/**
* Creates a new {@code ConfigurationInterpolator} instance based on the passed in specification object. If the
* {@code InterpolatorSpecification} already contains a {@code ConfigurationInterpolator} object, it is used directly.
* Otherwise, a new instance is created and initialized with the properties stored in the specification.
*
* @param spec the {@code InterpolatorSpecification} (must not be <b>null</b>)
* @return the {@code ConfigurationInterpolator} obtained or created based on the given specification
* @throws IllegalArgumentException if the specification is <b>null</b>
* @since 2.0
*/
public static ConfigurationInterpolator fromSpecification(final InterpolatorSpecification spec) {
if (spec == null) {
throw new IllegalArgumentException("InterpolatorSpecification must not be null!");
}
return spec.getInterpolator() != null ? spec.getInterpolator() : createInterpolator(spec);
}
/**
* Gets a map containing the default prefix lookups. Every configuration object derived from
* {@code AbstractConfiguration} is by default initialized with a {@code ConfigurationInterpolator} containing
* these {@code Lookup} objects and their prefixes. The map cannot be modified.
*
* <p>
* All of the lookups present in the returned map are from {@link DefaultLookups}. However, not all of the
* available lookups are included by default. Specifically, lookups that can execute code (e.g.,
* {@link DefaultLookups#SCRIPT SCRIPT}) and those that can result in contact with remote servers (e.g.,
* {@link DefaultLookups#URL URL} and {@link DefaultLookups#DNS DNS}) are not included. If this behavior
* must be modified, users can define the {@value #DEFAULT_PREFIX_LOOKUPS_PROPERTY} system property
* with a comma-separated list of {@link DefaultLookups} enum names to be included in the set of defaults.
* For example, setting this system property to {@code "BASE64_ENCODER,ENVIRONMENT"} will only include the
* {@link DefaultLookups#BASE64_ENCODER BASE64_ENCODER} and
* {@link DefaultLookups#ENVIRONMENT ENVIRONMENT} lookups. Setting the property to the empty string will
* cause no defaults to be configured.
* </p>
*
* <table>
* <caption>Default Lookups</caption>
* <tr>
* <th>Prefix</th>
* <th>Lookup</th>
* </tr>
* <tr>
* <td>"base64Decoder"</td>
* <td>{@link DefaultLookups#BASE64_DECODER BASE64_DECODER}</td>
* </tr>
* <tr>
* <td>"base64Encoder"</td>
* <td>{@link DefaultLookups#BASE64_ENCODER BASE64_ENCODER}</td>
* </tr>
* <tr>
* <td>"const"</td>
* <td>{@link DefaultLookups#CONST CONST}</td>
* </tr>
* <tr>
* <td>"date"</td>
* <td>{@link DefaultLookups#DATE DATE}</td>
* </tr>
* <tr>
* <td>"env"</td>
* <td>{@link DefaultLookups#ENVIRONMENT ENVIRONMENT}</td>
* </tr>
* <tr>
* <td>"file"</td>
* <td>{@link DefaultLookups#FILE FILE}</td>
* </tr>
* <tr>
* <td>"java"</td>
* <td>{@link DefaultLookups#JAVA JAVA}</td>
* </tr>
* <tr>
* <td>"localhost"</td>
* <td>{@link DefaultLookups#LOCAL_HOST LOCAL_HOST}</td>
* </tr>
* <tr>
* <td>"properties"</td>
* <td>{@link DefaultLookups#PROPERTIES PROPERTIES}</td>
* </tr>
* <tr>
* <td>"resourceBundle"</td>
* <td>{@link DefaultLookups#RESOURCE_BUNDLE RESOURCE_BUNDLE}</td>
* </tr>
* <tr>
* <td>"sys"</td>
* <td>{@link DefaultLookups#SYSTEM_PROPERTIES SYSTEM_PROPERTIES}</td>
* </tr>
* <tr>
* <td>"urlDecoder"</td>
* <td>{@link DefaultLookups#URL_DECODER URL_DECODER}</td>
* </tr>
* <tr>
* <td>"urlEncoder"</td>
* <td>{@link DefaultLookups#URL_ENCODER URL_ENCODER}</td>
* </tr>
* <tr>
* <td>"xml"</td>
* <td>{@link DefaultLookups#XML XML}</td>
* </tr>
* </table>
*
* <table>
* <caption>Additional Lookups (not included by default)</caption>
* <tr>
* <th>Prefix</th>
* <th>Lookup</th>
* </tr>
* <tr>
* <td>"dns"</td>
* <td>{@link DefaultLookups#DNS DNS}</td>
* </tr>
* <tr>
* <td>"url"</td>
* <td>{@link DefaultLookups#URL URL}</td>
* </tr>
* <tr>
* <td>"script"</td>
* <td>{@link DefaultLookups#SCRIPT SCRIPT}</td>
* </tr>
* </table>
*
* @return a map with the default prefix {@code Lookup} objects and their prefixes
* @since 2.0
*/
public static Map<String, Lookup> getDefaultPrefixLookups() {
return DefaultPrefixLookupsHolder.INSTANCE.getDefaultPrefixLookups();
}
/**
* Utility method for obtaining a {@code Lookup} object in a safe way. This method always returns a non-<b>null</b>
* {@code Lookup} object. If the passed in {@code Lookup} is not <b>null</b>, it is directly returned. Otherwise, result
* is a dummy {@code Lookup} which does not provide any values.
*
* @param lookup the {@code Lookup} to check
* @return a non-<b>null</b> {@code Lookup} object
* @since 2.0
*/
public static Lookup nullSafeLookup(Lookup lookup) {
if (lookup == null) {
lookup = DummyLookup.INSTANCE;
}
return lookup;
}
/** A map with the currently registered lookup objects. */
private final Map<String, Lookup> prefixLookups;
/** Stores the default lookup objects. */
private final List<Lookup> defaultLookups;
/** The helper object performing variable substitution. */
private final StringSubstitutor substitutor;
/** Stores a parent interpolator objects if the interpolator is nested hierarchically. */
private volatile ConfigurationInterpolator parentInterpolator;
/** Function used to convert interpolated values to strings. */
private volatile Function<Object, String> stringConverter = DefaultStringConverter.INSTANCE;
/**
* Creates a new instance of {@code ConfigurationInterpolator}.
*/
public ConfigurationInterpolator() {
prefixLookups = new ConcurrentHashMap<>();
defaultLookups = new CopyOnWriteArrayList<>();
substitutor = initSubstitutor();
}
/**
* Adds a default {@code Lookup} object. Default {@code Lookup} objects are queried (in the order they were added) for
* all variables without a special prefix. If no default {@code Lookup} objects are present, such variables won't be
* processed.
*
* @param defaultLookup the default {@code Lookup} object to be added (must not be <b>null</b>)
* @throws IllegalArgumentException if the {@code Lookup} object is <b>null</b>
*/
public void addDefaultLookup(final Lookup defaultLookup) {
defaultLookups.add(defaultLookup);
}
/**
* Adds all {@code Lookup} objects in the given collection as default lookups. The collection can be <b>null</b>, then
* this method has no effect. It must not contain <b>null</b> entries.
*
* @param lookups the {@code Lookup} objects to be added as default lookups
* @throws IllegalArgumentException if the collection contains a <b>null</b> entry
*/
public void addDefaultLookups(final Collection<? extends Lookup> lookups) {
if (lookups != null) {
defaultLookups.addAll(lookups);
}
}
/**
* Deregisters the {@code Lookup} object for the specified prefix at this instance. It will be removed from this
* instance.
*
* @param prefix the variable prefix
* @return a flag whether for this prefix a lookup object had been registered
*/
public boolean deregisterLookup(final String prefix) {
return prefixLookups.remove(prefix) != null;
}
/**
* Obtains the lookup object for the specified prefix. This method is called by the {@code lookup()} method. This
* implementation will check whether a lookup object is registered for the given prefix. If not, a <b>null</b> lookup
* object will be returned (never <b>null</b>).
*
* @param prefix the prefix
* @return the lookup object to be used for this prefix
*/
protected Lookup fetchLookupForPrefix(final String prefix) {
return nullSafeLookup(prefixLookups.get(prefix));
}
/**
* Gets a collection with the default {@code Lookup} objects added to this {@code ConfigurationInterpolator}. These
* objects are not associated with a variable prefix. The returned list is a snapshot copy of the internal collection of
* default lookups; so manipulating it does not affect this instance.
*
* @return the default lookup objects
*/
public List<Lookup> getDefaultLookups() {
return new ArrayList<>(defaultLookups);
}
/**
* Gets a map with the currently registered {@code Lookup} objects and their prefixes. This is a snapshot copy of the
* internally used map. So modifications of this map do not effect this instance.
*
* @return a copy of the map with the currently registered {@code Lookup} objects
*/
public Map<String, Lookup> getLookups() {
return new HashMap<>(prefixLookups);
}
/**
* Gets the parent {@code ConfigurationInterpolator}.
*
* @return the parent {@code ConfigurationInterpolator} (can be <b>null</b>)
*/
public ConfigurationInterpolator getParentInterpolator() {
return this.parentInterpolator;
}
/** Gets the function used to convert interpolated values to strings.
* @return function used to convert interpolated values to strings
*/
public Function<Object, String> getStringConverter() {
return stringConverter;
}
/**
* Creates and initializes a {@code StringSubstitutor} object which is used for variable substitution. This
* {@code StringSubstitutor} is assigned a specialized lookup object implementing the correct variable resolving
* algorithm.
*
* @return the {@code StringSubstitutor} used by this object
*/
private StringSubstitutor initSubstitutor() {
return new StringSubstitutor(key -> {
final Object value = resolve(key);
return value != null
? stringConverter.apply(value)
: null;
});
}
/**
* Performs interpolation of the passed in value. If the value is of type {@code String}, this method checks
* whether it contains variables. If so, all variables are replaced by their current values (if possible). For
* non string arguments, the value is returned without changes. In the special case where the value is a string
* consisting of a single variable reference, the interpolated variable value is <em>not</em> converted to a
* string before returning, so that callers can access the raw value. However, if the variable is part of a larger
* interpolated string, then the variable value is converted to a string using the configured
* {@link #getStringConverter() string converter}. (See the discussion on string conversion in the class
* documentation for more details.)
*
* <p><strong>Examples</strong></p>
* <p>
* For the following examples, assume that the default string conversion function is in place and that the
* variable {@code i} maps to the integer value {@code 42}.
* </p>
* <pre>
* interpolator.interpolate(1) → 1 // non-string argument returned unchanged
* interpolator.interpolate("${i}") → 42 // single variable value returned with raw type
* interpolator.interpolate("answer = ${i}") → "answer = 42" // variable value converted to string
* </pre>
*
* @param value the value to be interpolated
* @return the interpolated value
*/
public Object interpolate(final Object value) {
if (value instanceof String) {
final String strValue = (String) value;
if (isSingleVariable(strValue)) {
final Object resolvedValue = resolveSingleVariable(strValue);
if (resolvedValue != null && !(resolvedValue instanceof String)) {
// If the value is again a string, it needs no special
// treatment; it may also contain further variables which
// must be resolved; therefore, the default mechanism is
// applied.
return resolvedValue;
}
}
return substitutor.replace(strValue);
}
return value;
}
/**
* Sets a flag that variable names can contain other variables. If enabled, variable substitution is also done in
* variable names.
*
* @return the substitution in variables flag
*/
public boolean isEnableSubstitutionInVariables() {
return substitutor.isEnableSubstitutionInVariables();
}
/**
* Checks whether a value to be interpolated consists of single, simple variable reference, e.g.,
* <code>${myvar}</code>. In this case, the variable is resolved directly without using the
* {@code StringSubstitutor}.
*
* @param strValue the value to be interpolated
* @return {@code true} if the value contains a single, simple variable reference
*/
private boolean isSingleVariable(final String strValue) {
return strValue.startsWith(VAR_START)
&& strValue.indexOf(VAR_END, VAR_START_LENGTH) == strValue.length() - VAR_END_LENGTH;
}
/**
* Returns an unmodifiable set with the prefixes, for which {@code Lookup} objects are registered at this instance. This
* means that variables with these prefixes can be processed.
*
* @return a set with the registered variable prefixes
*/
public Set<String> prefixSet() {
return Collections.unmodifiableSet(prefixLookups.keySet());
}
/**
* Registers the given {@code Lookup} object for the specified prefix at this instance. From now on this lookup object
* will be used for variables that have the specified prefix.
*
* @param prefix the variable prefix (must not be <b>null</b>)
* @param lookup the {@code Lookup} object to be used for this prefix (must not be <b>null</b>)
* @throws IllegalArgumentException if either the prefix or the {@code Lookup} object is <b>null</b>
*/
public void registerLookup(final String prefix, final Lookup lookup) {
if (prefix == null) {
throw new IllegalArgumentException("Prefix for lookup object must not be null!");
}
if (lookup == null) {
throw new IllegalArgumentException("Lookup object must not be null!");
}
prefixLookups.put(prefix, lookup);
}
/**
* Registers all {@code Lookup} objects in the given map with their prefixes at this {@code ConfigurationInterpolator}.
* Using this method multiple {@code Lookup} objects can be registered at once. If the passed in map is <b>null</b>,
* this method does not have any effect.
*
* @param lookups the map with lookups to register (may be <b>null</b>)
* @throws IllegalArgumentException if the map contains <b>entries</b>
*/
public void registerLookups(final Map<String, ? extends Lookup> lookups) {
if (lookups != null) {
prefixLookups.putAll(lookups);
}
}
/**
* Removes the specified {@code Lookup} object from the list of default {@code Lookup}s.
*
* @param lookup the {@code Lookup} object to be removed
* @return a flag whether this {@code Lookup} object actually existed and was removed
*/
public boolean removeDefaultLookup(final Lookup lookup) {
return defaultLookups.remove(lookup);
}
/**
* Resolves the specified variable. This implementation tries to extract a variable prefix from the given variable name
* (the first colon (':') is used as prefix separator). It then passes the name of the variable with the prefix stripped
* to the lookup object registered for this prefix. If no prefix can be found or if the associated lookup object cannot
* resolve this variable, the default lookup objects are used. If this is not successful either and a parent
* {@code ConfigurationInterpolator} is available, this object is asked to resolve the variable.
*
* @param var the name of the variable whose value is to be looked up which may contain a prefix.
* @return the value of this variable or <b>null</b> if it cannot be resolved
*/
public Object resolve(final String var) {
if (var == null) {
return null;
}
final int prefixPos = var.indexOf(PREFIX_SEPARATOR);
if (prefixPos >= 0) {
final String prefix = var.substring(0, prefixPos);
final String name = var.substring(prefixPos + 1);
final Object value = fetchLookupForPrefix(prefix).lookup(name);
if (value != null) {
return value;
}
}
for (final Lookup lookup : defaultLookups) {
final Object value = lookup.lookup(var);
if (value != null) {
return value;
}
}
final ConfigurationInterpolator parent = getParentInterpolator();
if (parent != null) {
return getParentInterpolator().resolve(var);
}
return null;
}
/**
* Interpolates a string value that consists of a single variable.
*
* @param strValue the string to be interpolated
* @return the resolved value or <b>null</b> if resolving failed
*/
private Object resolveSingleVariable(final String strValue) {
return resolve(extractVariableName(strValue));
}
/**
* Sets the flag whether variable names can contain other variables. This flag corresponds to the
* {@code enableSubstitutionInVariables} property of the underlying {@code StringSubstitutor} object.
*
* @param f the new value of the flag
*/
public void setEnableSubstitutionInVariables(final boolean f) {
substitutor.setEnableSubstitutionInVariables(f);
}
/**
* Sets the parent {@code ConfigurationInterpolator}. This object is used if the {@code Lookup} objects registered at
* this object cannot resolve a variable.
*
* @param parentInterpolator the parent {@code ConfigurationInterpolator} object (can be <b>null</b>)
*/
public void setParentInterpolator(final ConfigurationInterpolator parentInterpolator) {
this.parentInterpolator = parentInterpolator;
}
/** Sets the function used to convert interpolated values to strings. Pass
* {@code null} to use the default conversion function.
* @param stringConverter function used to convert interpolated values to strings
* or {@code null} to use the default conversion function
*/
public void setStringConverter(final Function<Object, String> stringConverter) {
this.stringConverter = stringConverter != null
? stringConverter
: DefaultStringConverter.INSTANCE;
}
}