source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/util/FileNameMapper.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: 10.7 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:34 NZST 2007 -->
6<TITLE>
7FileNameMapper (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.util.FileNameMapper interface">
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="FileNameMapper (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;PREV CLASS&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/TimeoutObserver.html" title="interface in org.apache.tools.ant.util"><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="FileNameMapper.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;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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.util</FONT>
85<BR>
86Interface FileNameMapper</H2>
87<DL>
88<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/apache/tools/ant/util/ContainerMapper.html" title="class in org.apache.tools.ant.util">ContainerMapper</A>, <A HREF="../../../../../org/apache/tools/ant/types/mappers/FilterMapper.html" title="class in org.apache.tools.ant.types.mappers">FilterMapper</A>, <A HREF="../../../../../org/apache/tools/ant/util/FlatFileNameMapper.html" title="class in org.apache.tools.ant.util">FlatFileNameMapper</A>, <A HREF="../../../../../org/apache/tools/ant/util/GlobPatternMapper.html" title="class in org.apache.tools.ant.util">GlobPatternMapper</A>, <A HREF="../../../../../org/apache/tools/ant/util/IdentityMapper.html" title="class in org.apache.tools.ant.util">IdentityMapper</A>, <A HREF="../../../../../org/apache/tools/ant/util/MergingMapper.html" title="class in org.apache.tools.ant.util">MergingMapper</A>, <A HREF="../../../../../org/apache/tools/ant/util/RegexpPatternMapper.html" title="class in org.apache.tools.ant.util">RegexpPatternMapper</A></DD>
89</DL>
90<HR>
91<DL>
92<DT>public interface <B>FileNameMapper</B></DL>
93
94<P>
95Interface to be used by SourceFileScanner.
96
97 <p>Used to find the name of the target file(s) corresponding to a
98 source file.</p>
99
100 <p>The rule by which the file names are transformed is specified
101 via the setFrom and setTo methods. The exact meaning of these is
102 implementation dependent.</p>
103<P>
104
105<P>
106<HR>
107
108<P>
109<!-- ======== NESTED CLASS SUMMARY ======== -->
110
111
112<!-- =========== FIELD SUMMARY =========== -->
113
114
115<!-- ======== CONSTRUCTOR SUMMARY ======== -->
116
117
118<!-- ========== METHOD SUMMARY =========== -->
119
120<A NAME="method_summary"><!-- --></A>
121<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
122<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
123<TD COLSPAN=2><FONT SIZE="+2">
124<B>Method Summary</B></FONT></TD>
125</TR>
126<TR BGCOLOR="white" CLASS="TableRowColor">
127<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
128<CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
129<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html#mapFileName(java.lang.String)">mapFileName</A></B>(java.lang.String&nbsp;sourceFileName)</CODE>
130
131<BR>
132&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array containing the target filename(s) for the
133 given source file.</TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<CODE>&nbsp;void</CODE></FONT></TD>
138<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html#setFrom(java.lang.String)">setFrom</A></B>(java.lang.String&nbsp;from)</CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the from part of the transformation rule.</TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<CODE>&nbsp;void</CODE></FONT></TD>
146<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html#setTo(java.lang.String)">setTo</A></B>(java.lang.String&nbsp;to)</CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the to part of the transformation rule.</TD>
150</TR>
151</TABLE>
152&nbsp;
153<P>
154
155<!-- ============ FIELD DETAIL =========== -->
156
157
158<!-- ========= CONSTRUCTOR DETAIL ======== -->
159
160
161<!-- ============ METHOD DETAIL ========== -->
162
163<A NAME="method_detail"><!-- --></A>
164<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
165<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
166<TD COLSPAN=1><FONT SIZE="+2">
167<B>Method Detail</B></FONT></TD>
168</TR>
169</TABLE>
170
171<A NAME="setFrom(java.lang.String)"><!-- --></A><H3>
172setFrom</H3>
173<PRE>
174public void <B>setFrom</B>(java.lang.String&nbsp;from)</PRE>
175<DL>
176<DD>Sets the from part of the transformation rule.
177<P>
178<DD><DL>
179</DL>
180</DD>
181</DL>
182<HR>
183
184<A NAME="setTo(java.lang.String)"><!-- --></A><H3>
185setTo</H3>
186<PRE>
187public void <B>setTo</B>(java.lang.String&nbsp;to)</PRE>
188<DL>
189<DD>Sets the to part of the transformation rule.
190<P>
191<DD><DL>
192</DL>
193</DD>
194</DL>
195<HR>
196
197<A NAME="mapFileName(java.lang.String)"><!-- --></A><H3>
198mapFileName</H3>
199<PRE>
200public java.lang.String[] <B>mapFileName</B>(java.lang.String&nbsp;sourceFileName)</PRE>
201<DL>
202<DD>Returns an array containing the target filename(s) for the
203 given source file.
204
205 <p>if the given rule doesn't apply to the source file,
206 implementation must return null. SourceFileScanner will then
207 omit the source file in question.</p>
208<P>
209<DD><DL>
210<DT><B>Parameters:</B><DD><CODE>sourceFileName</CODE> - the name of the source file relative to
211 some given basedirectory.</DL>
212</DD>
213</DL>
214<!-- ========= END OF CLASS DATA ========= -->
215<HR>
216
217
218<!-- ======= START OF BOTTOM NAVBAR ====== -->
219<A NAME="navbar_bottom"><!-- --></A>
220<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
221<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
222<TR>
223<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
224<A NAME="navbar_bottom_firstrow"><!-- --></A>
225<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
226 <TR ALIGN="center" VALIGN="top">
227 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
228 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
229 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
230 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
231 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
232 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
233 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
234 </TR>
235</TABLE>
236</TD>
237<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
238</EM>
239</TD>
240</TR>
241
242<TR>
243<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
244&nbsp;PREV CLASS&nbsp;
245&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/TimeoutObserver.html" title="interface in org.apache.tools.ant.util"><B>NEXT CLASS</B></A></FONT></TD>
246<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
247 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
248&nbsp;<A HREF="FileNameMapper.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
249&nbsp;<SCRIPT type="text/javascript">
250 <!--
251 if(window==top) {
252 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
253 }
254 //-->
255</SCRIPT>
256<NOSCRIPT>
257 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
258</NOSCRIPT>
259
260</FONT></TD>
261</TR>
262<TR>
263<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
264 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
265<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
266DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
267</TR>
268</TABLE>
269<A NAME="skip-navbar_bottom"></A>
270<!-- ======== END OF BOTTOM NAVBAR ======= -->
271
272<HR>
273Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
274</BODY>
275</HTML>
Note: See TracBrowser for help on using the repository browser.