org.gradle.internal.nativeplatform

Interface ProcessEnvironment

All Known Implementing Classes:

AbstractProcessEnvironment, LibCBackedProcessEnvironment, UnsupportedEnvironment, WindowsProcessEnvironment

public interface ProcessEnvironment

Provides access to information about the current process.

Implementations are not thread-safe.

Method Summary

Methods

Modifier and Type	Method and Description
Long	getPid() Returns the OS level PID for the current process.
File	getProcessDir() Returns the working directory of the current process.
Long	maybeGetPid() Returns the OS level PID for the current process, or null if not available.
boolean	maybeRemoveEnvironmentVariable(String name) Removes the given environment variable, if possible.
boolean	maybeSetEnvironment(Map<String,String> source) Sets the environment of this process, if possible.
boolean	maybeSetEnvironmentVariable(String name, String value) Sets the given environment variable, if possible.
boolean	maybeSetProcessDir(File processDir) Sets the process working directory, if possible
void	removeEnvironmentVariable(String name) Removes the given environment variable.
void	setEnvironmentVariable(String name, String value) Sets the given environment variable.
void	setProcessDir(File processDir) Sets the process working directory.

Method Detail

maybeSetEnvironment

boolean maybeSetEnvironment(Map<String,String> source)

Sets the environment of this process, if possible.

Parameters:

source - The environment

Returns:

true if environment changed, false if not possible.

removeEnvironmentVariable

void removeEnvironmentVariable(String name)
                               throws NativeIntegrationException

Removes the given environment variable.

Parameters:

name - The name of the environment variable.

Throws:

NativeIntegrationException - If the environment variable cannot be removed.

maybeRemoveEnvironmentVariable

boolean maybeRemoveEnvironmentVariable(String name)

Removes the given environment variable, if possible.

Parameters:

name - The name of the environment variable.

Returns:

true if removed, false if not possible.

setEnvironmentVariable

void setEnvironmentVariable(String name,
                          String value)
                            throws NativeIntegrationException

Sets the given environment variable.

Parameters:

name - The name

value - The value. Can be null, which removes the environment variable.

Throws:

NativeIntegrationException - If the environment variable cannot be set.

maybeSetEnvironmentVariable

boolean maybeSetEnvironmentVariable(String name,
                                  String value)

Sets the given environment variable, if possible.

Parameters:

name - The name

value - The value

Returns:

true if set, false if not possible.

getProcessDir

File getProcessDir()
                   throws NativeIntegrationException

Returns the working directory of the current process.

Throws:

NativeIntegrationException - If the process directory is not available.

setProcessDir

void setProcessDir(File processDir)
                   throws NativeIntegrationException

Sets the process working directory.

Parameters:

processDir - The directory.

Throws:

NativeIntegrationException - If process directory cannot be set.

maybeSetProcessDir

boolean maybeSetProcessDir(File processDir)

Sets the process working directory, if possible

Parameters:

processDir - The directory.

Returns:

true if the directory can be set, false if not possible.

getPid

Long getPid()
            throws NativeIntegrationException

Returns the OS level PID for the current process.

Throws:

NativeIntegrationException - If the pid is not available.

maybeGetPid

Long maybeGetPid()

Returns the OS level PID for the current process, or null if not available.