Package org.apache.maven.cli.props

Class InterpolationHelper

java.lang.Object

org.apache.maven.cli.props.InterpolationHelper

public class InterpolationHelper
extends Object

Method Summary

Modifier and Type	Method	Description
static String	escape(String val)
static void	performSubstitution(Map<String,String> properties, Function<String,String> callback)	Perform substitution on a property set
static void	performSubstitution(Map<String,String> properties, Function<String,String> callback, boolean substituteFromConfig, boolean defaultsToEmptyString)	Perform substitution on a property set
static String	substVars(String val, String currentKey, Map<String,String> cycleMap, Map<String,String> configProps)	This method performs property variable substitution on the specified value.
static String	substVars(String val, String currentKey, Map<String,String> cycleMap, Map<String,String> configProps, Function<String,String> callback)	This method performs property variable substitution on the specified value.
static String	substVars(String val, String currentKey, Map<String,String> cycleMap, Map<String,String> configProps, Function<String,String> callback, boolean substituteFromConfig, boolean defaultsToEmptyString)	This method performs property variable substitution on the specified value.

Methods inherited from class java.lang.Object

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

Method Details

performSubstitution

public static void performSubstitution(Map<String,String> properties,
 Function<String,String> callback)

Perform substitution on a property set

Parameters:

properties - the property set to perform substitution on

callback - Callback for substitution

performSubstitution

public static void performSubstitution(Map<String,String> properties,
 Function<String,String> callback,
 boolean substituteFromConfig,
 boolean defaultsToEmptyString)

Perform substitution on a property set

Parameters:

properties - the property set to perform substitution on

callback - the callback to obtain substitution values

substituteFromConfig - If substitute from configuration

defaultsToEmptyString - sets an empty string if a replacement value is not found, leaves intact otherwise

substVars

public static String substVars(String val,
 String currentKey,
 Map<String,String> cycleMap,
 Map<String,String> configProps)

This method performs property variable substitution on the specified value. If the specified value contains the syntax ${<prop-name>}, where <prop-name> refers to either a configuration property or a system property, then the corresponding property value is substituted for the variable placeholder. Multiple variable placeholders may exist in the specified value as well as nested variable placeholders, which are substituted from inner most to outer most. Configuration properties override system properties.

Parameters:

val - The string on which to perform property substitution.

currentKey - The key of the property being evaluated used to detect cycles.

cycleMap - Map of variable references used to detect nested cycles.

configProps - Set of configuration properties.

Returns:

The value of the specified string after system property substitution.

Throws:

IllegalArgumentException - If there was a syntax error in the property placeholder syntax or a recursive variable reference.

substVars

public static String substVars(String val,
 String currentKey,
 Map<String,String> cycleMap,
 Map<String,String> configProps,
 Function<String,String> callback)

This method performs property variable substitution on the specified value. If the specified value contains the syntax ${<prop-name>}, where <prop-name> refers to either a configuration property or a system property, then the corresponding property value is substituted for the variable placeholder. Multiple variable placeholders may exist in the specified value as well as nested variable placeholders, which are substituted from inner most to outer most. Configuration properties override system properties.

Parameters:

val - The string on which to perform property substitution.

currentKey - The key of the property being evaluated used to detect cycles.

cycleMap - Map of variable references used to detect nested cycles.

configProps - Set of configuration properties.

callback - the callback to obtain substitution values

Returns:

The value of the specified string after system property substitution.

Throws:

IllegalArgumentException - If there was a syntax error in the property placeholder syntax or a recursive variable reference.

substVars

public static String substVars(String val,
 String currentKey,
 Map<String,String> cycleMap,
 Map<String,String> configProps,
 Function<String,String> callback,
 boolean substituteFromConfig,
 boolean defaultsToEmptyString)

This method performs property variable substitution on the specified value. If the specified value contains the syntax ${<prop-name>}, where <prop-name> refers to either a configuration property or a system property, then the corresponding property value is substituted for the variable placeholder. Multiple variable placeholders may exist in the specified value as well as nested variable placeholders, which are substituted from inner most to outer most. Configuration properties override system properties.

Parameters:

val - The string on which to perform property substitution.

currentKey - The key of the property being evaluated used to detect cycles.

cycleMap - Map of variable references used to detect nested cycles.

configProps - Set of configuration properties.

callback - the callback to obtain substitution values

substituteFromConfig - If substitute from configuration

defaultsToEmptyString - sets an empty string if a replacement value is not found, leaves intact otherwise

Returns:

The value of the specified string after system property substitution.

Throws:

IllegalArgumentException - If there was a syntax error in the property placeholder syntax or a recursive variable reference.

escape

public static String escape(String val)