org.netbeans.api.extexecution.base

Class Environment

java.lang.Object

org.netbeans.api.extexecution.base.Environment

public final class Environment
extends Object

The class that provides an access to environment variables.

See Also:

ProcessBuilder.getEnvironment(), EnvironmentImplementation

Method Summary

Modifier and Type	Method and Description
void	appendPath(String name, String value) Appends a path to a path-like variable.
String	getVariable(String name) Returns the value of the variable or null.
void	prependPath(String name, String value) Prepends a path to a path-like variable.
void	removeVariable(String name) Removes a variable with the given name.
void	setVariable(String name, String value) Sets a value for a variable with the given name.
Map<String,String>	values() Returns all variable names and associated values as a Map.

Methods inherited from class java.lang.Object

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

Method Detail

getVariable

@CheckForNull
public String getVariable(@NonNull
                                        String name)

Returns the value of the variable or null.

Parameters:

name - the name of the variable

Returns:

the value of the variable or null

appendPath

public void appendPath(@NonNull
                       String name,
                       @NonNull
                       String value)

Appends a path to a path-like variable. The proper path separator is used to separate the new value.

Parameters:

name - the name of the variable such as for example PATH or LD_LIBRARY_PATH

value - the value (path to append)

prependPath

public void prependPath(@NonNull
                        String name,
                        @NonNull
                        String value)

Prepends a path to a path-like variable. The proper path separator is used to separate the new value.

Parameters:

name - the name of the variable such as for example PATH or LD_LIBRARY_PATH

value - the value (path to prepend)

setVariable

public void setVariable(@NonNull
                        String name,
                        @NonNull
                        String value)

Sets a value for a variable with the given name.

Parameters:

name - the name of the variable

value - the value

removeVariable

public void removeVariable(@NonNull
                           String name)

Removes a variable with the given name. The subsequent call to Environment.getVariable(java.lang.String) with the same argument will return null.

Parameters:

name - the name of the variable

values

@NonNull
public Map<String,String> values()

Returns all variable names and associated values as a Map. Changes to the map are not propagated back to the Environment.

Returns:

all variable names and associated values