ant-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bode...@apache.org
Subject svn commit: r894459 - in /ant/core/trunk: WHATSNEW docs/manual/CoreTypes/resources.html src/etc/testcases/types/resources/resourcelist.xml src/main/org/apache/tools/ant/types/defaults.properties src/tests/antunit/types/resources/resourcelist-test.xml
Date Tue, 29 Dec 2009 18:23:08 GMT
Author: bodewig
Date: Tue Dec 29 18:22:59 2009
New Revision: 894459

URL: http://svn.apache.org/viewvc?rev=894459&view=rev
Log:
document resourcelist and make it available

Modified:
    ant/core/trunk/WHATSNEW
    ant/core/trunk/docs/manual/CoreTypes/resources.html
    ant/core/trunk/src/etc/testcases/types/resources/resourcelist.xml
    ant/core/trunk/src/main/org/apache/tools/ant/types/defaults.properties
    ant/core/trunk/src/tests/antunit/types/resources/resourcelist-test.xml

Modified: ant/core/trunk/WHATSNEW
URL: http://svn.apache.org/viewvc/ant/core/trunk/WHATSNEW?rev=894459&r1=894458&r2=894459&view=diff
==============================================================================
--- ant/core/trunk/WHATSNEW (original)
+++ ant/core/trunk/WHATSNEW Tue Dec 29 18:22:59 2009
@@ -1034,6 +1034,9 @@
    collections.
    Bugzilla Report 22269.
 
+ * a new <resourcelist> type is similar to <filelist> but can read the
+   list of resources from non-file resources and may return resources
+   that are not files.
 
 Changes from Ant 1.7.0 TO Ant 1.7.1
 =============================================

Modified: ant/core/trunk/docs/manual/CoreTypes/resources.html
URL: http://svn.apache.org/viewvc/ant/core/trunk/docs/manual/CoreTypes/resources.html?rev=894459&r1=894458&r2=894459&view=diff
==============================================================================
--- ant/core/trunk/docs/manual/CoreTypes/resources.html (original)
+++ ant/core/trunk/docs/manual/CoreTypes/resources.html Tue Dec 29 18:22:59 2009
@@ -371,6 +371,8 @@
   <li><a href="#archives">archives</a> - wraps around different
     resource collections and treats the nested resources as ZIP or TAR
     archives that will be extracted on the fly.</li>
+  <li><a href="#resourcelist">resourcelist</a> - a collection of
+    resources who's names have been read from another resource.</li>
 </ul>
 <h4><a name="resources">resources</a></h4>
 <p>A generic resource collection, designed for use with
@@ -1068,6 +1070,8 @@
 
 <h4><a name="mappedresources">mappedresources</a></h4>
 
+<p><em>Since Ant 1.8.0</em></p>
+
 <p>Wraps another resource collection and maps the names of the nested
   resources using a <a href="mapper.html">mapper</a>.</p>
 
@@ -1123,6 +1127,8 @@
 
 <h4><a name="archives">archives</a></h4>
 
+<p><em>Since Ant 1.8.0</em></p>
+
 <p>This resource collection accepts an arbitrary number of nested
   resources and assumes that all those resources must be either ZIP or
   TAR archives.  The resources returned
@@ -1166,5 +1172,80 @@
   </pre>
 </blockquote>
 
+<h4><a name="resourcelist">resourcelist</a></h4>
+
+<p><em>Since Ant 1.8.0</em></p>
+
+<p>This resource collection accepts an arbitrary number of nested
+  resources, reads those resources and returns a resource for each
+  line read.</p>
+
+<p>If the line contains a colon, Ant will try to use it as an URL and
+  if that fails (or the line doesn't contain a colon) will return a
+  file resource with the line's content as its name.</p>
+
+<p>Properties will be expanded for each line.  If the property
+  expansion yields a resource object rather than a string (for example
+  because of custom property helpers), the resources will be returned
+  directly.</p>
+
+<p><code>&lt;resourcelist&gt;</code> is a generalization
+  of <a href="filelist.html"><code>&lt;filelist&gt;</code></a>.</p>
+
+<blockquote>
+  <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">encoding</td>
+      <td valign="top">The encoding of the nested resources</td>
+      <td valign="top" align="center">No, default is platform default</td>
+    </tr>
+  </table>
+</blockquote>
+
+<blockquote>
+  <h4>Parameters specified as nested elements</h4>
+
+  <p><code>&lt;resourcelist&gt;</code> accepts arbitrary many
+    resource(collection)s as nested elements.</p>
+
+  <p>In addition <code>&lt;resourcelist&gt;</code> supports
+    nested <code>&lt;filterchain&gt;</code> elements that can be used
+    to filter/modify the read resources before their lines get
+    expanded.  Such a nested element corresponds to
+    a <a href="filterchain.html">filterchain</a>.</p>
+
+  <h4>Examples</h4>
+
+  <p>The following example copies a file from the first URL of
+    several alternatives that can actually be reached.  It assumes
+    that the file mirrors.txt looks like</p>
+
+  <pre>
+    mirrors.txt:
+http://best.mirror.example.org/
+http://second.best.mirror.example.org/mirror/of/best/
+https://yet.another.mirror/
+http://the.original.site/
+  </pre>
+    
+  <pre>
+    &lt;copy todir="${target}"&gt;
+      &lt;first&gt;
+        &lt;restrict&gt;
+          &lt;resourcelist&gt;
+            &lt;file file="mirrors.txt"/&gt;
+          &lt;/resourcelist&gt;
+          &lt;exists/&gt;
+        &lt;/restrict&gt;
+      &lt;/first&gt;
+    &lt;/copy&gt;
+  </pre>
+</blockquote>
+
 </body>
 </html>

Modified: ant/core/trunk/src/etc/testcases/types/resources/resourcelist.xml
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/etc/testcases/types/resources/resourcelist.xml?rev=894459&r1=894458&r2=894459&view=diff
==============================================================================
--- ant/core/trunk/src/etc/testcases/types/resources/resourcelist.xml (original)
+++ ant/core/trunk/src/etc/testcases/types/resources/resourcelist.xml Tue Dec 29 18:22:59
2009
@@ -21,8 +21,6 @@
   </target>
 
   <target name="setUp">
-    <typedef name="resourcelist"
-             classname="org.apache.tools.ant.types.resources.ResourceList"/>
   </target>
 
 </project>

Modified: ant/core/trunk/src/main/org/apache/tools/ant/types/defaults.properties
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/types/defaults.properties?rev=894459&r1=894458&r2=894459&view=diff
==============================================================================
--- ant/core/trunk/src/main/org/apache/tools/ant/types/defaults.properties (original)
+++ ant/core/trunk/src/main/org/apache/tools/ant/types/defaults.properties Tue Dec 29 18:22:59
2009
@@ -76,6 +76,7 @@
 tokens=org.apache.tools.ant.types.resources.Tokens
 mappedresources=org.apache.tools.ant.types.resources.MappedResourceCollection
 archives=org.apache.tools.ant.types.resources.Archives
+resourcelist=org.apache.tools.ant.types.resources.ResourceList
 
 #Resources (single-element ResourceCollections):
 resource=org.apache.tools.ant.types.Resource

Modified: ant/core/trunk/src/tests/antunit/types/resources/resourcelist-test.xml
URL: http://svn.apache.org/viewvc/ant/core/trunk/src/tests/antunit/types/resources/resourcelist-test.xml?rev=894459&r1=894458&r2=894459&view=diff
==============================================================================
--- ant/core/trunk/src/tests/antunit/types/resources/resourcelist-test.xml (original)
+++ ant/core/trunk/src/tests/antunit/types/resources/resourcelist-test.xml Tue Dec 29 18:22:59
2009
@@ -22,8 +22,6 @@
   <import file="../../antunit-base.xml" />
 
   <target name="setUp">
-    <typedef name="resourcelist"
-             classname="org.apache.tools.ant.types.resources.ResourceList"/>
     <mkdir dir="${input}"/>
     <mkdir dir="${output}"/>
     <touch file="${input}/b.txt"/>



Mime
View raw message