2001-02-13 12:32:01 +00:00
|
|
|
<html>
|
|
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Language" content="en-us">
|
2002-02-03 22:00:42 +00:00
|
|
|
<title>Property Task</title>
|
2001-02-13 12:32:01 +00:00
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<h2><a name="property">Property</a></h2>
|
|
|
|
|
<h3>Description</h3>
|
|
|
|
|
<p>Sets a property (by name and value), or set of properties (from file or
|
2001-10-19 06:26:33 +00:00
|
|
|
resource) in the project. Properties are case sensitive.</p>
|
2002-06-22 23:38:38 +00:00
|
|
|
Properties are immutable: whoever sets a property first freezes it for the
|
|
|
|
|
rest of the build; they are most definately not variable.
|
2001-02-13 12:32:01 +00:00
|
|
|
<p>There are five ways to set properties:</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>By supplying both the <i>name</i> and <i>value</i> attribute.</li>
|
|
|
|
|
<li>By supplying both the <i>name</i> and <i>refid</i> attribute.</li>
|
|
|
|
|
<li>By setting the <i>file</i> attribute with the filename of the property
|
|
|
|
|
file to load. This property file has the format as defined by the file used
|
|
|
|
|
in the class java.util.Properties.</li>
|
|
|
|
|
<li>By setting the <i>resource</i> attribute with the resource name of the
|
|
|
|
|
property file to load. This property file has the format as defined by the
|
|
|
|
|
file used in the class java.util.Properties.</li>
|
|
|
|
|
<li>By setting the <i>environment</i> attribute with a prefix to use.
|
|
|
|
|
Properties will be defined for every environment variable by
|
|
|
|
|
prefixing the supplied name and a period to the name of the variable.</li>
|
|
|
|
|
</ul>
|
2002-06-22 23:38:38 +00:00
|
|
|
<p>Although combinations of these ways are possible, only one should be used
|
2001-02-13 12:32:01 +00:00
|
|
|
at a time. Problems might occur with the order in which properties are set, for
|
|
|
|
|
instance.</p>
|
|
|
|
|
<p>The value part of the properties being set, might contain references to other
|
|
|
|
|
properties. These references are resolved at the time these properties are set.
|
|
|
|
|
This also holds for properties loaded from a property file.</p>
|
2001-08-30 13:23:14 +00:00
|
|
|
<p>A list of predefined properties can be found <a
|
|
|
|
|
href="../using.html#built-in-props">here</a>.</p>
|
2001-02-13 12:32:01 +00:00
|
|
|
<h3>Parameters</h3>
|
|
|
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top"><b>Attribute</b></td>
|
|
|
|
|
<td valign="top"><b>Description</b></td>
|
|
|
|
|
<td align="center" valign="top"><b>Required</b></td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">name</td>
|
|
|
|
|
<td valign="top">the name of the property to set.</td>
|
2001-08-30 13:23:14 +00:00
|
|
|
<td valign="top" align="center">No</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">value</td>
|
|
|
|
|
<td valign="top">the value of the property.</td>
|
2001-08-30 13:23:14 +00:00
|
|
|
<td valign="middle" align="center" rowspan="3">One of these, when using the
|
|
|
|
|
name attribute</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">location</td>
|
|
|
|
|
<td valign="top">Sets the property to the absolute filename of the
|
|
|
|
|
given file. If the value of this attribute is an absolute path, it
|
|
|
|
|
is left unchanged (with / and \ characters converted to the
|
|
|
|
|
current platforms conventions). Otherwise it is taken as a path
|
|
|
|
|
relative to the project's basedir and expanded.</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">refid</td>
|
|
|
|
|
<td valign="top"><a href="../using.html#references">Reference</a> to an object
|
|
|
|
|
defined elsewhere. Only yields reasonable results for references
|
|
|
|
|
to <a href="../using.html#path">PATH like structures</a> or properties.</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">resource</td>
|
|
|
|
|
<td valign="top">the resource name of the property file.</td>
|
2001-08-30 13:23:14 +00:00
|
|
|
<td valign="middle" align="center" rowspan="3">One of these, when
|
|
|
|
|
<b>not</b> using the name attribute</td>
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">file</td>
|
|
|
|
|
<td valign="top">the filename of the property file .</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">environment</td>
|
|
|
|
|
<td valign="top">the prefix to use when retrieving environment variables. Thus
|
|
|
|
|
if you specify environment="myenv" you will be able to access OS-specific
|
|
|
|
|
environment variables via property names "myenv.PATH" or
|
2002-06-22 23:38:38 +00:00
|
|
|
"myenv.TERM". Note that if you supply a property name with a final
|
|
|
|
|
"." it will not be doubled. ie environment="myenv." will still
|
|
|
|
|
allow access of environment variables through "myenv.PATH" and
|
|
|
|
|
"myenv.TERM". This functionality is currently only implemented
|
2001-02-13 12:32:01 +00:00
|
|
|
on select platforms. Feel free to send patches to increase the number of platforms
|
2001-10-19 06:26:33 +00:00
|
|
|
this functionality is supported on ;).<br>
|
|
|
|
|
Note also that properties are case sensitive, even if the
|
|
|
|
|
environment variables on your operating system are not, e.g. it
|
|
|
|
|
will be ${env.Path} not ${env.PATH} on Windows 2000.</td>
|
|
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">classpath</td>
|
|
|
|
|
<td valign="top">the classpath to use when looking up a resource.</td>
|
|
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
|
|
|
|
<tr>
|
|
|
|
|
<td valign="top">classpathref</td>
|
|
|
|
|
<td valign="top">the classpath to use when looking up a resource,
|
2002-06-22 23:38:38 +00:00
|
|
|
given as <a href="../using.html#references">reference</a> to a <path> defined
|
2001-02-13 12:32:01 +00:00
|
|
|
elsewhere..</td>
|
|
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
2002-02-24 04:18:56 +00:00
|
|
|
<tr>
|
|
|
|
|
<td valign="top">prefix</td>
|
|
|
|
|
<td valign="top">Prefix to apply to properties loaded using <code>file</code>
|
|
|
|
|
or <code>resource</code>. A "." is appended to the prefix if not specified.</td>
|
|
|
|
|
<td align="center" valign="top">No</td>
|
|
|
|
|
</tr>
|
2001-02-13 12:32:01 +00:00
|
|
|
</table>
|
|
|
|
|
<h3>Parameters specified as nested elements</h3>
|
|
|
|
|
<h4>classpath</h4>
|
|
|
|
|
<p><code>Property</code>'s <i>classpath</i> attribute is a <a
|
|
|
|
|
href="../using.html#path">PATH like structure</a> and can also be set via a nested
|
|
|
|
|
<i>classpath</i> element.</p>
|
|
|
|
|
<h3>Examples</h3>
|
|
|
|
|
<pre> <property name="foo.dist" value="dist"/></pre>
|
|
|
|
|
<p>sets the property <code>foo.dist</code> to the value "dist".</p>
|
|
|
|
|
<pre> <property file="foo.properties"/></pre>
|
|
|
|
|
<p>reads a set of properties from a file called "foo.properties".</p>
|
|
|
|
|
<pre> <property resource="foo.properties"/></pre>
|
|
|
|
|
<p>reads a set of properties from a resource called "foo.properties".</p>
|
|
|
|
|
<p>Note that you can reference a global properties file for all of your Ant
|
|
|
|
|
builds using the following:</p>
|
|
|
|
|
<pre> <property file="${user.home}/.ant-global.properties"/></pre>
|
|
|
|
|
<p>since the "user.home" property is defined by the Java virtual machine
|
2003-02-05 09:33:20 +00:00
|
|
|
to be your home directory. Where the "user.home" property resolves to in
|
|
|
|
|
the file system depends on the operating system version and the JVM implementation.
|
|
|
|
|
On Unix based systems, this will map to the user's home directory. On modern Windows
|
|
|
|
|
variants, this will most likely resolve to the user's directory in the "Documents
|
|
|
|
|
and Settings" folder. Older windows variants such as Windows 98/ME are less
|
|
|
|
|
predictable, as are other operating system/JVM combinations.</p>
|
2001-07-18 13:05:19 +00:00
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
<property environment="env"/>
|
|
|
|
|
<echo message="Number of Processors = ${env.NUMBER_OF_PROCESSORS}"/>
|
|
|
|
|
<echo message="ANT_HOME is set to = ${env.ANT_HOME}"/>
|
|
|
|
|
</pre>
|
|
|
|
|
<p>reads the system environment variables and stores them in properties, prefixed with "env".
|
|
|
|
|
Note that this only works on <em>select</em> operating systems.
|
|
|
|
|
Two of the values are shown being echoed.
|
|
|
|
|
</p>
|
|
|
|
|
|
2001-02-13 12:32:01 +00:00
|
|
|
<hr>
|
2003-02-05 11:20:21 +00:00
|
|
|
<p align="center">Copyright © 2000-2003 Apache Software Foundation. All rights
|
2001-02-13 12:32:01 +00:00
|
|
|
Reserved.</p>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
|
