source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/types/Mapper.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 30.4 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:32 NZST 2007 -->
6<TITLE>
7Mapper (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.types.Mapper class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="Mapper (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/FlexInteger.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Mapper.MapperType.html" title="class in org.apache.tools.ant.types"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="Mapper.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.types</FONT>
85<BR>
86Class Mapper</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">org.apache.tools.ant.types.DataType</A>
91 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.types.Mapper</B>
92</PRE>
93<DL>
94<DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable</DD>
95</DL>
96<HR>
97<DL>
98<DT>public class <B>Mapper</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">DataType</A><DT>implements java.lang.Cloneable</DL>
99
100<P>
101Element to define a FileNameMapper.
102<P>
103
104<P>
105<HR>
106
107<P>
108<!-- ======== NESTED CLASS SUMMARY ======== -->
109
110<A NAME="nested_class_summary"><!-- --></A>
111<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
112<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
113<TD COLSPAN=2><FONT SIZE="+2">
114<B>Nested Class Summary</B></FONT></TD>
115</TR>
116<TR BGCOLOR="white" CLASS="TableRowColor">
117<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
118<CODE>static&nbsp;class</CODE></FONT></TD>
119<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.MapperType.html" title="class in org.apache.tools.ant.types">Mapper.MapperType</A></B></CODE>
120
121<BR>
122&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Class as Argument to FileNameMapper.setType.</TD>
123</TR>
124</TABLE>
125&nbsp;
126<!-- =========== FIELD SUMMARY =========== -->
127
128<A NAME="field_summary"><!-- --></A>
129<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
130<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
131<TD COLSPAN=2><FONT SIZE="+2">
132<B>Field Summary</B></FONT></TD>
133</TR>
134<TR BGCOLOR="white" CLASS="TableRowColor">
135<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
136<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
137<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#classname">classname</A></B></CODE>
138
139<BR>
140&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
141</TR>
142<TR BGCOLOR="white" CLASS="TableRowColor">
143<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
144<CODE>protected &nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
145<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#classpath">classpath</A></B></CODE>
146
147<BR>
148&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
149</TR>
150<TR BGCOLOR="white" CLASS="TableRowColor">
151<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
152<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
153<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#from">from</A></B></CODE>
154
155<BR>
156&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
161<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#to">to</A></B></CODE>
162
163<BR>
164&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168<CODE>protected &nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Mapper.MapperType.html" title="class in org.apache.tools.ant.types">Mapper.MapperType</A></CODE></FONT></TD>
169<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#type">type</A></B></CODE>
170
171<BR>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
173</TR>
174</TABLE>
175&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.types.DataType"><!-- --></A>
176<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
177<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
178<TD><B>Fields inherited from class org.apache.tools.ant.types.<A HREF="../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">DataType</A></B></TD>
179</TR>
180<TR BGCOLOR="white" CLASS="TableRowColor">
181<TD><CODE><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#checked">checked</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#description">description</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#ref">ref</A></CODE></TD>
182</TR>
183</TABLE>
184&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
185<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
186<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
187<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
191</TR>
192</TABLE>
193&nbsp;
194<!-- ======== CONSTRUCTOR SUMMARY ======== -->
195
196<A NAME="constructor_summary"><!-- --></A>
197<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
198<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
199<TD COLSPAN=2><FONT SIZE="+2">
200<B>Constructor Summary</B></FONT></TD>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#Mapper(org.apache.tools.ant.Project)">Mapper</A></B>(<A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;p)</CODE>
204
205<BR>
206&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a new <CODE>Mapper</CODE> element.</TD>
207</TR>
208</TABLE>
209&nbsp;
210<!-- ========== METHOD SUMMARY =========== -->
211
212<A NAME="method_summary"><!-- --></A>
213<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
214<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
215<TD COLSPAN=2><FONT SIZE="+2">
216<B>Method Summary</B></FONT></TD>
217</TR>
218<TR BGCOLOR="white" CLASS="TableRowColor">
219<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
220<CODE>&nbsp;void</CODE></FONT></TD>
221<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#add(org.apache.tools.ant.util.FileNameMapper)">add</A></B>(<A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A>&nbsp;fileNameMapper)</CODE>
222
223<BR>
224&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a nested <CODE>FileNameMapper</CODE>.</TD>
225</TR>
226<TR BGCOLOR="white" CLASS="TableRowColor">
227<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228<CODE>&nbsp;void</CODE></FONT></TD>
229<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#addConfiguredMapper(org.apache.tools.ant.types.Mapper)">addConfiguredMapper</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A>&nbsp;mapper)</CODE>
230
231<BR>
232&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a Mapper</TD>
233</TR>
234<TR BGCOLOR="white" CLASS="TableRowColor">
235<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A></CODE></FONT></TD>
237<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#createClasspath()">createClasspath</A></B>()</CODE>
238
239<BR>
240&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the classpath to load the FileNameMapper through (nested element).</TD>
241</TR>
242<TR BGCOLOR="white" CLASS="TableRowColor">
243<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A></CODE></FONT></TD>
245<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#getImplementation()">getImplementation</A></B>()</CODE>
246
247<BR>
248&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a fully configured FileNameMapper implementation.</TD>
249</TR>
250<TR BGCOLOR="white" CLASS="TableRowColor">
251<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
252<CODE>protected &nbsp;java.lang.Class</CODE></FONT></TD>
253<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#getImplementationClass()">getImplementationClass</A></B>()</CODE>
254
255<BR>
256&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the Class object associated with the mapper implementation.</TD>
257</TR>
258<TR BGCOLOR="white" CLASS="TableRowColor">
259<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
260<CODE>protected &nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A></CODE></FONT></TD>
261<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#getRef()">getRef</A></B>()</CODE>
262
263<BR>
264&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs the check for circular references and returns the
265 referenced Mapper.</TD>
266</TR>
267<TR BGCOLOR="white" CLASS="TableRowColor">
268<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269<CODE>&nbsp;void</CODE></FONT></TD>
270<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#setClassname(java.lang.String)">setClassname</A></B>(java.lang.String&nbsp;classname)</CODE>
271
272<BR>
273&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the class name of the FileNameMapper to use.</TD>
274</TR>
275<TR BGCOLOR="white" CLASS="TableRowColor">
276<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
277<CODE>&nbsp;void</CODE></FONT></TD>
278<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#setClasspath(org.apache.tools.ant.types.Path)">setClasspath</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;classpath)</CODE>
279
280<BR>
281&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the classpath to load the FileNameMapper through (attribute).</TD>
282</TR>
283<TR BGCOLOR="white" CLASS="TableRowColor">
284<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
285<CODE>&nbsp;void</CODE></FONT></TD>
286<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#setClasspathRef(org.apache.tools.ant.types.Reference)">setClasspathRef</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)</CODE>
287
288<BR>
289&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the classpath to load the FileNameMapper through via
290 reference (attribute).</TD>
291</TR>
292<TR BGCOLOR="white" CLASS="TableRowColor">
293<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
294<CODE>&nbsp;void</CODE></FONT></TD>
295<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#setFrom(java.lang.String)">setFrom</A></B>(java.lang.String&nbsp;from)</CODE>
296
297<BR>
298&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the argument to FileNameMapper.setFrom</TD>
299</TR>
300<TR BGCOLOR="white" CLASS="TableRowColor">
301<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
302<CODE>&nbsp;void</CODE></FONT></TD>
303<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#setRefid(org.apache.tools.ant.types.Reference)">setRefid</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)</CODE>
304
305<BR>
306&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Make this Mapper instance a reference to another Mapper.</TD>
307</TR>
308<TR BGCOLOR="white" CLASS="TableRowColor">
309<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
310<CODE>&nbsp;void</CODE></FONT></TD>
311<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#setTo(java.lang.String)">setTo</A></B>(java.lang.String&nbsp;to)</CODE>
312
313<BR>
314&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the argument to FileNameMapper.setTo</TD>
315</TR>
316<TR BGCOLOR="white" CLASS="TableRowColor">
317<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
318<CODE>&nbsp;void</CODE></FONT></TD>
319<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/Mapper.html#setType(org.apache.tools.ant.types.Mapper.MapperType)">setType</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/Mapper.MapperType.html" title="class in org.apache.tools.ant.types">Mapper.MapperType</A>&nbsp;type)</CODE>
320
321<BR>
322&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the type of <code>FileNameMapper</code> to use.</TD>
323</TR>
324</TABLE>
325&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.types.DataType"><!-- --></A>
326<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
327<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
328<TD><B>Methods inherited from class org.apache.tools.ant.types.<A HREF="../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">DataType</A></B></TD>
329</TR>
330<TR BGCOLOR="white" CLASS="TableRowColor">
331<TD><CODE><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#checkAttributesAllowed()">checkAttributesAllowed</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#checkChildrenAllowed()">checkChildrenAllowed</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#circularReference()">circularReference</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#dieOnCircularReference(java.util.Stack, org.apache.tools.ant.Project)">dieOnCircularReference</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#getCheckedRef(java.lang.Class, java.lang.String)">getCheckedRef</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#getDescription()">getDescription</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#getRefid()">getRefid</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#isChecked()">isChecked</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#isReference()">isReference</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#noChildrenAllowed()">noChildrenAllowed</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#setChecked(boolean)">setChecked</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../org/apache/tools/ant/types/DataType.html#tooManyAttributes()">tooManyAttributes</A></CODE></TD>
332</TR>
333</TABLE>
334&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
335<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
336<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
337<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
338</TR>
339<TR BGCOLOR="white" CLASS="TableRowColor">
340<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#log(java.lang.String)">log</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
341</TR>
342</TABLE>
343&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
344<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
345<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
346<TD><B>Methods inherited from class java.lang.Object</B></TD>
347</TR>
348<TR BGCOLOR="white" CLASS="TableRowColor">
349<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
350</TR>
351</TABLE>
352&nbsp;
353<P>
354
355<!-- ============ FIELD DETAIL =========== -->
356
357<A NAME="field_detail"><!-- --></A>
358<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
359<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
360<TD COLSPAN=1><FONT SIZE="+2">
361<B>Field Detail</B></FONT></TD>
362</TR>
363</TABLE>
364
365<A NAME="type"><!-- --></A><H3>
366type</H3>
367<PRE>
368protected <A HREF="../../../../../org/apache/tools/ant/types/Mapper.MapperType.html" title="class in org.apache.tools.ant.types">Mapper.MapperType</A> <B>type</B></PRE>
369<DL>
370<DL>
371</DL>
372</DL>
373<HR>
374
375<A NAME="classname"><!-- --></A><H3>
376classname</H3>
377<PRE>
378protected java.lang.String <B>classname</B></PRE>
379<DL>
380<DL>
381</DL>
382</DL>
383<HR>
384
385<A NAME="classpath"><!-- --></A><H3>
386classpath</H3>
387<PRE>
388protected <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>classpath</B></PRE>
389<DL>
390<DL>
391</DL>
392</DL>
393<HR>
394
395<A NAME="from"><!-- --></A><H3>
396from</H3>
397<PRE>
398protected java.lang.String <B>from</B></PRE>
399<DL>
400<DL>
401</DL>
402</DL>
403<HR>
404
405<A NAME="to"><!-- --></A><H3>
406to</H3>
407<PRE>
408protected java.lang.String <B>to</B></PRE>
409<DL>
410<DL>
411</DL>
412</DL>
413
414<!-- ========= CONSTRUCTOR DETAIL ======== -->
415
416<A NAME="constructor_detail"><!-- --></A>
417<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
418<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
419<TD COLSPAN=1><FONT SIZE="+2">
420<B>Constructor Detail</B></FONT></TD>
421</TR>
422</TABLE>
423
424<A NAME="Mapper(org.apache.tools.ant.Project)"><!-- --></A><H3>
425Mapper</H3>
426<PRE>
427public <B>Mapper</B>(<A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;p)</PRE>
428<DL>
429<DD>Construct a new <CODE>Mapper</CODE> element.
430<P>
431<DT><B>Parameters:</B><DD><CODE>p</CODE> - the owning Ant <CODE>Project</CODE>.</DL>
432
433<!-- ============ METHOD DETAIL ========== -->
434
435<A NAME="method_detail"><!-- --></A>
436<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
437<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
438<TD COLSPAN=1><FONT SIZE="+2">
439<B>Method Detail</B></FONT></TD>
440</TR>
441</TABLE>
442
443<A NAME="setType(org.apache.tools.ant.types.Mapper.MapperType)"><!-- --></A><H3>
444setType</H3>
445<PRE>
446public void <B>setType</B>(<A HREF="../../../../../org/apache/tools/ant/types/Mapper.MapperType.html" title="class in org.apache.tools.ant.types">Mapper.MapperType</A>&nbsp;type)</PRE>
447<DL>
448<DD>Set the type of <code>FileNameMapper</code> to use.
449<P>
450<DD><DL>
451</DL>
452</DD>
453<DD><DL>
454<DT><B>Parameters:</B><DD><CODE>type</CODE> - the <CODE>MapperType</CODE> enumerated attribute.</DL>
455</DD>
456</DL>
457<HR>
458
459<A NAME="add(org.apache.tools.ant.util.FileNameMapper)"><!-- --></A><H3>
460add</H3>
461<PRE>
462public void <B>add</B>(<A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A>&nbsp;fileNameMapper)</PRE>
463<DL>
464<DD>Add a nested <CODE>FileNameMapper</CODE>.
465<P>
466<DD><DL>
467</DL>
468</DD>
469<DD><DL>
470<DT><B>Parameters:</B><DD><CODE>fileNameMapper</CODE> - the <CODE>FileNameMapper</CODE> to add.</DL>
471</DD>
472</DL>
473<HR>
474
475<A NAME="addConfiguredMapper(org.apache.tools.ant.types.Mapper)"><!-- --></A><H3>
476addConfiguredMapper</H3>
477<PRE>
478public void <B>addConfiguredMapper</B>(<A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A>&nbsp;mapper)</PRE>
479<DL>
480<DD>Add a Mapper
481<P>
482<DD><DL>
483</DL>
484</DD>
485<DD><DL>
486<DT><B>Parameters:</B><DD><CODE>mapper</CODE> - the mapper to add</DL>
487</DD>
488</DL>
489<HR>
490
491<A NAME="setClassname(java.lang.String)"><!-- --></A><H3>
492setClassname</H3>
493<PRE>
494public void <B>setClassname</B>(java.lang.String&nbsp;classname)</PRE>
495<DL>
496<DD>Set the class name of the FileNameMapper to use.
497<P>
498<DD><DL>
499</DL>
500</DD>
501<DD><DL>
502</DL>
503</DD>
504</DL>
505<HR>
506
507<A NAME="setClasspath(org.apache.tools.ant.types.Path)"><!-- --></A><H3>
508setClasspath</H3>
509<PRE>
510public void <B>setClasspath</B>(<A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;classpath)</PRE>
511<DL>
512<DD>Set the classpath to load the FileNameMapper through (attribute).
513<P>
514<DD><DL>
515</DL>
516</DD>
517<DD><DL>
518</DL>
519</DD>
520</DL>
521<HR>
522
523<A NAME="createClasspath()"><!-- --></A><H3>
524createClasspath</H3>
525<PRE>
526public <A HREF="../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A> <B>createClasspath</B>()</PRE>
527<DL>
528<DD>Set the classpath to load the FileNameMapper through (nested element).
529<P>
530<DD><DL>
531</DL>
532</DD>
533<DD><DL>
534</DL>
535</DD>
536</DL>
537<HR>
538
539<A NAME="setClasspathRef(org.apache.tools.ant.types.Reference)"><!-- --></A><H3>
540setClasspathRef</H3>
541<PRE>
542public void <B>setClasspathRef</B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)</PRE>
543<DL>
544<DD>Set the classpath to load the FileNameMapper through via
545 reference (attribute).
546<P>
547<DD><DL>
548</DL>
549</DD>
550<DD><DL>
551</DL>
552</DD>
553</DL>
554<HR>
555
556<A NAME="setFrom(java.lang.String)"><!-- --></A><H3>
557setFrom</H3>
558<PRE>
559public void <B>setFrom</B>(java.lang.String&nbsp;from)</PRE>
560<DL>
561<DD>Set the argument to FileNameMapper.setFrom
562<P>
563<DD><DL>
564</DL>
565</DD>
566<DD><DL>
567</DL>
568</DD>
569</DL>
570<HR>
571
572<A NAME="setTo(java.lang.String)"><!-- --></A><H3>
573setTo</H3>
574<PRE>
575public void <B>setTo</B>(java.lang.String&nbsp;to)</PRE>
576<DL>
577<DD>Set the argument to FileNameMapper.setTo
578<P>
579<DD><DL>
580</DL>
581</DD>
582<DD><DL>
583</DL>
584</DD>
585</DL>
586<HR>
587
588<A NAME="setRefid(org.apache.tools.ant.types.Reference)"><!-- --></A><H3>
589setRefid</H3>
590<PRE>
591public void <B>setRefid</B>(<A HREF="../../../../../org/apache/tools/ant/types/Reference.html" title="class in org.apache.tools.ant.types">Reference</A>&nbsp;r)
592 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
593<DL>
594<DD>Make this Mapper instance a reference to another Mapper.
595
596 <p>You must not set any other attribute if you make it a
597 reference.</p>
598<P>
599<DD><DL>
600<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/types/DataType.html#setRefid(org.apache.tools.ant.types.Reference)">setRefid</A></CODE> in class <CODE><A HREF="../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">DataType</A></CODE></DL>
601</DD>
602<DD><DL>
603
604<DT><B>Throws:</B>
605<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
606</DD>
607</DL>
608<HR>
609
610<A NAME="getImplementation()"><!-- --></A><H3>
611getImplementation</H3>
612<PRE>
613public <A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A> <B>getImplementation</B>()
614 throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
615<DL>
616<DD>Returns a fully configured FileNameMapper implementation.
617<P>
618<DD><DL>
619</DL>
620</DD>
621<DD><DL>
622
623<DT><B>Throws:</B>
624<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
625</DD>
626</DL>
627<HR>
628
629<A NAME="getImplementationClass()"><!-- --></A><H3>
630getImplementationClass</H3>
631<PRE>
632protected java.lang.Class <B>getImplementationClass</B>()
633 throws java.lang.ClassNotFoundException</PRE>
634<DL>
635<DD>Gets the Class object associated with the mapper implementation.
636<P>
637<DD><DL>
638</DL>
639</DD>
640<DD><DL>
641
642<DT><B>Returns:</B><DD><CODE>Class</CODE>.
643<DT><B>Throws:</B>
644<DD><CODE>java.lang.ClassNotFoundException</CODE></DL>
645</DD>
646</DL>
647<HR>
648
649<A NAME="getRef()"><!-- --></A><H3>
650getRef</H3>
651<PRE>
652protected <A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A> <B>getRef</B>()</PRE>
653<DL>
654<DD>Performs the check for circular references and returns the
655 referenced Mapper.
656<P>
657<DD><DL>
658</DL>
659</DD>
660<DD><DL>
661</DL>
662</DD>
663</DL>
664<!-- ========= END OF CLASS DATA ========= -->
665<HR>
666
667
668<!-- ======= START OF BOTTOM NAVBAR ====== -->
669<A NAME="navbar_bottom"><!-- --></A>
670<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
671<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
672<TR>
673<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
674<A NAME="navbar_bottom_firstrow"><!-- --></A>
675<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
676 <TR ALIGN="center" VALIGN="top">
677 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
678 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
679 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
680 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
681 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
682 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
683 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
684 </TR>
685</TABLE>
686</TD>
687<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
688</EM>
689</TD>
690</TR>
691
692<TR>
693<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
694&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/FlexInteger.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
695&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Mapper.MapperType.html" title="class in org.apache.tools.ant.types"><B>NEXT CLASS</B></A></FONT></TD>
696<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
697 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
698&nbsp;<A HREF="Mapper.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
699&nbsp;<SCRIPT type="text/javascript">
700 <!--
701 if(window==top) {
702 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
703 }
704 //-->
705</SCRIPT>
706<NOSCRIPT>
707 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
708</NOSCRIPT>
709
710</FONT></TD>
711</TR>
712<TR>
713<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
714 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
715<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
716DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
717</TR>
718</TABLE>
719<A NAME="skip-navbar_bottom"></A>
720<!-- ======== END OF BOTTOM NAVBAR ======= -->
721
722<HR>
723Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
724</BODY>
725</HTML>
Note: See TracBrowser for help on using the repository browser.