com.palantir.giraffe.command

Class CommandEnvironment

java.lang.Object

com.palantir.giraffe.command.CommandEnvironment

public final class CommandEnvironment
extends Object

Describes the environment variables that are present when a Command executes.

The environment is represented as a base and a set of additive changes. This makes it simple to add and change values or reset the environment to a known state. To remove or unset a variable, use a system-dependent method to read the current environment as a map, remove the necessary variables, then set the modified environment on top of an empty base.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandEnvironment.BaseEnvironment Defines the target of environment changes.

Method Summary

Modifier and Type	Method and Description
CommandEnvironment	copy() Returns a copy of this environment.
static CommandEnvironment	defaultEnvironment() Returns a default environment with no changes.
static CommandEnvironment	emptyEnvironment() Returns an empty environment with no changes.
CommandEnvironment.BaseEnvironment	getBase() Returns this environment's base.
Map<String,String>	getChanges() Returns an unmodifiable view of the changes in this environment.
boolean	isDefault() Determines if this environment is the unmodified default environment.
CommandEnvironment	set(String name, String value) Sets the given variable in this environment.
CommandEnvironment	setAll(Map<String,String> env) Sets all the variables defined by the given map in this environment.

Methods inherited from class java.lang.Object

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

Method Detail

copy

public CommandEnvironment copy()

Returns a copy of this environment.

emptyEnvironment

public static CommandEnvironment emptyEnvironment()

Returns an empty environment with no changes.

defaultEnvironment

public static CommandEnvironment defaultEnvironment()

Returns a default environment with no changes.

set

public CommandEnvironment set(String name,
                              String value)

Sets the given variable in this environment.

Parameters:

name - the name of the variable

value - the value of the variable

Returns:

this CommandEnvironment

setAll

public CommandEnvironment setAll(Map<String,String> env)

Sets all the variables defined by the given map in this environment.

Parameters:

env - a map from variable names to values

Returns:

this CommandEnvironment

getBase

public CommandEnvironment.BaseEnvironment getBase()

Returns this environment's base.

isDefault

public boolean isDefault()

Determines if this environment is the unmodified default environment.

Returns:

true if this environment uses the default base and has no changes

getChanges

public Map<String,String> getChanges()

Returns an unmodifiable view of the changes in this environment.