Environment DataType
The apply and
exec tasks, which execute system commands, accept
zero or more nested <env> elements. These
elements specify which environment variables are passed to the system
command being executed, and they are implemented by the
org.apache.tools.ant.types.Environment.Variable
class. The <env> element accepts the
following attributes:
-
file(all, File,*) A filename as the value of the environment variable. The name is converted to an absolute path.
-
key(all, String,Y) The environment variable name.
-
path(all, Path, *) A path as the value of the environment variable. Ant converts this to local conventions, as explained in “Path DataType.” For instance,
foo.txtis converted intoC:\path\to\file\foo.txton Windows platforms.-
value(all, String, *) A literal value for the environment variable.
Exactly one of file, path, or
value is required.
Example
The following example calls a batch file named
deploy.bat. Within the batch file, the
TOMCAT_HOME environment variable is available
because of the <env> element:
<property name="tomcat.home" value="/path/to/tomcat"/>
<target name="deploy">
<!-- Call a deployment script, setting up the TOMCAT_HOME -->
<!-- environment variable. -->
<exec executable="deploy.bat">
<env key="TOMCAT_HOME" value="${tomcat.home}"/>
</exec>
</target>Using Environment Variables in Buildfiles
The preceding example shows how you can pass environment variables to
system commands using exec and
env. Ant also allows you to use environment variables ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access