com.synopsys.arc.jenkinsci.plugins.customtools

Class EnvVariablesInjector

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<String,EnvVariablesInjector.Entity>

com.synopsys.arc.jenkinsci.plugins.customtools.EnvVariablesInjector

All Implemented Interfaces:

Serializable, Cloneable, Map<String,EnvVariablesInjector.Entity>, NavigableMap<String,EnvVariablesInjector.Entity>, SortedMap<String,EnvVariablesInjector.Entity>

public class EnvVariablesInjector
extends TreeMap<String,EnvVariablesInjector.Entity>

Tool-specific environment variables injector. Implements additionalVariables for CustomTool.

Since:

0.3

Author:

Oleg Nenashev

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnvVariablesInjector.Entity Internal entry, which describes modification of Environment Variables

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Method Summary

Modifier and Type	Method and Description
static EnvVariablesInjector	create(String props) Creates a new injector for the specified properties.
static EnvVariablesInjector	Create(String props) Deprecated. Use create(java.lang.String) instead. This method will be removed in future versions.
void	Inject(EnvVars target) Deprecated. Use injectVariables(hudson.EnvVars) instead. This method will be removed in future versions.
void	injectVariables(EnvVars target) Inject variables into EnvVars

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove

Method Detail

Create

@Nonnull
public static EnvVariablesInjector Create(@Nonnull
                                                    String props)
                                             throws IOException

Deprecated. Use create(java.lang.String) instead. This method will be removed in future versions.

Throws:

IOException

create

@Nonnull
public static EnvVariablesInjector create(@Nonnull
                                                    String props)
                                             throws IOException

Creates a new injector for the specified properties.

Parameters:

props - Properties in Java Properties format

Returns:

A new injector

Throws:

IOException - Cannot load properties from the string

Inject

public void Inject(EnvVars target)
            throws IOException

Deprecated. Use injectVariables(hudson.EnvVars) instead. This method will be removed in future versions.

Throws:

IOException

injectVariables

public void injectVariables(@Nonnull
                            EnvVars target)
                     throws IOException

Inject variables into EnvVars

Parameters:

target - Target variables

Throws:

IOException - Exception during modification of EnvVars