com.synopsys.arc.jenkinsci.plugins.extratoolinstallers.utils

Class EnvStringParseHelper

java.lang.Object

com.synopsys.arc.jenkinsci.plugins.extratoolinstallers.utils.EnvStringParseHelper

public class EnvStringParseHelper
extends Object

Provides parsing of environment variables in input string.

Since:

0.3

Author:

Oleg Nenashev , Synopsys Inc.

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkStringForMacro(hudson.tools.ToolInstaller installer, String stringName, String macroString) Resolves tools installation directory using global variables.
static String	substituteEnvVars(String macroString, hudson.EnvVars environment) Resolves tools installation directory using global variables.
static String	substituteNodeProperty(String macroString, hudson.slaves.NodeProperty<?> property) Substitutes string according to node property.
static String	substituteNodeVariables(String macroString, hudson.model.Node node)
static String	substituteNodeVariablesValidated(hudson.tools.ToolInstaller installer, String stringName, String macroString, hudson.model.Node node)

Methods inherited from class java.lang.Object

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

Method Detail

substituteEnvVars

public static String substituteEnvVars(String macroString,
                       hudson.EnvVars environment)

Resolves tools installation directory using global variables.

Parameters:

environment - Collection of environment variables

macroString - Input path with macro calls

Returns:

Raw string

Since:

0.3

substituteNodeVariablesValidated

public static String substituteNodeVariablesValidated(hudson.tools.ToolInstaller installer,
                                      String stringName,
                                      String macroString,
                                      hudson.model.Node node)
                                               throws ExtraToolInstallersException

Throws:

ExtraToolInstallersException

substituteNodeVariables

public static String substituteNodeVariables(String macroString,
                             hudson.model.Node node)

substituteNodeProperty

public static String substituteNodeProperty(String macroString,
                            hudson.slaves.NodeProperty<?> property)

Substitutes string according to node property.

Parameters:

macroString - String to be substituted

property - Node property

Returns:

Substituted string

Since:

0.3

checkStringForMacro

public static void checkStringForMacro(hudson.tools.ToolInstaller installer,
                       String stringName,
                       String macroString)
                                throws ExtraToolInstallersException

Resolves tools installation directory using global variables.

Parameters:

macroString - Input path with macro calls

Throws:

ExtraToolInstallersException - String validation failed (there are unresolved variables)

Since:

0.3