Browse Source

Add documentation for propertyset

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@274564 13f79535-47bb-0310-9956-ffa450edef68
master
Stefan Bodewig 22 years ago
parent
commit
1b88e53674
6 changed files with 143 additions and 3 deletions
  1. +12
    -2
      docs/manual/CoreTasks/ant.html
  2. +9
    -1
      docs/manual/CoreTasks/antcall.html
  3. +8
    -0
      docs/manual/CoreTasks/java.html
  4. +107
    -0
      docs/manual/CoreTypes/propertyset.html
  5. +6
    -0
      docs/manual/OptionalTasks/junit.html
  6. +1
    -0
      docs/manual/conceptstypeslist.html

+ 12
- 2
docs/manual/CoreTasks/ant.html View File

@@ -87,7 +87,9 @@ project.</p>
</tr>
</table>

<h3>Parameters specified as nested elements</h3> <h4>property</h4>
<h3>Parameters specified as nested elements</h3>

<h4>property</h4>
<p>See the description of the <a href="property.html">property
task</a>. Note that the <code>refid</code> attribute points to a
reference in the calling project, not in the new one.</p>
@@ -114,6 +116,14 @@ optionally changing their id.</p>
</tr>
</table>

<h4>propertyset</h4>

<p>You can specify a set of properties to be copied into the new
project with <a
href="../CoreTypes/propertyset.html">propertyset</a>s.</p>

<p><em>since Ant 1.6</em>.</p>

<h3>Basedir of the new project</h3>

<p>The basedir value of the new project is affected by the two
@@ -222,7 +232,7 @@ a <code>&lt;path&gt;</code> with the id <code>path1</code>, but
new project using the id <code>path2</code>.</p>

<hr>
<p align="center">Copyright &copy; 2000-2002 Apache Software Foundation. All rights
<p align="center">Copyright &copy; 2000-2003 Apache Software Foundation. All rights
Reserved.</p>

</body>


+ 9
- 1
docs/manual/CoreTasks/antcall.html View File

@@ -101,6 +101,14 @@ optionally changing their id.</p>
</tr>
</table>

<h4>propertyset</h4>

<p>You can specify a set of properties to be copied into the new
project with <a
href="../CoreTypes/propertyset.html">propertyset</a>s.</p>

<p><em>since Ant 1.6</em>.</p>

<h3>Examples</h3>
<pre>
&lt;target name=&quot;default&quot;&gt;
@@ -124,7 +132,7 @@ optionally changing their id.</p>
<p>will copy the parent's definition of <code>path1</code> into the
new project using the id <code>path2</code>.</p>

<hr><p align="center">Copyright &copy; 2000-2002 Apache Software Foundation. All rights
<hr><p align="center">Copyright &copy; 2000-2003 Apache Software Foundation. All rights
Reserved.</p>

</body>


+ 8
- 0
docs/manual/CoreTasks/java.html View File

@@ -177,6 +177,14 @@ These properties will be made available to the VM during the execution
of the class (either ANT's VM or the forked VM). The attributes
for this element are the same as for <a href="exec.html#env">environment
variables</a>.</p>

<h4>syspropertyset</h4>

<p>You can specify a set of properties to be used as system properties
with <a href="../CoreTypes/propertyset.html">syspropertyset</a>s.</p>

<p><em>since Ant 1.6</em>.</p>

<h4>classpath</h4>
<p><code>Java</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


+ 107
- 0
docs/manual/CoreTypes/propertyset.html View File

@@ -0,0 +1,107 @@
<html>

<head>
<meta http-equiv="Content-Language" content="en-us">
<title>PropertySet Type</title>
</head>

<body>

<h2><a name="propertyset">PropertySet</a></h2>
<p><em>Since Ant 1.6</em></p>

<p>Groups a set of properties to be used by reference in a task that
supports this.</p>

<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">dynamic</td>
<td valign="top">Whether to reevaluate the set everytime the set
is used. Default is &quot;<code>true</code>&quot;.</td>
<td valign="top" align="center">No</td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>

<h4>propertyref</h4>

<p>Selects properties from the current project to be included in the
set.</p>

<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">Select the property with the given name.</td>
<td align="center" valign="top" rowspan="3">Exactly one of these.</td>
</tr>
<tr>
<td valign="top">prefix</td>
<td valign="top">Select the properties whose name starts with the
given string.</td>
</tr>
<tr>
<td valign="top">regexp</td>
<td valign="top">Select the properties that match the given
regular expression. Similar to <a
href="mapper.html#regexp-mapper">regexp type mappers</a>, this
equires a supported regular expression library.</td>
</tr>
</table>

<h4>propertyset</h4>

<p>A <code>propertyset</code> can be used as the set union of more
<code>propertyset</code>s.</p>

<p>For example:</p>

<blockquote><pre>
&lt;propertyset id=&quot;properties-starting-with-foo&quot;&gt;
&lt;propertyref prefix=&quot;foo&quot;/&gt;
&lt;/propertyset&gt;
&lt;propertyset id=&quot;properties-starting-with-bar&quot;&gt;
&lt;propertyref prefix=&quot;bar&quot;/&gt;
&lt;/propertyset&gt;
&lt;propertyset id=&quot;my-set&quot;&gt;
&lt;propertyset refid=&quot;properties-starting-with-foo&quot;/&gt;
&lt;propertyset refid=&quot;properties-starting-with-bar&quot;/&gt;
&lt;/propertyset&gt;
</pre></blockquote>

<p>collects all properties whose name starts with either
&quot;foo&quot; or &quot;bar&quot; in the set named
&quot;my-set&quot;.</p>

<h4>mapper</h4>

<p>A <a href="mapper.html">mapper</a> - at maximum one mapper can be
specified. The mapper is used to change the names of the property
keys, for example:

<blockquote><pre>
&lt;propertyset id=&quot;properties-starting-with-foo&quot;&gt;
&lt;propertyref prefix=&quot;foo&quot;/&gt;
&lt;mapper type=&quot;glob&quot; from=&quot;foo*&quot; to=&quot;bar*&quot;/&gt;
&lt;/propertyset&gt;
</pre></blockquote>

<p>collects all properties whose name starts with &quot;foo&quot;, but
changes the names to start with &quot;bar&quot; instead.</p>

<hr>
<p align="center">Copyright &copy; 2003 Apache Software Foundation. All rights
Reserved.</p>

</body>
</html>


+ 6
- 0
docs/manual/OptionalTasks/junit.html View File

@@ -212,6 +212,12 @@ The attributes for this element are the same as for <a href="../CoreTasks/exec.h
<p>would run the test in ANT's VM and make the <code>basedir</code> property
available to the test.</p>

<h4>syspropertyset</h4>

<p>You can specify a set of properties to be used as system properties
with <a href="../CoreTypes/propertyset.html">syspropertyset</a>s.</p>

<p><em>since Ant 1.6</em>.</p>

<h4>env</h4>



+ 1
- 0
docs/manual/conceptstypeslist.html View File

@@ -25,6 +25,7 @@
<a href="CoreTypes/filterset.html">FilterSet</a><br>
<a href="CoreTypes/patternset.html">PatternSet</a><br>
<a href="using.html#path">Path-like Structures</a><br>
<a href="CoreTypes/propertyset.html">PropertySet</a><br>
<a href="CoreTypes/selectors.html">Selectors</a><br>
<a href="CoreTypes/xmlcatalog.html">XMLCatalog</a><br>
<a href="CoreTypes/zipfileset.html">ZipFileSet</a><br>


Loading…
Cancel
Save