youys
/
ant
Not watched
1
0
Fork 1
Code
Releases 0 Wiki Activity
Issues 0 Pull Requests 0 Datasets Model Cloudbrain
You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: 033f8dc250
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '033f8dc250'
${ noResults }
ant/manual/Types/mapper.html

973 lines
33 KiB
Raw Blame History 

  1. <!--

  2.    Licensed to the Apache Software Foundation (ASF) under one or more

  3.    contributor license agreements.  See the NOTICE file distributed with

  4.    this work for additional information regarding copyright ownership.

  5.    The ASF licenses this file to You under the Apache License, Version 2.0

  6.    (the "License"); you may not use this file except in compliance with

  7.    the License.  You may obtain a copy of the License at

  8. 

  9.        http://www.apache.org/licenses/LICENSE-2.0

  10. 

  11.    Unless required by applicable law or agreed to in writing, software

  12.    distributed under the License is distributed on an "AS IS" BASIS,

  13.    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  14.    See the License for the specific language governing permissions and

  15.    limitations under the License.

  16. -->

  17. <html>

  18. 

  19. <head>

  20. <meta http-equiv="Content-Language" content="en-us">

  21. <link rel="stylesheet" type="text/css" href="../stylesheets/style.css">

  22. <title>Mapper Type</title>

  23. </head>

  24. 

  25. <body>

  26. 

  27. <h2><a name="mapper">Mapping File Names</a></h2>

  28. <p>Some tasks take source files and create target files. Depending on

  29. the task, it may be quite obvious which name a target file will have

  30. (using <a href="../Tasks/javac.html">javac</a>, you know there will be

  31. <code>.class</code> files for your <code>.java</code> files) - in

  32. other cases you may want to specify the target files, either to help

  33. Apache Ant or to get an extra bit of functionality.</p>

  34. <p>While source files are usually specified as <a

  35. href="fileset.html">fileset</a>s, you don't specify target files directly -

  36. instead, you tell Ant how to find the target file(s) for one source file. An

  37. instance of <code>org.apache.tools.ant.util.FileNameMapper</code> is

  38. responsible for this. It constructs target file names based on rules

  39. that can be parameterized with <code>from</code> and <code>to</code>

  40. attributes - the exact meaning of which is implementation-dependent.</p>

  41. <p>These instances are defined in <code>&lt;mapper&gt;</code> elements

  42. with the following attributes:</p>

  43. <table border="1" cellpadding="2" cellspacing="0">

  44.   <tr>

  45.     <td valign="top"><b>Attribute</b></td>

  46.     <td valign="top"><b>Description</b></td>

  47.     <td align="center" valign="top"><b>Required</b></td>

  48.   </tr>

  49.   <tr>

  50.     <td valign="top">type</td>

  51.     <td valign="top">specifies one of the built-in implementations.</td>

  52.     <td rowspan="2" align="center" valign="middle">Exactly one of these</td>

  53.   </tr>

  54.   <tr>

  55.     <td valign="top">classname</td>

  56.     <td valign="top">specifies the implementation by class name.</td>

  57.   </tr>

  58.   <tr>

  59.     <td valign="top">classpath</td>

  60.     <td valign="top">the classpath to use when looking up

  61.       <code>classname</code>.</td>

  62.     <td align="center" valign="top">No</td>

  63.   </tr>

  64.   <tr>

  65.     <td valign="top">classpathref</td>

  66.     <td valign="top">the classpath to use, given as <a

  67.       href="../using.html#references">reference</a> to a path defined elsewhere.</td>

  68.     <td align="center" valign="top">No</td>

  69.   </tr>

  70.   <tr>

  71.     <td valign="top">from</td>

  72.     <td valign="top">the <code>from</code> attribute for the given

  73.       implementation.</td>

  74.     <td align="center" valign="top">Depends on implementation.</td>

  75.   </tr>

  76.   <tr>

  77.     <td valign="top">to</td>

  78.     <td valign="top">the <code>to</code> attribute for the given

  79.       implementation.</td>

  80.     <td align="center" valign="top">Depends on implementation.</td>

  81.   </tr>

  82. </table>

  83. <p>Note that Ant will not automatically convert / or \ characters in

  84. the <code>to</code> and <code>from</code> attributes to the correct

  85. directory separator of your current platform.  If you need to specify

  86. this separator, use <code>${file.separator}</code> instead.

  87.   For the regexpmapper, <code>${file.separator}</code> will not work,

  88. as on windows it is the '\' character, and this is an escape character

  89. for regular expressions, one should use the <code>handledirsep</code> attribute

  90. instead.

  91. </p>

  92. <h3>Parameters specified as nested elements</h3>

  93. <p>The classpath can be specified via a nested

  94. <code>&lt;classpath&gt;</code>, as well - that is,

  95. a <a href="../using.html#path">path</a>-like structure.</p>

  96. <p><b>Since Ant 1.7.0,</b> nested File Mappers can

  97. be supplied via either <CODE>&lt;mapper&gt;</CODE> elements or

  98. <a href="../Tasks/typedef.html"><code>&lt;typedef&gt;</code></a>'d

  99. implementations of <CODE>org.apache.tools.ant.util.FileNameMapper</CODE>.

  100. If nested File Mappers are specified by either means, the mapper will be

  101. implicitly configured as a <a href="#composite-mapper">composite mapper</a>.

  102. </p>

  103. <hr>

  104. <h3>The built-in mapper types are:</h3>

  105. <p>All built-in mappers are case-sensitive.</p>

  106. <p><b>As of Ant 1.7.0,</b> each of the built-in mapper implementation

  107.   types is directly accessible using a specific tagname. This makes it

  108.   possible for filename mappers to support attributes in addition to

  109.   the generally available <i>to</i> and <i>from</i>.<br>

  110.   The <code>&lt;mapper type|classname=&quot;...&quot;&gt;</code> usage

  111.   form remains valid for reasons of backward compatibility.</p>

  112. 

  113.     <!--                                        -->

  114.     <!--             Identity Mapper            -->

  115.     <!--                                        -->

  116. 

  117. <h4><a name="identity-mapper">identity</a></h4>

  118. <p>The target file name is identical to the source file name. Both

  119. <code>to</code> and <code>from</code> will be ignored.</p>

  120. <b>Examples:</b>

  121. <blockquote><pre>

  122. &lt;mapper type=&quot;identity&quot;/&gt;

  123. &lt;identitymapper/&gt;

  124. </pre></blockquote>

  125. <table border="1" cellpadding="2" cellspacing="0">

  126.   <tr>

  127.     <td valign="top"><b>Source file name</b></td>

  128.     <td valign="top"><b>Target file name</b></td>

  129.   </tr>

  130.   <tr>

  131.     <td valign="top"><code>A.java</code></td>

  132.     <td valign="top"><code>A.java</code></td>

  133.   </tr>

  134.   <tr>

  135.     <td valign="top"><code>foo/bar/B.java</code></td>

  136.     <td valign="top"><code>foo/bar/B.java</code></td>

  137.   </tr>

  138.   <tr>

  139.     <td valign="top"><code>C.properties</code></td>

  140.     <td valign="top"><code>C.properties</code></td>

  141.   </tr>

  142.   <tr>

  143.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  144.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  145.   </tr>

  146. </table>

  147. 

  148.     <!--                                        -->

  149.     <!--             Flatten Mapper             -->

  150.     <!--                                        -->

  151. 

  152. <h4><a name="flatten-mapper">flatten</a></h4>

  153. <p>The target file name is identical to the source file name, with all

  154. leading directory information stripped off. Both <code>to</code> and

  155. <code>from</code> will be ignored.</p>

  156. <b>Examples:</b>

  157. <blockquote><pre>

  158. &lt;mapper type=&quot;flatten&quot;/&gt;

  159. &lt;flattenmapper/&gt;

  160. </pre></blockquote>

  161. <table border="1" cellpadding="2" cellspacing="0">

  162.   <tr>

  163.     <td valign="top"><b>Source file name</b></td>

  164.     <td valign="top"><b>Target file name</b></td>

  165.   </tr>

  166.   <tr>

  167.     <td valign="top"><code>A.java</code></td>

  168.     <td valign="top"><code>A.java</code></td>

  169.   </tr>

  170.   <tr>

  171.     <td valign="top"><code>foo/bar/B.java</code></td>

  172.     <td valign="top"><code>B.java</code></td>

  173.   </tr>

  174.   <tr>

  175.     <td valign="top"><code>C.properties</code></td>

  176.     <td valign="top"><code>C.properties</code></td>

  177.   </tr>

  178.   <tr>

  179.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  180.     <td valign="top"><code>A.properties</code></td>

  181.   </tr>

  182. </table>

  183. 

  184.     <!--                                        -->

  185.     <!--             Merge Mapper               -->

  186.     <!--                                        -->

  187. 

  188. <h4><a name="merge-mapper">merge</a></h4>

  189. <p>The target file name will always be the same, as defined by

  190. <code>to</code> - <code>from</code> will be ignored.</p>

  191. <h5>Examples:</h5>

  192. <blockquote><pre>

  193. &lt;mapper type=&quot;merge&quot; to=&quot;archive.tar&quot;/&gt;

  194. &lt;mergemapper to=&quot;archive.tar&quot;/&gt;

  195. </pre></blockquote>

  196. <table border="1" cellpadding="2" cellspacing="0">

  197.   <tr>

  198.     <td valign="top"><b>Source file name</b></td>

  199.     <td valign="top"><b>Target file name</b></td>

  200.   </tr>

  201.   <tr>

  202.     <td valign="top"><code>A.java</code></td>

  203.     <td valign="top"><code>archive.tar</code></td>

  204.   </tr>

  205.   <tr>

  206.     <td valign="top"><code>foo/bar/B.java</code></td>

  207.     <td valign="top"><code>archive.tar</code></td>

  208.   </tr>

  209.   <tr>

  210.     <td valign="top"><code>C.properties</code></td>

  211.     <td valign="top"><code>archive.tar</code></td>

  212.   </tr>

  213.   <tr>

  214.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  215.     <td valign="top"><code>archive.tar</code></td>

  216.   </tr>

  217. </table>

  218. 

  219.     <!--                                        -->

  220.     <!--              Glob Mapper               -->

  221.     <!--                                        -->

  222. 

  223. <h4><a name="glob-mapper">glob</a></h4>

  224. <p>Both <code>to</code> and <code>from</code> are required and define patterns that may

  225. contain at most one <code>*</code>. For each source file that matches

  226. the <code>from</code> pattern, a target file name will be constructed

  227. from the <code>to</code> pattern by substituting the <code>*</code> in

  228. the <code>to</code> pattern with the text that matches the

  229. <code>*</code> in the <code>from</code> pattern. Source file names

  230. that don't match the <code>from</code> pattern will be ignored.</p>

  231. <b>Examples:</b>

  232. <blockquote><pre>

  233. &lt;mapper type=&quot;glob&quot; from=&quot;*.java&quot; to=&quot;*.java.bak&quot;/&gt;

  234. &lt;globmapper from=&quot;*.java&quot; to=&quot;*.java.bak&quot;/&gt;

  235. </pre></blockquote>

  236. <table border="1" cellpadding="2" cellspacing="0">

  237.   <tr>

  238.     <td valign="top"><b>Source file name</b></td>

  239.     <td valign="top"><b>Target file name</b></td>

  240.   </tr>

  241.   <tr>

  242.     <td valign="top"><code>A.java</code></td>

  243.     <td valign="top"><code>A.java.bak</code></td>

  244.   </tr>

  245.   <tr>

  246.     <td valign="top"><code>foo/bar/B.java</code></td>

  247.     <td valign="top"><code>foo/bar/B.java.bak</code></td>

  248.   </tr>

  249.   <tr>

  250.     <td valign="top"><code>C.properties</code></td>

  251.     <td valign="top">ignored</td>

  252.   </tr>

  253.   <tr>

  254.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  255.     <td valign="top">ignored</td>

  256.   </tr>

  257. </table>

  258. <blockquote><pre>

  259. &lt;mapper type=&quot;glob&quot; from=&quot;C*ies&quot; to=&quot;Q*y&quot;/&gt;

  260. &lt;globmapper from=&quot;C*ies&quot; to=&quot;Q*y&quot;/&gt;

  261. </pre></blockquote>

  262. <table border="1" cellpadding="2" cellspacing="0">

  263.   <tr>

  264.     <td valign="top"><b>Source file name</b></td>

  265.     <td valign="top"><b>Target file name</b></td>

  266.   </tr>

  267.   <tr>

  268.     <td valign="top"><code>A.java</code></td>

  269.     <td valign="top">ignored</td>

  270.   </tr>

  271.   <tr>

  272.     <td valign="top"><code>foo/bar/B.java</code></td>

  273.     <td valign="top">ignored</td>

  274.   </tr>

  275.   <tr>

  276.     <td valign="top"><code>C.properties</code></td>

  277.     <td valign="top"><code>Q.property</code></td>

  278.   </tr>

  279.   <tr>

  280.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  281.     <td valign="top"><code>Qlasses/dir/dir2/A.property</code></td>

  282.   </tr>

  283. </table>

  284.   <p>

  285.     The globmapper mapper can take the following extra attributes.

  286.   </p>

  287.   <table border="1" cellpadding="2" cellspacing="0">

  288.     <tr>

  289.       <td valign="top"><b>Attribute</b></td>

  290.       <td valign="top"><b>Description</b></td>

  291.       <td align="center" valign="top"><b>Required</b></td>

  292.     </tr>

  293.     <tr>

  294.       <td valign="top">casesensitive</td>

  295.       <td valign="top">

  296.         If this is false, the mapper will ignore case when matching the glob pattern.

  297.         This attribute can be true or false, the default is true.

  298.       <em>Since Ant 1.6.3.</em>

  299.       </td>

  300.       <td align="center" valign="top">No</td>

  301.     </tr>

  302.     <tr>

  303.       <td valign="top">handledirsep</td>

  304.       <td valign="top">

  305.         If this is specified, the mapper will ignore the difference between the normal

  306.         directory separator characters - \ and /.

  307.         This attribute can be true or false, the default is false.

  308.         This attribute is useful for cross-platform build files.

  309.         <em>Since Ant 1.6.3.</em>

  310.         <td align="center" valign="top">No</td>

  311.       </tr>

  312.     </table>

  313.     <p>

  314.       An example:

  315.     </p>

  316.     <pre>

  317.       &lt;pathconvert property="x" targetos="unix"&gt;

  318.         &lt;path path="Aj.Java"/&gt;

  319.         &lt;mapper&gt;

  320.         &lt;chainedmapper&gt;

  321.           &lt;flattenmapper/&gt;

  322.           &lt;globmapper from="a*.java" to="*.java.bak" casesensitive="no"/&gt;

  323.         &lt;/chainedmapper&gt;

  324.         &lt;/mapper&gt;

  325.       &lt;/pathconvert&gt;

  326.       &lt;echo&gt;x is ${x}&lt;/echo&gt;

  327.     </pre>

  328.     <p>

  329.       will output "x is j.java.bak".

  330.     </p>

  331.     <p>

  332.       and

  333.     </p>

  334.     <pre>

  335.       &lt;pathconvert property="x" targetos="unix"&gt;

  336.         &lt;path path="d/e/f/j.java"/&gt;

  337.         &lt;mapper&gt;

  338.           &lt;globmapper from="${basedir}\d/e\*" to="*" handledirsep="yes"/&gt;

  339.         &lt;/mapper&gt;

  340.       &lt;/pathconvert&gt;

  341.       &lt;echo&gt;x is ${x}&lt;/echo&gt;

  342.     </pre>

  343.     <p>

  344.       will output "x is f/j.java".

  345.     </p>

  346. 

  347. 

  348.     <!--                                        -->

  349.     <!--             RegExp Mapper              -->

  350.     <!--                                        -->

  351. 

  352. <h4><a name="regexp-mapper">regexp</a></h4>

  353. 

  354. <p>Both <code>to</code> and <code>from</code> are required and define

  355. regular expressions. If the source file name (as a whole or in part)

  356. matches the <code>from</code> pattern, the target file name will be

  357. constructed from the

  358. <code>to</code> pattern, using <code>\0</code> to <code>\9</code> as

  359. back-references for the full match (<code>\0</code>) or the matches of

  360. the subexpressions in parentheses.  The <code>to</code> pattern

  361. determines the <strong>whole</strong> file name, so if you wanted to

  362. replace the extension of a file you should not use <code>from="\.old$"

  363. to=".new"</code> but rather <code>from="(.*)\.old$" to="\1.new"</code>

  364. (or rather use a glob mapper in this case).</p>

  365. 

  366. <p>Source files not matching the <code>from</code> pattern will be

  367. ignored.</p>

  368. 

  369. <p>Note that you need to escape a dollar-sign (<code>$</code>) with

  370. another dollar-sign in Ant.</p>

  371. 

  372. <p>The regexp mapper needs a supporting library and an implementation

  373. of <code>org.apache.tools.ant.util.regexp.RegexpMatcher</code> that

  374.   hides the specifics of the library.  <em>Since Ant 1.8.0</em> Ant

  375.   requires Java 1.4 to run, so the implementation based on

  376.   the <code>java.util.regex</code> package will always be available.

  377.   You can still use the now retired Jakarta ORO or Jakarta Regex instead if your

  378.   provide the corresponding jar in your CLASSPATH.</p>

  379. 

  380. <p>For information about using <a

  381. href="http://www.cacas.org/~wes/java/" target="_top">gnu.regexp</a> or <a

  382. href="http://www.crocodile.org/~sts/Rex/" target="_top">gnu.rex</a> with Ant, see <a

  383. href="http://marc.theaimsgroup.com/?l=ant-dev&m=97550753813481&w=2" target="_top">this</a>

  384. article.</p>

  385. 

  386. <p>If you want to use one of the <a href="../install.html#librarydependencies">regular expression

  387.   libraries</a> other than <code>java.util.regex</code> you need to also use

  388.   the corresponding <code>ant-[apache-oro, apache-regexp].jar</code>

  389. from the Ant release you are using.

  390. Make sure, both will be loaded from the same

  391. classpath, that is either put them into your <code>CLASSPATH</code>,

  392. <code>ANT_HOME/lib</code> directory or a nested

  393. <code>&lt;classpath&gt;</code> element of the mapper - you cannot have

  394. <code>ant-[apache-oro, apache-regexp].jar</code> in <code>ANT_HOME/lib</code>

  395.  and the library

  396. in a nested <code>&lt;classpath&gt;</code>.</p>

  397. <p>Ant will choose the regular-expression library based on the

  398. following algorithm:</p>

  399. <ul>

  400. <li>If the system property

  401. <code>ant.regexp.matcherimpl</code> has been set, it is taken as the

  402. name of the class implementing

  403. <code>org.apache.tools.ant.util.regexp.RegexpMatcher</code> that

  404. should be used.</li>

  405. <li>If it has not been set, uses the JDK 1.4 classes.</li>

  406. </ul>

  407. 

  408. <b>Examples:</b>

  409. <blockquote><pre>

  410. &lt;mapper type=&quot;regexp&quot; from=&quot;^(.*)\.java$$&quot; to=&quot;\1.java.bak&quot;/&gt;

  411. &lt;regexpmapper from=&quot;^(.*)\.java$$&quot; to=&quot;\1.java.bak&quot;/&gt;

  412. </pre></blockquote>

  413. <table border="1" cellpadding="2" cellspacing="0">

  414.   <tr>

  415.     <td valign="top"><b>Source file name</b></td>

  416.     <td valign="top"><b>Target file name</b></td>

  417.   </tr>

  418.   <tr>

  419.     <td valign="top"><code>A.java</code></td>

  420.     <td valign="top"><code>A.java.bak</code></td>

  421.   </tr>

  422.   <tr>

  423.     <td valign="top"><code>foo/bar/B.java</code></td>

  424.     <td valign="top"><code>foo/bar/B.java.bak</code></td>

  425.   </tr>

  426.   <tr>

  427.     <td valign="top"><code>C.properties</code></td>

  428.     <td valign="top">ignored</td>

  429.   </tr>

  430.   <tr>

  431.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  432.     <td valign="top">ignored</td>

  433.   </tr>

  434. </table>

  435. <blockquote><pre>

  436. &lt;mapper type=&quot;regexp&quot; from=&quot;^(.*)/([^/]+)/([^/]*)$$&quot; to=&quot;\1/\2/\2-\3&quot;/&gt;

  437. &lt;regexpmapper from=&quot;^(.*)/([^/]+)/([^/]*)$$&quot; to=&quot;\1/\2/\2-\3&quot;/&gt;

  438. </pre></blockquote>

  439. <table border="1" cellpadding="2" cellspacing="0">

  440.   <tr>

  441.     <td valign="top"><b>Source file name</b></td>

  442.     <td valign="top"><b>Target file name</b></td>

  443.   </tr>

  444.   <tr>

  445.     <td valign="top"><code>A.java</code></td>

  446.     <td valign="top">ignored</td>

  447.   </tr>

  448.   <tr>

  449.     <td valign="top"><code>foo/bar/B.java</code></td>

  450.     <td valign="top"><code>foo/bar/bar-B.java</code></td>

  451.   </tr>

  452.   <tr>

  453.     <td valign="top"><code>C.properties</code></td>

  454.     <td valign="top">ignored</td>

  455.   </tr>

  456.   <tr>

  457.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  458.     <td valign="top"><code>Classes/dir/dir2/dir2-A.properties</code></td>

  459.   </tr>

  460. </table>

  461. <blockquote><pre>

  462. &lt;mapper type="regexp" from="^(.*)\.(.*)$$" to="\2.\1"/&gt;

  463. &lt;regexpmapper from="^(.*)\.(.*)$$" to="\2.\1"/&gt;

  464. </pre></blockquote>

  465. <table border="1" cellpadding="2" cellspacing="0">

  466.   <tr>

  467.     <td valign="top"><b>Source file name</b></td>

  468.     <td valign="top"><b>Target file name</b></td>

  469.   </tr>

  470.   <tr>

  471.     <td valign="top"><code>A.java</code></td>

  472.     <td valign="top"><code>java.A</code></td>

  473.   </tr>

  474.   <tr>

  475.     <td valign="top"><code>foo/bar/B.java</code></td>

  476.     <td valign="top"><code>java.foo/bar/B</code></td>

  477.   </tr>

  478.   <tr>

  479.     <td valign="top"><code>C.properties</code></td>

  480.     <td valign="top"><code>properties.C</code></td>

  481.   </tr>

  482.   <tr>

  483.     <td valign="top"><code>Classes/dir/dir2/A.properties</code></td>

  484.     <td valign="top"><code>properties.Classes/dir/dir2/A</code></td>

  485.   </tr>

  486. </table>

  487. <blockquote><pre>

  488. &lt;mapper type="regexp" from="^(.*?)(\$$[^/\\\.]*)?\.class$$" to="\1.java"/&gt;

  489. &lt;regexpmapper from="^(.*?)(\$$[^/\\\.]*)?\.class$$" to="\1.java"/&gt;

  490. </pre></blockquote>

  491. <table border="1" cellpadding="2" cellspacing="0">

  492.   <tr>

  493.     <td valign="top"><b>Source file name</b></td>

  494.     <td valign="top"><b>Target file name</b></td>

  495.   </tr>

  496.   <tr>

  497.     <td valign="top"><code>ClassLoader.class</code></td>

  498.     <td valign="top"><code>ClassLoader.java</code></td>

  499.   </tr>

  500.   <tr>

  501.     <td valign="top"><code>java/lang/ClassLoader.class</code></td>

  502.     <td valign="top"><code>java/lang/ClassLoader.java</code></td>

  503.   </tr>

  504.   <tr>

  505.     <td valign="top"><code>java\lang\ClassLoader$1.class</code></td>

  506.     <td valign="top"><code>java\lang\ClassLoader.java</code></td>

  507.   </tr>

  508.   <tr>

  509.     <td valign="top"><code>java/lang/ClassLoader$foo$1.class</code></td>

  510.     <td valign="top"><code>java/lang/ClassLoader.java</code></td>

  511.   </tr>

  512. </table>

  513.   <p>

  514.     The regexpmapper mapper can take the following extra attributes.

  515.   </p>

  516.   <table border="1" cellpadding="2" cellspacing="0">

  517.     <tr>

  518.       <td valign="top"><b>Attribute</b></td>

  519.       <td valign="top"><b>Description</b></td>

  520.       <td align="center" valign="top"><b>Required</b></td>

  521.     </tr>

  522.     <tr>

  523.       <td valign="top">casesensitive</td>

  524.       <td valign="top">

  525.         If this is false, the mapper will ignore case when matching the pattern.

  526.         This attribute can be true or false, the default is true.

  527.       <em>Since Ant 1.6.3.</em>

  528.       </td>

  529.       <td align="center" valign="top">No</td>

  530.     </tr>

  531.     <tr>

  532.       <td valign="top">handledirsep</td>

  533.       <td valign="top">

  534.         If this is specified, the mapper will treat a \ character in a filename

  535.         as a / for the purposes of matching.

  536.         This attribute can be true or false, the default is false.

  537.         This attribute is useful for cross-platform build files.

  538.         <em>Since Ant 1.6.3.</em>

  539.         <td align="center" valign="top">No</td>

  540.       </tr>

  541.     </table>

  542.     <p>

  543.       An example:

  544.     </p>

  545.     <pre>

  546.       &lt;pathconvert property="x" targetos="unix"&gt;

  547.         &lt;path path="Aj.Java"/&gt;

  548.         &lt;chainedmapper&gt;

  549.           &lt;flattenmapper/&gt;

  550.           &lt;regexpmapper from="a(.*)\.java" to="\1.java.bak" casesensitive="no"/&gt;

  551.         &lt;/chainedmapper&gt;

  552.       &lt;/pathconvert&gt;

  553.       &lt;echo&gt;x is ${x}&lt;/echo&gt;

  554.     </pre>

  555.     <p>

  556.       will output "x is j.java.bak".

  557.     </p>

  558.     <p>

  559.       and

  560.     </p>

  561.     <pre>

  562.     &lt;pathconvert property="hd.prop" targetos="windows"&gt;

  563.       &lt;path path="d\e/f\j.java"/&gt;

  564.       &lt;chainedmapper&gt;

  565.         &lt;regexpmapper from="${basedir}/d/e/(.*)" to="\1" handledirsep="yes"/&gt;

  566.       &lt;/chainedmapper&gt;

  567.     &lt;/pathconvert&gt;

  568.     </pre>

  569.     <p>

  570.       will set <code>hd.prop</code> to "f\j.java".

  571.     </p>

  572. 

  573.     <!--                                        -->

  574.     <!--             Package Mapper             -->

  575.     <!--                                        -->

  576. 

  577. <h4><a name="package-mapper">package</a></h4>

  578. <p>Sharing the same syntax as the <a href="#glob-mapper">glob mapper</a>,

  579. the package mapper replaces

  580. directory separators found in the matched source pattern with dots in the target

  581. pattern placeholder. This mapper is particularly useful in combination

  582. with <code>&lt;uptodate&gt;</code> and <code>&lt;junit&gt;</code> output.</p>

  583. <p>The to and from attributes are both required.</p>

  584. <b>Example:</b>

  585. <blockquote><pre>

  586. &lt;mapper type="package" from="*Test.java" to="TEST-*Test.xml"/&gt;

  587. &lt;packagemapper from="*Test.java" to="TEST-*Test.xml"/&gt;

  588. </pre></blockquote>

  589. <table border="1" cellpadding="2" cellspacing="0">

  590.   <tr>

  591.     <td valign="top"><b>Source file name</b></td>

  592.     <td valign="top"><b>Target file name</b></td>

  593.   </tr>

  594.   <tr>

  595.     <td valign="top"><code>org/apache/tools/ant/util/PackageMapperTest.java</code></td>

  596.     <td valign="top"><code>TEST-org.apache.tools.ant.util.PackageMapperTest.xml</code></td>

  597.   </tr>

  598.   <tr>

  599.     <td valign="top"><code>org/apache/tools/ant/util/Helper.java</code></td>

  600.     <td valign="top">ignored</td>

  601.   </tr>

  602. </table>

  603. 

  604.     <!--                                        -->

  605.     <!--           Unpackage Mapper             -->

  606.     <!--                                        -->

  607. 

  608. <h4><a name="unpackage-mapper">unpackage (since Ant 1.6.0)</a></h4>

  609.   <p>This mapper is the inverse of the <a href="#package-mapper">package</a> mapper.

  610.     It replaces the dots in a package name with directory separators. This

  611.     is useful for matching XML formatter results against their JUnit test

  612.     test cases. The mapper shares the sample syntax

  613.     as the <a href="#glob-mapper">glob mapper</a>.

  614.   </p>

  615. <p>The to and from attributes are both required.</p>

  616. <b>Example:</b>

  617. <blockquote><pre>

  618. &lt;mapper type="unpackage" from="TEST-*Test.xml" to="${test.src.dir}/*Test.java"&gt;

  619. &lt;unpackagemapper from="TEST-*Test.xml" to="${test.src.dir}/*Test.java"&gt;

  620. </pre></blockquote>

  621. <table border="1" cellpadding="2" cellspacing="0">

  622.   <tr>

  623.     <td valign="top"><b>Source file name</b></td>

  624.     <td valign="top"><b>Target file name</b></td>

  625.   </tr>

  626.   <tr>

  627.     <td valign="top"><code>TEST-org.acme.AcmeTest.xml</code></td>

  628.     <td valign="top"><code>${test.src.dir}/org/acme/AcmeTest.java</code></td>

  629.   </tr>

  630. </table>

  631. 

  632.     <!--                                        -->

  633.     <!--           Composite Mapper             -->

  634.     <!--                                        -->

  635. 

  636. <h4><a name="composite-mapper">composite (since Ant 1.7.0)</a></h4>

  637.   <p>This mapper implementation can contain multiple nested mappers.

  638.     File mapping is performed by passing the source filename to each nested

  639.     <code>&lt;mapper&gt;</code> in turn, returning all results.

  640.     The <i>to</i> and <i>from</i> attributes are ignored.</p>

  641.   <p>Starting with Ant 1.8.0 the order of the mapped results is the

  642.     same as the order of the nested mappers; prior to Ant 1.8.0 the

  643.     order has been undefined.</p>

  644. <b>Examples:</b>

  645. <blockquote><pre>

  646. &lt;compositemapper&gt;

  647.   &lt;identitymapper/&gt;

  648.   &lt;packagemapper from="*.java" to="*"/&gt;

  649. &lt;/compositemapper&gt;

  650. </pre></blockquote>

  651. <table border="1" cellpadding="2" cellspacing="0">

  652.   <tr>

  653.     <td valign="top"><b>Source file name</b></td>

  654.     <td valign="top"><b>Target file names</b></td>

  655.   </tr>

  656.   <tr>

  657.     <td valign="center" rowspan="2"><code>foo/bar/A.java</code></td>

  658.     <td valign="top"><code>foo/bar/A.java</code></td>

  659.   </tr>

  660.   <tr>

  661.     <td valign="top"><code>foo.bar.A</code></td>

  662.   </tr>

  663. </table>

  664.   <p>The composite mapper has no corresponding

  665.     <code>&lt;mapper <b>type</b>&gt;</code> attribute.

  666.   </p>

  667. 

  668.     <!--                                        -->

  669.     <!--            Chained Mapper              -->

  670.     <!--                                        -->

  671. 

  672. <h4><a name="chained-mapper">chained (since Ant 1.7.0)</a></h4>

  673.   <p>This mapper implementation can contain multiple nested mappers.

  674.     File mapping is performed by passing the source filename to the first

  675.     nested mapper, its results to the second, and so on.  The target filenames

  676.     generated by the last nested mapper comprise the ultimate results of the

  677.     mapping operation.  The <i>to</i> and <i>from</i> attributes are ignored.</p>

  678. <b>Examples:</b>

  679. <blockquote><pre>

  680. &lt;chainedmapper&gt;

  681.   &lt;flattenmapper/&gt;

  682.   &lt;globmapper from="*" to="new/path/*"/&gt;

  683.   &lt;mapper&gt;

  684.     &lt;globmapper from="*" to="*1"/&gt;

  685.     &lt;globmapper from="*" to="*2"/&gt;

  686.   &lt;/mapper&gt;

  687. &lt;/chainedmapper&gt;

  688. </pre></blockquote>

  689. <table border="1" cellpadding="2" cellspacing="0">

  690.   <tr>

  691.     <td valign="top"><b>Source file name</b></td>

  692.     <td valign="top"><b>Target file names</b></td>

  693.   </tr>

  694.   <tr>

  695.     <td valign="center" rowspan="2"><code>foo/bar/A.java</code></td>

  696.     <td valign="top"><code>new/path/A.java1</code></td>

  697.   </tr>

  698.   <tr>

  699.     <td valign="top"><code>new/path/A.java2</code></td>

  700.   </tr>

  701.   <tr>

  702.     <td valign="center" rowspan="2"><code>boo/far/B.java</code></td>

  703.     <td valign="top"><code>new/path/B.java1</code></td>

  704.   </tr>

  705.   <tr>

  706.     <td valign="top"><code>new/path/B.java2</code></td>

  707.   </tr>

  708. </table>

  709.   <p>The chained mapper has no corresponding

  710.     <code>&lt;mapper <b>type</b>&gt;</code> attribute.

  711.   </p>

  712. 

  713.     <!--                                        -->

  714.     <!--             Filter Mapper              -->

  715.     <!--                                        -->

  716. 

  717. <h4><a name="filter-mapper">filtermapper (since Ant 1.6.3)</a></h4>

  718.     <p>

  719.       This mapper implementation applies a <a href="filterchain.html">filterchain</a>

  720.       to the source file name.

  721.     </p>

  722. <b>Examples:</b>

  723. <blockquote><pre>

  724. &lt;filtermapper&gt;

  725.   &lt;replacestring from="\" to="/"/&gt;

  726. &lt;/filtermapper&gt;

  727. </pre></blockquote>

  728. 

  729. <table border="1" cellpadding="2" cellspacing="0">

  730.   <tr>

  731.     <td valign="top"><b>Source file name</b></td>

  732.     <td valign="top"><b>Target file names</b></td>

  733.   </tr>

  734.   <tr>

  735.     <td valign="center"><code>foo\bar\A.java</code></td>

  736.     <td valign="top"><code>foo/bar/A.java</code></td>

  737.   </tr>

  738. </table>

  739. <blockquote><pre>

  740. &lt;filtermapper&gt;

  741.   &lt;scriptfilter language="beanshell"&gt;

  742.     self.setToken(self.getToken().toUpperCase());

  743.   &lt;/scriptfilter&gt;

  744. &lt;/filtermapper&gt;

  745. </pre></blockquote>

  746. 

  747. <table border="1" cellpadding="2" cellspacing="0">

  748.   <tr>

  749.     <td valign="top"><b>Source file name</b></td>

  750.     <td valign="top"><b>Target file names</b></td>

  751.   </tr>

  752.   <tr>

  753.     <td valign="center"><code>foo\bar\A.java</code></td>

  754.     <td valign="top"><code>FOO\BAR\A.JAVA</code></td>

  755.   </tr>

  756. </table>

  757. 

  758.   <p>The filtermapper has no corresponding

  759.     <code>&lt;mapper <b>type</b>&gt;</code> attribute.

  760.   </p>

  761. 

  762.     <!--                                        -->

  763.     <!--             Script Mapper              -->

  764.     <!--                                        -->

  765. 

  766. <h4><a name="script-mapper">scriptmapper (since Ant 1.7)</a></h4>

  767. <p>

  768. This mapper executes a script written in <a href="http://jakarta.apache.org/bsf" target="_top">Apache BSF</a>

  769. or

  770.   <a href="https://scripting.dev.java.net">JSR 223</a>

  771. supported language, once per file to map.</p>

  772. The script can be declared inline or in a specified file.

  773. </p>

  774. <p>

  775. See the <a href="../Tasks/script.html">Script</a> task for

  776. an explanation of scripts and dependencies.

  777. </p>

  778. 

  779.   <table border="1" cellpadding="2" cellspacing="0">

  780.     <tr>

  781.       <td valign="top"><b>Attribute</b></td>

  782.       <td valign="top"><b>Description</b></td>

  783.       <td align="center" valign="top"><b>Required</b></td>

  784.     </tr>

  785.     <tr>

  786.       <td valign="top">language</td>

  787.       <td valign="top">

  788.         Scripting language

  789.       </td>

  790.       <td align="center" valign="top">Yes</td>

  791.     </tr>

  792.     <tr>

  793.       <td valign="top">manager</td>

  794.       <td valign="top">

  795.         The script engine manager to use.

  796.         See the <a href="../Tasks/script.html">script</a> task

  797.         for using this attribute.

  798.       </td>

  799.       <td valign="top" align="center">No - default is "auto"</td>

  800.     </tr>

  801.     <tr>

  802.       <td valign="top">src</td>

  803.       <td valign="top">

  804.         File containing the script

  805.       </td>

  806.       <td align="center" valign="top">No</td>

  807.     </tr>

  808.     <tr>

  809.       <td valign="top">setbeans</td>

  810.       <td valign="top">whether to have all properties, references and targets as

  811.         global variables in the script.  <em>since Ant 1.8.0</em></td>

  812.       <td valign="top" align="center">No, default is "true".</td>

  813.     </tr>

  814.     <tr>

  815.       <td valign="top">classpath</td>

  816.       <td valign="top">

  817.         The classpath to pass into the script.

  818.       </td>

  819.       <td align="center" valign="top">No</td>

  820.     </tr>

  821.     <tr>

  822.       <td valign="top">classpathref</td>

  823.       <td valign="top">The classpath to use, given as a

  824.         <a href="../using.html#references">reference</a> to a path defined elsewhere.

  825.         <td align="center" valign="top">No</td>

  826.       </tr>

  827.     </table>

  828.   <p>

  829.     This filename mapper can take a nested &lt;classpath&gt; element.

  830.     See the <a href="../Tasks/script.html">script</a> task

  831.     on how to use this element.

  832.   </p>

  833. 

  834. <p>

  835.   <b>Example:</b>

  836. </p>

  837. <blockquote><pre>

  838. &lt;scriptmapper language="javascript"&gt;

  839.   self.addMappedName(source.toUpperCase());

  840.   self.addMappedName(source.toLowerCase());

  841. &lt;/scriptmapper&gt;

  842. </pre></blockquote>

  843. 

  844. <table border="1" cellpadding="2" cellspacing="0">

  845.   <tr>

  846.     <td valign="top"><b>Source file name</b></td>

  847.     <td valign="top"><b>Target file names</b></td>

  848.   </tr>

  849.   <tr>

  850.     <td valign="center" rowspan="2"><code>foo\bar\A.java</code></td>

  851.     <td valign="top"><code>FOO\BAR\A.JAVA</code></td>

  852.   </tr>

  853.   <tr>

  854.     <td valign="top"><code>foo\bar\a.java</code></td>

  855.   </tr>

  856. </table>

  857. 

  858. <p>

  859. To use this mapper, the scripts need access to the source file,

  860. and the ability to return multiple mappings. Here are the relevant beans and

  861. their methods. The script is called once for every source file, with the

  862. list of mapped names reset after every invocation.

  863. 

  864.   <table border="1" cellpadding="2" cellspacing="0">

  865.     <tr>

  866.       <td valign="top"><b>Script bean</b></td>

  867.       <td valign="top"><b>Description</b></td>

  868.     </tr>

  869.     <tr>

  870.       <td valign="top"><code>source: String</code></td>

  871.       <td valign="top">

  872.         The file/path to map

  873.       </td>

  874.     </tr>

  875.     <tr>

  876.       <td valign="top"><code>self</code></td>

  877.       <td valign="top">

  878.         the scriptmapper itself

  879.       </td>

  880.     </tr>

  881.     <tr>

  882.       <td valign="top"><code>self.addMappedName(String name)</code></td>

  883.       <td valign="top">

  884.         Add a new mapping

  885.       </td>

  886.     </tr>

  887.     <tr>

  888.       <td valign="top"><code>self.clear()</code></td>

  889.       <td valign="top">

  890.         Reset the list of files.

  891.       </td>

  892.     </tr>

  893.     </table>

  894. 

  895.   <p>The scriptmapper has no corresponding

  896.     <code>&lt;mapper <b>type</b>&gt;</code> attribute.

  897.   </p>

  898. 

  899. <h4><a name="firstmatch-mapper">firstmatchmapper (since Ant 1.8.0)</a></h4>

  900.     <p>

  901.       This mapper supports an arbitrary number of nested mappers and

  902.       returns the results of the first mapper that matches.  This is

  903.       different from <a href="#composite-mapper">composite mapper</a>

  904.       which collects the results of all matching children.</p>

  905. <b>Examples:</b>

  906. <blockquote><pre>

  907. &lt;firstmatchmapper&gt;

  908.   &lt;globmapper from="*.txt" to="*.bak"/&gt;

  909.   &lt;globmapper from="*A.*" to="*B.*"/&gt;

  910. &lt;/firstmatchmapper&gt;

  911. </pre></blockquote>

  912. 

  913. <table border="1" cellpadding="2" cellspacing="0">

  914.   <tr>

  915.     <td valign="top"><b>Source file name</b></td>

  916.     <td valign="top"><b>Target file names</b></td>

  917.   </tr>

  918.   <tr>

  919.     <td valign="center"><code>foo/bar/A.txt</code></td>

  920.     <td valign="top"><code>foo/bar/A.bak</code></td>

  921.   </tr>

  922.   <tr>

  923.     <td valign="center"><code>foo/bar/A.java</code></td>

  924.     <td valign="top"><code>foo/bar/B.java</code></td>

  925.   </tr>

  926. </table>

  927. 

  928.   <p>The firstmatchmapper has no corresponding

  929.     <code>&lt;mapper <b>type</b>&gt;</code> attribute.

  930.   </p>

  931. 

  932. <h4><a name="cutdirs-mapper">cutdirsmapper (since Ant 1.8.2)</a></h4>

  933. 

  934. <p>This mapper strips a configured number of leading directories from

  935.   the source file name.</p>

  936. 

  937. <b>Examples:</b>

  938. <blockquote><pre>

  939. &lt;cutdirsmapper dirs="1"/&gt;

  940. </pre></blockquote>

  941. 

  942. <table border="1" cellpadding="2" cellspacing="0">

  943.   <tr>

  944.     <td valign="top"><b>Source file name</b></td>

  945.     <td valign="top"><b>Target file names</b></td>

  946.   </tr>

  947.   <tr>

  948.     <td valign="center"><code>foo/bar/A.txt</code></td>

  949.     <td valign="top"><code>bar/A.txt</code></td>

  950.   </tr>

  951. </table>

  952. 

  953. <p>The cutdirsmapper has no

  954. corresponding <code>&lt;mapper <b>type</b>&gt;</code> attribute.</p>

  955. 

  956.   <table border="1" cellpadding="2" cellspacing="0">

  957.     <tr>

  958.       <td valign="top"><b>Attribute</b></td>

  959.       <td valign="top"><b>Description</b></td>

  960.       <td align="center" valign="top"><b>Required</b></td>

  961.     </tr>

  962.     <tr>

  963.       <td valign="top">dirs</td>

  964.       <td valign="top">

  965.         Number of directories to strip (must be a positive number).

  966.       </td>

  967.       <td align="center" valign="top">Yes</td>

  968.     </tr>

  969.   </table>

  970. 

  971. </body>

  972. </html>
Please read the following content carefully:

Dear OpenI User

Thank you for your continuous support to the Openl Qizhi Community AI Collaboration Platform. In order to protect your usage rights and ensure network security, we updated the Openl Qizhi Community AI Collaboration Platform Usage Agreement in January 2024. The updated agreement specifies that users are prohibited from using intranet penetration tools. After you click "Agree and continue", you can continue to use our services. Thank you for your cooperation and understanding.

For more agreement content, please refer to the《Openl Qizhi Community AI Collaboration Platform Usage Agreement》

Agree and continue
Disagree, exit