jenkins.plugins.customtools.util.envvars

Class VariablesSubstitutionHelper

java.lang.Object

jenkins.plugins.customtools.util.envvars.VariablesSubstitutionHelper

Direct Known Subclasses:

VariablesSubstitutionHelper.PropFileVariablesSubstitutionHelper, VariablesSubstitutionHelper.SimpleVariablesSubstitutionHelper

public abstract class VariablesSubstitutionHelper
extends Object

Substitutes variables.

Since:

TODO

Author:

Oleg Nenashev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VariablesSubstitutionHelper.PropFileVariablesSubstitutionHelper
static class	VariablesSubstitutionHelper.SimpleVariablesSubstitutionHelper

Field Summary

Fields

Modifier and Type	Field and Description
static VariablesSubstitutionHelper	PATH
static VariablesSubstitutionHelper	PROP_FILE

Constructor Summary

Constructors

Constructor and Description
VariablesSubstitutionHelper()

Method Summary

Modifier and Type	Method and Description
String	escapeVariableValue(String variableName, String rawValue) Escapes variable values for the required format.
static boolean	hasMacros(String inputString)
static boolean	hasMacros(String inputString, String macroName)
String	resolveVariable(String inputValue, EnvVars environment) Resolves tools installation directory using global variables.
String	resolveVariable(String inputValue, Node node)

Methods inherited from class java.lang.Object

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

Field Detail

PROP_FILE

public static final VariablesSubstitutionHelper PROP_FILE

PATH

public static final VariablesSubstitutionHelper PATH

Constructor Detail

VariablesSubstitutionHelper

public VariablesSubstitutionHelper()

Method Detail

escapeVariableValue

public String escapeVariableValue(String variableName,
                                  String rawValue)

Escapes variable values for the required format.

Parameters:

variableName - Name of the variable, which is being substituted

rawValue - Input value

Returns:

Escaped value

resolveVariable

public String resolveVariable(@CheckForNull
                              String inputValue,
                              @Nonnull
                              EnvVars environment)

Resolves tools installation directory using global variables.

Parameters:

environment - Collection of environment variables

inputValue - Input path with macro calls

Returns:

Raw string

Since:

0.3

resolveVariable

public String resolveVariable(@CheckForNull
                              String inputValue,
                              @Nonnull
                              Node node)

hasMacros

public static boolean hasMacros(@CheckForNull
                                String inputString)

hasMacros

public static boolean hasMacros(@CheckForNull
                                String inputString,
                                String macroName)