org.netbeans.spi.extexecution.base

Interface EnvironmentImplementation

public interface EnvironmentImplementation

The interface representing the implementation of Environment.

See Also:

Environment

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.

Method Detail

getVariable

@CheckForNull
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

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

Appends a path to a path-like variable. The proper path separator should be 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

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

Prepends a path to a path-like variable. The proper path separator should be 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

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

void removeVariable(@NonNull
                    String name)

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

Parameters:

name - the name of the variable

values

@NonNull
Map<String,String> values()

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

Returns:

all variable names and associated values