dev.nokee.core.exec

Interface CommandLineToolInvocationEnvironmentVariables

public interface CommandLineToolInvocationEnvironmentVariables

Represents the environment variable of a command line tool invocation.

Since:

0.5

Method Summary

Modifier and Type	Method and Description
static CommandLineToolInvocationEnvironmentVariables	empty() Creates the empty invocation environment variables.
static CommandLineToolInvocationEnvironmentVariables	from(File propertiesFile) Creates the invocation environment variables from a .properties file.
static CommandLineToolInvocationEnvironmentVariables	from(List<?> environmentVariables) Creates the invocation environment variables from the specified list.
static CommandLineToolInvocationEnvironmentVariables	from(Map<String,?> environmentVariables) Creates the invocation environment variables from the specified map.
static CommandLineToolInvocationEnvironmentVariables	from(Properties properties) Creates the invocation environment variables from a Properties instance.
List<String>	getAsList() Returns the environment variables as a (key=value)-pair list.
Map<String,String>	getAsMap() Returns the environment variables as a (key, value)-pair map.
static CommandLineToolInvocationEnvironmentVariables	inherit() Creates the invocation environment variables from the current process.
CommandLineToolInvocationEnvironmentVariables	plus(CommandLineToolInvocationEnvironmentVariables environmentVariables) Merges the current environment variables with the specified environment variables.

Method Detail

getAsMap

Map<String,String> getAsMap()

Returns the environment variables as a (key, value)-pair map.

Returns:

a map representing the environment variables, never null.

getAsList

List<String> getAsList()

Returns the environment variables as a (key=value)-pair list.

Returns:

a list representing the environment variables, never null.

plus

CommandLineToolInvocationEnvironmentVariables plus(CommandLineToolInvocationEnvironmentVariables environmentVariables)

Merges the current environment variables with the specified environment variables.

Parameters:

environmentVariables - the environment variables to merge with this instance.

Returns:

a new instance representing the merged environment variables, never null.

from

static CommandLineToolInvocationEnvironmentVariables from(@Nullable
                                                          List<?> environmentVariables)

Creates the invocation environment variables from the specified list.

Parameters:

environmentVariables - the environment variables to use

Returns:

a instance representing the environment variables to use, never null.

from

static CommandLineToolInvocationEnvironmentVariables from(Map<String,?> environmentVariables)

Creates the invocation environment variables from the specified map.

Parameters:

environmentVariables - the environment variables to use

Returns:

a instance representing the environment variables to use, never null.

inherit

static CommandLineToolInvocationEnvironmentVariables inherit()

Creates the invocation environment variables from the current process.

Returns:

a instance representing the environment variables to use, never null.

empty

static CommandLineToolInvocationEnvironmentVariables empty()

Creates the empty invocation environment variables.

Returns:

a instance representing the environment variables to use, never null.

from

static CommandLineToolInvocationEnvironmentVariables from(File propertiesFile)

Creates the invocation environment variables from a .properties file.

Parameters:

propertiesFile - a file from which to load the environment variables

Returns:

a instance representing the environment variables to use, never null.

from

static CommandLineToolInvocationEnvironmentVariables from(Properties properties)

Creates the invocation environment variables from a Properties instance.

Parameters:

properties - a Properties instance of environment variables to use

Returns:

a instance representing the environment variables to use, never null.