Browse Source

Document the resourcecount task.

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@278344 13f79535-47bb-0310-9956-ffa450edef68
master
Matthew Jason Benson 20 years ago
parent
commit
4330670778
2 changed files with 69 additions and 0 deletions
  1. +68
    -0
      docs/manual/CoreTasks/resourcecount.html
  2. +1
    -0
      docs/manual/coretasklist.html

+ 68
- 0
docs/manual/CoreTasks/resourcecount.html View File

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

<head>
<meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>ResourceCount Task</title>
</head>

<body>

<h2>ResourceCount</h2>
<h3>Description</h3>
<p>Display or set a property containing the size of a nested
<a href="../CoreTypes/resources.html#collection">Resource Collection</a>.
Can also be used as a condition. <b>Since Ant 1.7</b></p>
<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">property</td>
<td valign="top">The property to set. If omitted the results are written
to the log. Ignored when processing as a condition.</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">refid</td>
<td valign="top">A <a href="../using.html#references">reference</a>
to a Resource Collection.</td>
<td valign="top" align="center">
Yes, unless a nested Resource Collection is supplied
</td>
</tr>
<tr>
<td valign="top">count</td>
<td valign="top">Comparison count for processing as a condition.</td>
<td valign="top" align="center">Yes, in condition mode</td>
</tr>
<tr>
<td valign="top">when</td>
<td valign="top">Comparison type: "equal", "eq", "greater", "gt", "less",
"lt", "ge" (greater or equal), "ne" (not equal), "le" (less or equal)
for use when operating as a condition.</td>
<td valign="top" align="center">No; default is "equal"</td>
</tr>
</table>
<h3>Parameters specified as nested elements</h3>
<h4>Resource Collection</h4>
<p>A single
<a href="../CoreTypes/resources.html#collection">Resource Collection</a>
should be specified via a nested element or the <code>refid</code> attribute.
</p>
<h3>Examples</h3>
<pre>&lt;resourcecount property=&quot;count.foo&quot;&gt;
&lt;filelist dir=&quot;.&quot; files=&quot;foo,bar&quot; /&gt;
&lt;/resourcecount&gt;
</pre>
<p>Stores the number of resources in the specified filelist (two)
in the property named <i>count.foo</i>.</p>
<hr>
<p align="center">Copyright &copy; 2005 The Apache Software Foundation.
All rights Reserved.</p>
</body>
</html>


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

@@ -78,6 +78,7 @@
<a href="CoreTasks/recorder.html">Record</a><br>
<a href="CoreTasks/rename.html"><i>Rename</i></a><br>
<a href="CoreTasks/replace.html">Replace</a><br>
<a href="CoreTasks/resourcecount.html">ResourceCount</a><br>
<a href="CoreTasks/rmic.html">Rmic</a><br>
<a href="CoreTasks/sequential.html">Sequential</a><br>
<a href="CoreTasks/signjar.html">SignJar</a><br>


Loading…
Cancel
Save