1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
|
<!DOCTYPE html>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html lang="en">
<head>
<link rel="stylesheet" type="text/css" href="../stylesheets/style.css">
<title>Mapper Type</title>
</head>
<body>
<h2 id="mapper">Mapping File Names</h2>
<p>Some tasks take source files and create target files. Depending on the task, it may be quite
obvious which name a target file will have (using <a href="../Tasks/javac.html">javac</a>, you know
there will be <samp>.class</samp> files for your <samp>.java</samp> files)—in other cases you
may want to specify the target files, either to help Apache Ant or to get an extra bit of
functionality.</p>
<p>While source files are usually specified as <a href="fileset.html">fileset</a>s, you don't
specify target files directly—instead, you tell Ant how to find the target file(s) for one
source file. An instance of <code class="code">org.apache.tools.ant.util.FileNameMapper</code> is
responsible for this. It constructs target file names based on rules that can be parameterized
with <var>from</var> and <var>to</var> attributes—the exact meaning of which is
implementation-dependent.</p>
<p>These instances are defined in <code><mapper></code> elements with the following
attributes:</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>type</td>
<td>specifies one of the built-in implementations.</td>
<td rowspan="2">Exactly one of these</td>
</tr>
<tr>
<td>classname</td>
<td class="left">specifies the implementation by class name.</td>
</tr>
<tr>
<td>classpath</td>
<td>the classpath to use when looking up
<code>classname</code>.</td>
<td>No</td>
</tr>
<tr>
<td>classpathref</td>
<td>the classpath to use, given as <a href="../using.html#references">reference</a> to a
path defined elsewhere.</td>
<td>No</td>
</tr>
<tr>
<td>from</td>
<td>the <code>from</code> attribute for the given implementation.</td>
<td>Depends on implementation</td>
</tr>
<tr>
<td>to</td>
<td>the <code>to</code> attribute for the given implementation.</td>
<td>Depends on implementation</td>
</tr>
</table>
<p>Note that Ant will not automatically convert <q>/</q> or <q>\</q> characters in the <var>to</var>
and <var>from</var> attributes to the correct directory separator of your current platform. If you
need to specify this separator, use <code>${file.separator}</code> instead. For the regexp
mapper, <code>${file.separator}</code> will not work, as on Windows it is the <q>\</q> character,
and this is an escape character for regular expressions, one should use
the <code>handledirsep</code> attribute instead.
</p>
<h3>Parameters specified as nested elements</h3>
<p>The classpath can be specified via a nested <code><classpath></code>, as well—that
is, a <a href="../using.html#path">path</a>-like structure.</p>
<p><em>Since Ant 1.7.0</em>, nested File Mappers can be supplied via
either <code><mapper></code> elements
or <a href="../Tasks/typedef.html"><code><typedef></code></a>'d implementations
of <code class="code">org.apache.tools.ant.util.FileNameMapper</code>. If nested File Mappers are
specified by either means, the mapper will be implicitly configured as
a <a href="#composite-mapper">composite mapper</a>.</p>
<h3>The built-in mapper types</h3>
<p>All built-in mappers are case-sensitive.</p>
<p><em>Since Ant 1.7.0</em>, each of the built-in mapper implementation types is directly accessible
using a specific tagname. This makes it possible for filename mappers to support attributes in
addition to the generally available <var>to</var> and <var>from</var>.<br/>
The <code><mapper <var>type</var>|<var>classname</var>="..."></code> usage form
remains valid for reasons of backward compatibility.</p>
<!-- -->
<!-- Identity Mapper -->
<!-- -->
<h4 id="identity-mapper">identity</h4>
<p>The target file name is identical to the source file name. Both <var>to</var> and <var>from</var>
will be ignored.</p>
<h5>Examples</h5>
<pre>
<mapper type="identity"/>
<identitymapper/></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file name</th>
</tr>
<tr>
<td><code>A.java</code></td>
<td><code>A.java</code></td>
</tr>
<tr>
<td><code>foo/bar/B.java</code></td>
<td><code>foo/bar/B.java</code></td>
</tr>
<tr>
<td><code>C.properties</code></td>
<td><code>C.properties</code></td>
</tr>
<tr>
<td><code>Classes/dir/dir2/A.properties</code></td>
<td><code>Classes/dir/dir2/A.properties</code></td>
</tr>
</table>
<!-- -->
<!-- Flatten Mapper -->
<!-- -->
<h4 id="flatten-mapper">flatten</h4>
<p>The target file name is identical to the source file name, with all leading directory information
stripped off. Both <var>to</var> and <var>from</var> will be ignored.</p>
<h5>Examples</h5>
<pre>
<mapper type="flatten"/>
<flattenmapper/></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file name</th>
</tr>
<tr>
<td><code>A.java</code></td>
<td><code>A.java</code></td>
</tr>
<tr>
<td><code>foo/bar/B.java</code></td>
<td><code>B.java</code></td>
</tr>
<tr>
<td><code>C.properties</code></td>
<td><code>C.properties</code></td>
</tr>
<tr>
<td><code>Classes/dir/dir2/A.properties</code></td>
<td><code>A.properties</code></td>
</tr>
</table>
<!-- -->
<!-- Merge Mapper -->
<!-- -->
<h4 id="merge-mapper">merge</h4>
<p>The target file name will always be the same, as defined by <var>to</var>—<var>from</var>
will be ignored.</p>
<h5>Examples</h5>
<pre>
<mapper type="merge" to="archive.tar"/>
<mergemapper to="archive.tar"/></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file name</th>
</tr>
<tr>
<td><code>A.java</code></td>
<td><code>archive.tar</code></td>
</tr>
<tr>
<td><code>foo/bar/B.java</code></td>
<td><code>archive.tar</code></td>
</tr>
<tr>
<td><code>C.properties</code></td>
<td><code>archive.tar</code></td>
</tr>
<tr>
<td><code>Classes/dir/dir2/A.properties</code></td>
<td><code>archive.tar</code></td>
</tr>
</table>
<!-- -->
<!-- Glob Mapper -->
<!-- -->
<h4 id="glob-mapper">glob</h4>
<p>Both <var>to</var> and <var>from</var> are required and define patterns that may contain at most
one <q>*</q>. For each source file that matches the <var>from</var> pattern, a target file name will
be constructed from the <var>to</var> pattern by substituting the <q>*</q> in the <var>to</var>
pattern with the text that matches the <q>*</q> in the <var>from</var> pattern. Source file names
that don't match the <var>from</var> pattern will be ignored.</p>
<h5>Examples</h5>
<pre>
<mapper type="glob" from="*.java" to="*.java.bak"/>
<globmapper from="*.java" to="*.java.bak"/></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file name</th>
</tr>
<tr>
<td><code>A.java</code></td>
<td><code>A.java.bak</code></td>
</tr>
<tr>
<td><code>foo/bar/B.java</code></td>
<td><code>foo/bar/B.java.bak</code></td>
</tr>
<tr>
<td><code>C.properties</code></td>
<td>ignored</td>
</tr>
<tr>
<td><code>Classes/dir/dir2/A.properties</code></td>
<td>ignored</td>
</tr>
</table>
<pre>
<mapper type="glob" from="C*ies" to="Q*y"/>
<globmapper from="C*ies" to="Q*y"/></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file name</th>
</tr>
<tr>
<td><code>A.java</code></td>
<td>ignored</td>
</tr>
<tr>
<td><code>foo/bar/B.java</code></td>
<td>ignored</td>
</tr>
<tr>
<td><code>C.properties</code></td>
<td><code>Q.property</code></td>
</tr>
<tr>
<td><code>Classes/dir/dir2/A.properties</code></td>
<td><code>Qlasses/dir/dir2/A.property</code></td>
</tr>
</table>
<p>The <code>globmapper</code> mapper can take the following extra attributes.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>casesensitive</td>
<td>
This attribute can be <q>true</q> or <q>false</q>. If this is <q>false</q>, the mapper will
ignore case when matching the glob pattern. <em>Since Ant 1.6.3</em>
</td>
<td>No; default is <q>true</q></td>
</tr>
<tr>
<td>handledirsep</td>
<td>
This attribute can be <q>true</q> or <q>false</q>. If this is specified, the mapper will
ignore the difference between the normal directory separator characters—<q>\</q>
and <q>/</q>. This attribute is useful for cross-platform build files. <em>Since Ant
1.6.3</em>
<td>No; default is <q>false</q></td>
</tr>
</table>
<p>An example:</p>
<pre>
<pathconvert property="x" targetos="unix">
<path path="Aj.Java"/>
<mapper>
<chainedmapper>
<flattenmapper/>
<globmapper from="a*.java" to="*.java.bak" casesensitive="no"/>
</chainedmapper>
</mapper>
</pathconvert>
<echo>x is ${x}</echo></pre>
<p>will output <code>x is j.java.bak</code>, and</p>
<pre>
<pathconvert property="x" targetos="unix">
<path path="d/e/f/j.java"/>
<mapper>
<globmapper from="${basedir}\d/e\*" to="*" handledirsep="yes"/>
</mapper>
</pathconvert>
<echo>x is ${x}</echo></pre>
<p>will output <code>x is f/j.java</code>.</p>
<!-- -->
<!-- RegExp Mapper -->
<!-- -->
<h4 id="regexp-mapper">regexp</h4>
<p>Both <var>to</var> and <var>from</var> are required and define regular expressions. If the source
file name (as a whole or in part) matches the <var>from</var> pattern, the target file name will be
constructed from the <var>to</var> pattern, using <code>\0</code> to <code>\9</code> as
back-references for the full match (<code>\0</code>) or the matches of the subexpressions in
parentheses. The <var>to</var> pattern determines the <strong>whole</strong> file name, so if you
wanted to replace the extension of a file you should not use <code>from="\.old$" to=".new"</code>
but rather <code>from="(.*)\.old$" to="\1.new"</code> (or rather use a glob mapper in this
case).</p>
<p>Source files not matching the <var>from</var> pattern will be ignored.</p>
<p>Note that you need to escape a dollar-sign (<q>$</q>) with another dollar-sign in Ant.</p>
<p>The regexp mapper needs a supporting library and an implementation
of <code class="code">org.apache.tools.ant.util.regexp.RegexpMatcher</code> that hides the specifics
of the library. <em>Since Ant 1.8.0</em>, Java 1.4 or later is required, so the implementation based
on the <code class="code">java.util.regex</code> package is always be available. You can still use
the now retired Jakarta ORO or Jakarta Regex instead if your provide the corresponding jar in
your <code>CLASSPATH</code>.</p>
<p>For information about using <a href="https://savannah.gnu.org/projects/gnu-regexp/"
target="_top">gnu.regexp</a> or <a href="https://github.com/kzn/regex4j/" target="_top">gnu.rex</a>
with Ant, see <a href="https://marc.info/?l=ant-dev&m=97550753813481&w=2" target="_top">this</a>
article. Please keep in mind that <a href="http://tusker.org/regex/regex_benchmark.html"
target="_top">your mileage may vary</a> with different regexp engines.</p>
<p>If you want to use one of the <a href="../install.html#librarydependencies">regular expression
libraries</a> other than <code>java.util.regex</code> you need to also use the
corresponding <samp>ant-[apache-oro, apache-regexp].jar</samp> from the Ant release you are using.
Make sure that both will be loaded from the same classpath, that is either put them into
your <code>CLASSPATH</code>, <samp>ANT_HOME/lib</samp> directory or a
nested <code><classpath></code> element of the mapper—you cannot
have <samp>ant-[apache-oro, apache-regexp].jar</samp> in <samp>ANT_HOME/lib</samp> and the library
in a nested <code><classpath></code>.</p>
<p>Ant will choose the regular expression library based on the following algorithm:</p>
<ul>
<li>If the system property <code>ant.regexp.matcherimpl</code> has been set, it is taken as the name
of the class implementing <code class="code">org.apache.tools.ant.util.regexp.RegexpMatcher</code>
that should be used.</li>
<li>If it has not been set, uses the JDK 1.4 classes.</li>
</ul>
<h5>Examples</h5>
<pre>
<mapper type="regexp" from="^(.*)\.java$$" to="\1.java.bak"/>
<regexpmapper from="^(.*)\.java$$" to="\1.java.bak"/></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file name</th>
</tr>
<tr>
<td><code>A.java</code></td>
<td><code>A.java.bak</code></td>
</tr>
<tr>
<td><code>foo/bar/B.java</code></td>
<td><code>foo/bar/B.java.bak</code></td>
</tr>
<tr>
<td><code>C.properties</code></td>
<td>ignored</td>
</tr>
<tr>
<td><code>Classes/dir/dir2/A.properties</code></td>
<td>ignored</td>
</tr>
</table>
<pre>
<mapper type="regexp" from="^(.*)/([^/]+)/([^/]*)$$" to="\1/\2/\2-\3"/>
<regexpmapper from="^(.*)/([^/]+)/([^/]*)$$" to="\1/\2/\2-\3"/></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file name</th>
</tr>
<tr>
<td><code>A.java</code></td>
<td>ignored</td>
</tr>
<tr>
<td><code>foo/bar/B.java</code></td>
<td><code>foo/bar/bar-B.java</code></td>
</tr>
<tr>
<td><code>C.properties</code></td>
<td>ignored</td>
</tr>
<tr>
<td><code>Classes/dir/dir2/A.properties</code></td>
<td><code>Classes/dir/dir2/dir2-A.properties</code></td>
</tr>
</table>
<pre>
<mapper type="regexp" from="^(.*)\.(.*)$$" to="\2.\1"/>
<regexpmapper from="^(.*)\.(.*)$$" to="\2.\1"/></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file name</th>
</tr>
<tr>
<td><code>A.java</code></td>
<td><code>java.A</code></td>
</tr>
<tr>
<td><code>foo/bar/B.java</code></td>
<td><code>java.foo/bar/B</code></td>
</tr>
<tr>
<td><code>C.properties</code></td>
<td><code>properties.C</code></td>
</tr>
<tr>
<td><code>Classes/dir/dir2/A.properties</code></td>
<td><code>properties.Classes/dir/dir2/A</code></td>
</tr>
</table>
<pre>
<mapper type="regexp" from="^(.*?)(\$$[^/\\\.]*)?\.class$$" to="\1.java"/>
<regexpmapper from="^(.*?)(\$$[^/\\\.]*)?\.class$$" to="\1.java"/></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file name</th>
</tr>
<tr>
<td><code>ClassLoader.class</code></td>
<td><code>ClassLoader.java</code></td>
</tr>
<tr>
<td><code>java/lang/ClassLoader.class</code></td>
<td><code>java/lang/ClassLoader.java</code></td>
</tr>
<tr>
<td><code>java\lang\ClassLoader$1.class</code></td>
<td><code>java\lang\ClassLoader.java</code></td>
</tr>
<tr>
<td><code>java/lang/ClassLoader$foo$1.class</code></td>
<td><code>java/lang/ClassLoader.java</code></td>
</tr>
</table>
<p>The regexp mapper can take the following extra attributes.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>casesensitive</td>
<td>
This attribute can be <q>true</q> or <q>false</q>. If this is <q>false</q>, the mapper will
ignore case when matching the pattern.
<em>Since Ant 1.6.3</em>
</td>
<td>No; default is <q>true</q></td>
</tr>
<tr>
<td>handledirsep</td>
<td>
This attribute can be <q>true</q> or <q>false</q>. If this is specified, the mapper will
treat a <q>\</q> character in a filename as a <q>/</q> for the purposes of matching. This
attribute is useful for cross-platform build files.
<em>Since Ant 1.6.3</em>
<td>No; default is <q>false</q></td>
</tr>
</table>
<p>An example:</p>
<pre>
<pathconvert property="x" targetos="unix">
<path path="Aj.Java"/>
<chainedmapper>
<flattenmapper/>
<regexpmapper from="a(.*)\.java" to="\1.java.bak" casesensitive="no"/>
</chainedmapper>
</pathconvert>
<echo>x is ${x}</echo></pre>
<p>will output <code>x is j.java.bak</code>, and</p>
<pre>
<pathconvert property="hd.prop" targetos="windows">
<path path="d\e/f\j.java"/>
<chainedmapper>
<regexpmapper from="${basedir}/d/e/(.*)" to="\1" handledirsep="yes"/>
</chainedmapper>
</pathconvert></pre>
<p>will set <code>hd.prop</code> to <code>f\j.java</code>.</p>
<!-- -->
<!-- Package Mapper -->
<!-- -->
<h4 id="package-mapper">package</h4>
<p>Sharing the same syntax as the <a href="#glob-mapper">glob mapper</a>, the package mapper
replaces directory separators found in the matched source pattern with dots in the target pattern
placeholder. This mapper is particularly useful in combination with <code><uptodate></code>
and <code><junit></code> output.</p>
<p>The <var>to</var> and <var>from</var> attributes are both required.</p>
<h5>Example</h5>
<pre>
<mapper type="package" from="*Test.java" to="TEST-*Test.xml"/>
<packagemapper from="*Test.java" to="TEST-*Test.xml"/></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file name</th>
</tr>
<tr>
<td><code>org/apache/tools/ant/util/PackageMapperTest.java</code></td>
<td><code>TEST-org.apache.tools.ant.util.PackageMapperTest.xml</code></td>
</tr>
<tr>
<td><code>org/apache/tools/ant/util/Helper.java</code></td>
<td>ignored</td>
</tr>
</table>
<!-- -->
<!-- Unpackage Mapper -->
<!-- -->
<h4 id="unpackage-mapper">unpackage</h4>
<p><em>Since Ant 1.6.0</em></p>
<p>This mapper is the inverse of the <a href="#package-mapper">package</a> mapper. It replaces the
dots in a package name with directory separators. This is useful for matching XML formatter results
against their JUnit test test cases. The mapper shares the sample syntax as
the <a href="#glob-mapper">glob mapper</a>.</p>
<p>The <var>to</var> and <var>from</var> attributes are both required.</p>
<h5>Example</h5>
<pre>
<mapper type="unpackage" from="TEST-*Test.xml" to="${test.src.dir}/*Test.java">
<unpackagemapper from="TEST-*Test.xml" to="${test.src.dir}/*Test.java"></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file name</th>
</tr>
<tr>
<td><code>TEST-org.acme.AcmeTest.xml</code></td>
<td><code>${test.src.dir}/org/acme/AcmeTest.java</code></td>
</tr>
</table>
<!-- -->
<!-- Composite Mapper -->
<!-- -->
<h4 id="composite-mapper">composite</h4>
<p><em>Since Ant 1.7.0</em></p>
<p>This mapper implementation can contain multiple nested mappers. File mapping is performed by
passing the source filename to each nested <code><mapper></code> in turn, returning all
results. The <var>to</var> and <var>from</var> attributes are ignored.</p>
<p><em>Since Ant 1.8.0</em>, the order of the mapped results is the same as the order of the nested
mappers; prior to Ant 1.8.0 the order has been undefined.</p>
<h5>Examples</h5>
<pre>
<compositemapper>
<identitymapper/>
<packagemapper from="*.java" to="*"/>
</compositemapper></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file names</th>
</tr>
<tr>
<td rowspan="2"><code>foo/bar/A.java</code></td>
<td><code>foo/bar/A.java</code></td>
</tr>
<tr>
<td><code>foo.bar.A</code></td>
</tr>
</table>
<p>The composite mapper has no corresponding <code><mapper></code> <var>type</var>
attribute.</p>
<!-- -->
<!-- Chained Mapper -->
<!-- -->
<h4 id="chained-mapper">chained</h4>
<p><em>Since Ant 1.7.0</em></p>
<p>This mapper implementation can contain multiple nested mappers. File mapping is performed by
passing the source filename to the first nested mapper, its results to the second, and so on. The
target filenames generated by the last nested mapper comprise the ultimate results of the mapping
operation. The <var>to</var> and <var>from</var> attributes are ignored.</p>
<h5>Examples</h5>
<pre>
<chainedmapper>
<flattenmapper/>
<globmapper from="*" to="new/path/*"/>
<mapper>
<globmapper from="*" to="*1"/>
<globmapper from="*" to="*2"/>
</mapper>
</chainedmapper></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file names</th>
</tr>
<tr>
<td rowspan="2"><code>foo/bar/A.java</code></td>
<td><code>new/path/A.java1</code></td>
</tr>
<tr>
<td><code>new/path/A.java2</code></td>
</tr>
<tr>
<td rowspan="2"><code>boo/far/B.java</code></td>
<td><code>new/path/B.java1</code></td>
</tr>
<tr>
<td><code>new/path/B.java2</code></td>
</tr>
</table>
<p>The chained mapper has no corresponding <code><mapper></code> <var>type</var>
attribute.</p>
<!-- -->
<!-- Filter Mapper -->
<!-- -->
<h4 id="filter-mapper">filtermapper</h4>
<p><em>Since Ant 1.6.3</em></p>
<p>This mapper implementation applies a <a href="filterchain.html">filterchain</a> to the source
file name.</p>
<h5>Examples</h5>
<pre>
<filtermapper>
<replacestring from="\" to="/"/>
</filtermapper></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file names</th>
</tr>
<tr>
<td><code>foo\bar\A.java</code></td>
<td><code>foo/bar/A.java</code></td>
</tr>
</table>
<pre>
<filtermapper>
<scriptfilter language="beanshell">
self.setToken(self.getToken().toUpperCase());
</scriptfilter>
</filtermapper></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file names</th>
</tr>
<tr>
<td><code>foo\bar\A.java</code></td>
<td><code>FOO\BAR\A.JAVA</code></td>
</tr>
</table>
<p>The filtermapper has no corresponding <code><mapper></code> <var>type</var> attribute.</p>
<!-- -->
<!-- Script Mapper -->
<!-- -->
<h4 id="script-mapper">scriptmapper</h4>
<p><em>Since Ant 1.7</em></p>
<p>This mapper executes a script written in <a href="https://jakarta.apache.org/bsf"
target="_top">Apache BSF</a>
or <a href="https://jcp.org/aboutJava/communityprocess/maintenance/jsr223/223ChangeLog.html"
target="_top">JSR 223</a> supported language, once per file to map.</p>
<p>The script can be declared inline or in a specified file.</p>
<p>See the <a href="../Tasks/script.html">Script</a> task for an explanation of scripts and
dependencies.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>language</td>
<td>Scripting language</td>
<td>Yes</td>
</tr>
<tr>
<td>manager</td>
<td>The script engine manager to use. See the <a href="../Tasks/script.html">script</a> task
for using this attribute.</td>
<td>No; default is <q>auto</q></td>
</tr>
<tr>
<td>src</td>
<td>File containing the script</td>
<td>No</td>
</tr>
<tr>
<td>encoding</td>
<td>The encoding of the script as a file. <em>Since Ant 1.10.2</em></td>
<td>No; defaults to default JVM character encoding</td>
</tr>
<tr>
<td>setbeans</td>
<td>whether to have all properties, references and targets as global variables in the
script. <em>Since Ant 1.8.0</em></td>
<td>No; default is <q>true</q></td>
</tr>
<tr>
<td>classpath</td>
<td>The classpath to pass into the script.</td>
<td>No</td>
</tr>
<tr>
<td>classpathref</td>
<td>The classpath to use, given as a <a href="../using.html#references">reference</a> to a
path defined elsewhere.
<td>No</td>
</tr>
</table>
<p>This filename mapper can take a nested <code><classpath></code> element. See
the <a href="../Tasks/script.html">script</a> task on how to use this element.</p>
<h5>Example</h5>
<pre>
<scriptmapper language="javascript">
self.addMappedName(source.toUpperCase());
self.addMappedName(source.toLowerCase());
</scriptmapper></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file names</th>
</tr>
<tr>
<td rowspan="2"><code>foo\bar\A.java</code></td>
<td><code>FOO\BAR\A.JAVA</code></td>
</tr>
<tr>
<td><code>foo\bar\a.java</code></td>
</tr>
</table>
<p>To use this mapper, the scripts need access to the source file, and the ability to return
multiple mappings. Here are the relevant beans and their methods. The script is called once for
every source file, with the list of mapped names reset after every invocation.</p>
<table>
<tr>
<th scope="col">Script bean</th>
<th scope="col">Description</th>
</tr>
<tr>
<td><code>source: String</code></td>
<td>The file/path to map</td>
</tr>
<tr>
<td><code>self</code></td>
<td>The scriptmapper itself</td>
</tr>
<tr>
<td><code>self.addMappedName(String name)</code></td>
<td>Add a new mapping</td>
</tr>
<tr>
<td><code>self.clear()</code></td>
<td>Reset the list of files</td>
</tr>
</table>
<p>The scriptmapper has no corresponding <code><mapper></code> <var>type</var> attribute.</p>
<h4 id="firstmatch-mapper">firstmatchmapper</h4>
<p><em>Since Ant 1.8.0</em></p>
<p>This mapper supports an arbitrary number of nested mappers and returns the results of the first
mapper that matches. This is different from <a href="#composite-mapper">composite mapper</a> which
collects the results of all matching children.</p>
<h5>Examples</h5>
<pre>
<firstmatchmapper>
<globmapper from="*.txt" to="*.bak"/>
<globmapper from="*A.*" to="*B.*"/>
</firstmatchmapper></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file names</th>
</tr>
<tr>
<td><code>foo/bar/A.txt</code></td>
<td><code>foo/bar/A.bak</code></td>
</tr>
<tr>
<td><code>foo/bar/A.java</code></td>
<td><code>foo/bar/B.java</code></td>
</tr>
</table>
<p>The firstmatchmapper has no corresponding <code><mapper></code> <var>type</var>
attribute.</p>
<h4 id="cutdirs-mapper">cutdirsmapper</h4>
<p><em>Since Ant 1.8.2</em></p>
<p>This mapper strips a configured number of leading directories from the source file name.</p>
<h5>Examples</h5>
<pre><cutdirsmapper dirs="1"/></pre>
<table>
<tr>
<th scope="col">Source file name</th>
<th scope="col">Target file names</th>
</tr>
<tr>
<td><code>foo/bar/A.txt</code></td>
<td><code>bar/A.txt</code></td>
</tr>
</table>
<p>The cutdirsmapper has no corresponding <code><mapper></code> <var>type</var> attribute.</p>
<table class="attr">
<tr>
<th scope="col">Attribute</th>
<th scope="col">Description</th>
<th scope="col">Required</th>
</tr>
<tr>
<td>dirs</td>
<td>Number of directories to strip (must be a positive number).</td>
<td>Yes</td>
</tr>
</table>
</body>
</html>
|
