source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/util/FlatFileNameMapper.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 12.6 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>
7FlatFileNameMapper (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.util.FlatFileNameMapper 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="FlatFileNameMapper (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/util/FileUtils.html" title="class in org.apache.tools.ant.util"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/GlobPatternMapper.html" title="class 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="FlatFileNameMapper.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;<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;FIELD&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.util</FONT>
85<BR>
86Class FlatFileNameMapper</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.util.FlatFileNameMapper</B>
90</PRE>
91<DL>
92<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A></DD>
93</DL>
94<HR>
95<DL>
96<DT>public class <B>FlatFileNameMapper</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A></DL>
97
98<P>
99Implementation of FileNameMapper that always returns the source
100 file name without any leading directory information.
101
102 <p>This is the default FileNameMapper for the copy and move
103 tasks if the flatten attribute has been set.</p>
104<P>
105
106<P>
107<HR>
108
109<P>
110<!-- ======== NESTED CLASS SUMMARY ======== -->
111
112
113<!-- =========== FIELD SUMMARY =========== -->
114
115
116<!-- ======== CONSTRUCTOR SUMMARY ======== -->
117
118<A NAME="constructor_summary"><!-- --></A>
119<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121<TD COLSPAN=2><FONT SIZE="+2">
122<B>Constructor Summary</B></FONT></TD>
123</TR>
124<TR BGCOLOR="white" CLASS="TableRowColor">
125<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/FlatFileNameMapper.html#FlatFileNameMapper()">FlatFileNameMapper</A></B>()</CODE>
126
127<BR>
128&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
129</TR>
130</TABLE>
131&nbsp;
132<!-- ========== METHOD SUMMARY =========== -->
133
134<A NAME="method_summary"><!-- --></A>
135<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
136<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
137<TD COLSPAN=2><FONT SIZE="+2">
138<B>Method Summary</B></FONT></TD>
139</TR>
140<TR BGCOLOR="white" CLASS="TableRowColor">
141<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
142<CODE>&nbsp;java.lang.String[]</CODE></FONT></TD>
143<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/FlatFileNameMapper.html#mapFileName(java.lang.String)">mapFileName</A></B>(java.lang.String&nbsp;sourceFileName)</CODE>
144
145<BR>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an one-element array containing the source file name
147 without any leading directory information.</TD>
148</TR>
149<TR BGCOLOR="white" CLASS="TableRowColor">
150<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
151<CODE>&nbsp;void</CODE></FONT></TD>
152<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/FlatFileNameMapper.html#setFrom(java.lang.String)">setFrom</A></B>(java.lang.String&nbsp;from)</CODE>
153
154<BR>
155&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Ignored.</TD>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159<CODE>&nbsp;void</CODE></FONT></TD>
160<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/util/FlatFileNameMapper.html#setTo(java.lang.String)">setTo</A></B>(java.lang.String&nbsp;to)</CODE>
161
162<BR>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Ignored.</TD>
164</TR>
165</TABLE>
166&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
167<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
168<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
169<TD><B>Methods inherited from class java.lang.Object</B></TD>
170</TR>
171<TR BGCOLOR="white" CLASS="TableRowColor">
172<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
173</TR>
174</TABLE>
175&nbsp;
176<P>
177
178<!-- ============ FIELD DETAIL =========== -->
179
180
181<!-- ========= CONSTRUCTOR DETAIL ======== -->
182
183<A NAME="constructor_detail"><!-- --></A>
184<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
185<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
186<TD COLSPAN=1><FONT SIZE="+2">
187<B>Constructor Detail</B></FONT></TD>
188</TR>
189</TABLE>
190
191<A NAME="FlatFileNameMapper()"><!-- --></A><H3>
192FlatFileNameMapper</H3>
193<PRE>
194public <B>FlatFileNameMapper</B>()</PRE>
195<DL>
196</DL>
197
198<!-- ============ METHOD DETAIL ========== -->
199
200<A NAME="method_detail"><!-- --></A>
201<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
202<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
203<TD COLSPAN=1><FONT SIZE="+2">
204<B>Method Detail</B></FONT></TD>
205</TR>
206</TABLE>
207
208<A NAME="setFrom(java.lang.String)"><!-- --></A><H3>
209setFrom</H3>
210<PRE>
211public void <B>setFrom</B>(java.lang.String&nbsp;from)</PRE>
212<DL>
213<DD>Ignored.
214<P>
215<DD><DL>
216<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html#setFrom(java.lang.String)">setFrom</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A></CODE></DL>
217</DD>
218<DD><DL>
219</DL>
220</DD>
221</DL>
222<HR>
223
224<A NAME="setTo(java.lang.String)"><!-- --></A><H3>
225setTo</H3>
226<PRE>
227public void <B>setTo</B>(java.lang.String&nbsp;to)</PRE>
228<DL>
229<DD>Ignored.
230<P>
231<DD><DL>
232<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html#setTo(java.lang.String)">setTo</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A></CODE></DL>
233</DD>
234<DD><DL>
235</DL>
236</DD>
237</DL>
238<HR>
239
240<A NAME="mapFileName(java.lang.String)"><!-- --></A><H3>
241mapFileName</H3>
242<PRE>
243public java.lang.String[] <B>mapFileName</B>(java.lang.String&nbsp;sourceFileName)</PRE>
244<DL>
245<DD>Returns an one-element array containing the source file name
246 without any leading directory information.
247<P>
248<DD><DL>
249<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html#mapFileName(java.lang.String)">mapFileName</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A></CODE></DL>
250</DD>
251<DD><DL>
252<DT><B>Parameters:</B><DD><CODE>sourceFileName</CODE> - the name of the source file relative to
253 some given basedirectory.</DL>
254</DD>
255</DL>
256<!-- ========= END OF CLASS DATA ========= -->
257<HR>
258
259
260<!-- ======= START OF BOTTOM NAVBAR ====== -->
261<A NAME="navbar_bottom"><!-- --></A>
262<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
263<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
264<TR>
265<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
266<A NAME="navbar_bottom_firstrow"><!-- --></A>
267<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
268 <TR ALIGN="center" VALIGN="top">
269 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
270 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
271 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
272 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
273 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
274 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
275 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
276 </TR>
277</TABLE>
278</TD>
279<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
280</EM>
281</TD>
282</TR>
283
284<TR>
285<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
286&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/FileUtils.html" title="class in org.apache.tools.ant.util"><B>PREV CLASS</B></A>&nbsp;
287&nbsp;<A HREF="../../../../../org/apache/tools/ant/util/GlobPatternMapper.html" title="class in org.apache.tools.ant.util"><B>NEXT CLASS</B></A></FONT></TD>
288<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
289 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
290&nbsp;<A HREF="FlatFileNameMapper.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
291&nbsp;<SCRIPT type="text/javascript">
292 <!--
293 if(window==top) {
294 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
295 }
296 //-->
297</SCRIPT>
298<NOSCRIPT>
299 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
300</NOSCRIPT>
301
302</FONT></TD>
303</TR>
304<TR>
305<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
306 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
307<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
308DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
309</TR>
310</TABLE>
311<A NAME="skip-navbar_bottom"></A>
312<!-- ======== END OF BOTTOM NAVBAR ======= -->
313
314<HR>
315Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
316</BODY>
317</HTML>
Note: See TracBrowser for help on using the repository browser.