org.gradle.internal.nativeplatform.jna

Class AbstractProcessEnvironment

java.lang.Object

org.gradle.internal.nativeplatform.jna.AbstractProcessEnvironment

All Implemented Interfaces:

ProcessEnvironment

Direct Known Subclasses:

LibCBackedProcessEnvironment, WindowsProcessEnvironment

public abstract class AbstractProcessEnvironment
extends Object
implements ProcessEnvironment

Constructor Summary

Constructors

Constructor and Description
AbstractProcessEnvironment()

Method Summary

Methods

Modifier and Type	Method and Description
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.
protected abstract void	removeNativeEnvironmentVariable(String name)
void	setEnvironmentVariable(String name, String value) Sets the given environment variable.
protected abstract void	setNativeEnvironmentVariable(String name, String value)
protected abstract void	setNativeProcessDir(File processDir)
void	setProcessDir(File processDir) Sets the process working directory.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gradle.internal.nativeplatform.ProcessEnvironment

getPid, getProcessDir

Constructor Detail

AbstractProcessEnvironment

public AbstractProcessEnvironment()

Method Detail

maybeSetEnvironment

public boolean maybeSetEnvironment(Map<String,String> source)

Description copied from interface: ProcessEnvironment

Sets the environment of this process, if possible.

Specified by:

maybeSetEnvironment in interface ProcessEnvironment

Parameters:

source - The environment

Returns:

true if environment changed, false if not possible.

removeEnvironmentVariable

public void removeEnvironmentVariable(String name)
                               throws NativeIntegrationException

Description copied from interface: ProcessEnvironment

Removes the given environment variable.

Specified by:

removeEnvironmentVariable in interface ProcessEnvironment

Parameters:

name - The name of the environment variable.

Throws:

NativeIntegrationException - If the environment variable cannot be removed.

removeNativeEnvironmentVariable

protected abstract void removeNativeEnvironmentVariable(String name)

maybeRemoveEnvironmentVariable

public boolean maybeRemoveEnvironmentVariable(String name)

Description copied from interface: ProcessEnvironment

Removes the given environment variable, if possible.

Specified by:

maybeRemoveEnvironmentVariable in interface ProcessEnvironment

Parameters:

name - The name of the environment variable.

Returns:

true if removed, false if not possible.

setEnvironmentVariable

public void setEnvironmentVariable(String name,
                          String value)
                            throws NativeIntegrationException

Description copied from interface: ProcessEnvironment

Sets the given environment variable.

Specified by:

setEnvironmentVariable in interface ProcessEnvironment

Parameters:

name - The name

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

Throws:

NativeIntegrationException - If the environment variable cannot be set.

setNativeEnvironmentVariable

protected abstract void setNativeEnvironmentVariable(String name,
                                String value)

maybeSetEnvironmentVariable

public boolean maybeSetEnvironmentVariable(String name,
                                  String value)

Description copied from interface: ProcessEnvironment

Sets the given environment variable, if possible.

Specified by:

maybeSetEnvironmentVariable in interface ProcessEnvironment

Parameters:

name - The name

value - The value

Returns:

true if set, false if not possible.

setProcessDir

public void setProcessDir(File processDir)
                   throws NativeIntegrationException

Description copied from interface: ProcessEnvironment

Sets the process working directory.

Specified by:

setProcessDir in interface ProcessEnvironment

Parameters:

processDir - The directory.

Throws:

NativeIntegrationException - If process directory cannot be set.

setNativeProcessDir

protected abstract void setNativeProcessDir(File processDir)

maybeSetProcessDir

public boolean maybeSetProcessDir(File processDir)

Description copied from interface: ProcessEnvironment

Sets the process working directory, if possible

Specified by:

maybeSetProcessDir in interface ProcessEnvironment

Parameters:

processDir - The directory.

Returns:

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

maybeGetPid

public Long maybeGetPid()

Description copied from interface: ProcessEnvironment

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

Specified by:

maybeGetPid in interface ProcessEnvironment