org.apache.tools.ant.types

Class Environment

java.lang.Object

org.apache.tools.ant.types.Environment

Direct Known Subclasses:

CommandlineJava.SysProperties

public class Environment
extends java.lang.Object

Wrapper for environment variables.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Environment.Variable representation of a single env value

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector<Environment.Variable>	variables a vector of type Environment.Variable

Constructor Summary

Constructors

Constructor and Description
Environment() constructor

Method Summary

Modifier and Type	Method and Description
void	addVariable(Environment.Variable var) add a variable.
java.lang.String[]	getVariables() get the variable list as an array
java.util.Vector<Environment.Variable>	getVariablesVector() Get the raw vector of variables.

Methods inherited from class java.lang.Object

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

Field Detail

variables

protected java.util.Vector<Environment.Variable> variables

a vector of type Environment.Variable

See Also:

Environment.Variable

Constructor Detail

Environment

public Environment()

constructor

Method Detail

addVariable

public void addVariable(Environment.Variable var)

add a variable. Validity checking is not performed at this point. Duplicates are not caught either.

Parameters:

var - new variable.

getVariables

public java.lang.String[] getVariables()
                                throws BuildException

get the variable list as an array

Returns:

array of key=value assignment strings

Throws:

BuildException - if any variable is misconfigured

getVariablesVector

public java.util.Vector<Environment.Variable> getVariablesVector()

Get the raw vector of variables. This is not a clone.

Returns:

a potentially empty (but never null) vector of elements of type Variable

Since:

Ant 1.7