Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

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

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago
initial import of LiRK3
File size: 51.3 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:18 NZST 2007 -->
6	<TITLE>
7	Copy (Apache Ant API)
8	</TITLE>
9
10	<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.Copy class">
11
12	<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
13
14	<SCRIPT type="text/javascript">
15	function windowTitle()
16	{
17	parent.document.title="Copy (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> </TD>
36	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
37	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
38	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
39	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
40	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
41	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </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	<A HREF="../../../../../org/apache/tools/ant/taskdefs/ConditionTask.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>
53	<A HREF="../../../../../org/apache/tools/ant/taskdefs/Copydir.html" title="class in org.apache.tools.ant.taskdefs"><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>
56	<A HREF="Copy.html" target="_top"><B>NO FRAMES</B></A>
57	<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: NESTED \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
73	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <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">
84	org.apache.tools.ant.taskdefs</FONT>
85	<BR>
86	Class Copy</H2>
87	<PRE>
88	java.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/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</A>
91	<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.Copy</B>
92	</PRE>
93	<DL>
94	<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/tools/ant/taskdefs/Move.html" title="class in org.apache.tools.ant.taskdefs">Move</A>, <A HREF="../../../../../org/apache/tools/ant/taskdefs/Sync.MyCopy.html" title="class in org.apache.tools.ant.taskdefs">Sync.MyCopy</A></DD>
95	</DL>
96	<HR>
97	<DL>
98	<DT>public class <B>Copy</B><DT>extends <A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></DL>
99
100	<P>
101	Copies a file or directory to a new file
102	or directory. Files are only copied if the source file is newer
103	than the destination file, or when the destination file does not
104	exist. It is possible to explicitly overwrite existing files.</p>
105
106	<p>This implementation is based on Arnout Kuiper's initial design
107	document, the following mailing list discussions, and the
108	copyfile/copydir tasks.</p>
109	<P>
110
111	<P>
112	<DL>
113	<DT><B>Since:</B></DT>
114	<DD>Ant 1.2</DD>
115	</DL>
116	<HR>
117
118	<P>
119	<!-- ======== NESTED CLASS SUMMARY ======== -->
120
121
122	<!-- =========== FIELD SUMMARY =========== -->
123
124	<A NAME="field_summary"><!-- --></A>
125	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
126	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
127	<TD COLSPAN=2><FONT SIZE="+2">
128	<B>Field Summary</B></FONT></TD>
129	</TR>
130	<TR BGCOLOR="white" CLASS="TableRowColor">
131	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
132	<CODE>protected  java.util.Hashtable</CODE></FONT></TD>
133	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#completeDirMap">completeDirMap</A></B></CODE>
134
135	<BR>
136	</TD>
137	</TR>
138	<TR BGCOLOR="white" CLASS="TableRowColor">
139	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
140	<CODE>protected  java.io.File</CODE></FONT></TD>
141	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#destDir">destDir</A></B></CODE>
142
143	<BR>
144	</TD>
145	</TR>
146	<TR BGCOLOR="white" CLASS="TableRowColor">
147	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
148	<CODE>protected  java.io.File</CODE></FONT></TD>
149	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#destFile">destFile</A></B></CODE>
150
151	<BR>
152	</TD>
153	</TR>
154	<TR BGCOLOR="white" CLASS="TableRowColor">
155	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
156	<CODE>protected  java.util.Hashtable</CODE></FONT></TD>
157	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#dirCopyMap">dirCopyMap</A></B></CODE>
158
159	<BR>
160	</TD>
161	</TR>
162	<TR BGCOLOR="white" CLASS="TableRowColor">
163	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
164	<CODE>protected  boolean</CODE></FONT></TD>
165	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#failonerror">failonerror</A></B></CODE>
166
167	<BR>
168	</TD>
169	</TR>
170	<TR BGCOLOR="white" CLASS="TableRowColor">
171	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172	<CODE>protected  java.io.File</CODE></FONT></TD>
173	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#file">file</A></B></CODE>
174
175	<BR>
176	</TD>
177	</TR>
178	<TR BGCOLOR="white" CLASS="TableRowColor">
179	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
180	<CODE>protected  java.util.Hashtable</CODE></FONT></TD>
181	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#fileCopyMap">fileCopyMap</A></B></CODE>
182
183	<BR>
184	</TD>
185	</TR>
186	<TR BGCOLOR="white" CLASS="TableRowColor">
187	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188	<CODE>protected  java.util.Vector</CODE></FONT></TD>
189	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#filesets">filesets</A></B></CODE>
190
191	<BR>
192	</TD>
193	</TR>
194	<TR BGCOLOR="white" CLASS="TableRowColor">
195	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
196	<CODE>protected  <A HREF="../../../../../org/apache/tools/ant/util/FileUtils.html" title="class in org.apache.tools.ant.util">FileUtils</A></CODE></FONT></TD>
197	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#fileUtils">fileUtils</A></B></CODE>
198
199	<BR>
200	</TD>
201	</TR>
202	<TR BGCOLOR="white" CLASS="TableRowColor">
203	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204	<CODE>protected  boolean</CODE></FONT></TD>
205	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#filtering">filtering</A></B></CODE>
206
207	<BR>
208	</TD>
209	</TR>
210	<TR BGCOLOR="white" CLASS="TableRowColor">
211	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
212	<CODE>protected  boolean</CODE></FONT></TD>
213	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#flatten">flatten</A></B></CODE>
214
215	<BR>
216	</TD>
217	</TR>
218	<TR BGCOLOR="white" CLASS="TableRowColor">
219	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
220	<CODE>protected  boolean</CODE></FONT></TD>
221	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#forceOverwrite">forceOverwrite</A></B></CODE>
222
223	<BR>
224	</TD>
225	</TR>
226	<TR BGCOLOR="white" CLASS="TableRowColor">
227	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228	<CODE>protected  boolean</CODE></FONT></TD>
229	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#includeEmpty">includeEmpty</A></B></CODE>
230
231	<BR>
232	</TD>
233	</TR>
234	<TR BGCOLOR="white" CLASS="TableRowColor">
235	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236	<CODE>protected  <A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A></CODE></FONT></TD>
237	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#mapperElement">mapperElement</A></B></CODE>
238
239	<BR>
240	</TD>
241	</TR>
242	<TR BGCOLOR="white" CLASS="TableRowColor">
243	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244	<CODE>protected  boolean</CODE></FONT></TD>
245	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#preserveLastModified">preserveLastModified</A></B></CODE>
246
247	<BR>
248	</TD>
249	</TR>
250	<TR BGCOLOR="white" CLASS="TableRowColor">
251	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
252	<CODE>protected  int</CODE></FONT></TD>
253	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#verbosity">verbosity</A></B></CODE>
254
255	<BR>
256	</TD>
257	</TR>
258	</TABLE>
259	<A NAME="fields_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
260	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
261	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
262	<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
263	</TR>
264	<TR BGCOLOR="white" CLASS="TableRowColor">
265	<TD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#description">description</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#location">location</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#target">target</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#taskName">taskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#taskType">taskType</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#wrapper">wrapper</A></CODE></TD>
266	</TR>
267	</TABLE>
268	<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
269	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
270	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
271	<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>
272	</TR>
273	<TR BGCOLOR="white" CLASS="TableRowColor">
274	<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
275	</TR>
276	</TABLE>
277
278	<!-- ======== CONSTRUCTOR SUMMARY ======== -->
279
280	<A NAME="constructor_summary"><!-- --></A>
281	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
282	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
283	<TD COLSPAN=2><FONT SIZE="+2">
284	<B>Constructor Summary</B></FONT></TD>
285	</TR>
286	<TR BGCOLOR="white" CLASS="TableRowColor">
287	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#Copy()">Copy</A></B>()</CODE>
288
289	<BR>
290	Copy task constructor.</TD>
291	</TR>
292	</TABLE>
293
294	<!-- ========== METHOD SUMMARY =========== -->
295
296	<A NAME="method_summary"><!-- --></A>
297	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
298	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
299	<TD COLSPAN=2><FONT SIZE="+2">
300	<B>Method Summary</B></FONT></TD>
301	</TR>
302	<TR BGCOLOR="white" CLASS="TableRowColor">
303	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
304	<CODE> void</CODE></FONT></TD>
305	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.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> fileNameMapper)</CODE>
306
307	<BR>
308	A nested filenamemapper</TD>
309	</TR>
310	<TR BGCOLOR="white" CLASS="TableRowColor">
311	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
312	<CODE> void</CODE></FONT></TD>
313	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#addFileset(org.apache.tools.ant.types.FileSet)">addFileset</A></B>(<A HREF="../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A> set)</CODE>
314
315	<BR>
316	Adds a set of files to copy.</TD>
317	</TR>
318	<TR BGCOLOR="white" CLASS="TableRowColor">
319	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
320	<CODE>protected  void</CODE></FONT></TD>
321	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#buildMap(java.io.File, java.io.File, java.lang.String[], org.apache.tools.ant.util.FileNameMapper, java.util.Hashtable)">buildMap</A></B>(java.io.File fromDir,
322	java.io.File toDir,
323	java.lang.String[] names,
324	<A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A> mapper,
325	java.util.Hashtable map)</CODE>
326
327	<BR>
328	Add to a map of files/directories to copy</TD>
329	</TR>
330	<TR BGCOLOR="white" CLASS="TableRowColor">
331	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
332	<CODE> <A HREF="../../../../../org/apache/tools/ant/types/FilterChain.html" title="class in org.apache.tools.ant.types">FilterChain</A></CODE></FONT></TD>
333	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#createFilterChain()">createFilterChain</A></B>()</CODE>
334
335	<BR>
336	Adds a FilterChain.</TD>
337	</TR>
338	<TR BGCOLOR="white" CLASS="TableRowColor">
339	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
340	<CODE> <A HREF="../../../../../org/apache/tools/ant/types/FilterSet.html" title="class in org.apache.tools.ant.types">FilterSet</A></CODE></FONT></TD>
341	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#createFilterSet()">createFilterSet</A></B>()</CODE>
342
343	<BR>
344	Adds a filterset.</TD>
345	</TR>
346	<TR BGCOLOR="white" CLASS="TableRowColor">
347	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
348	<CODE> <A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A></CODE></FONT></TD>
349	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#createMapper()">createMapper</A></B>()</CODE>
350
351	<BR>
352	Defines the mapper to map source to destination files.</TD>
353	</TR>
354	<TR BGCOLOR="white" CLASS="TableRowColor">
355	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
356	<CODE>protected  void</CODE></FONT></TD>
357	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#doFileOperations()">doFileOperations</A></B>()</CODE>
358
359	<BR>
360	Actually does the file (and possibly empty directory) copies.</TD>
361	</TR>
362	<TR BGCOLOR="white" CLASS="TableRowColor">
363	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
364	<CODE> void</CODE></FONT></TD>
365	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#execute()">execute</A></B>()</CODE>
366
367	<BR>
368	Performs the copy operation.</TD>
369	</TR>
370	<TR BGCOLOR="white" CLASS="TableRowColor">
371	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
372	<CODE> java.lang.String</CODE></FONT></TD>
373	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#getEncoding()">getEncoding</A></B>()</CODE>
374
375	<BR>
376	</TD>
377	</TR>
378	<TR BGCOLOR="white" CLASS="TableRowColor">
379	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
380	<CODE>protected  <A HREF="../../../../../org/apache/tools/ant/util/FileUtils.html" title="class in org.apache.tools.ant.util">FileUtils</A></CODE></FONT></TD>
381	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#getFileUtils()">getFileUtils</A></B>()</CODE>
382
383	<BR>
384	</TD>
385	</TR>
386	<TR BGCOLOR="white" CLASS="TableRowColor">
387	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
388	<CODE>protected  java.util.Vector</CODE></FONT></TD>
389	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#getFilterChains()">getFilterChains</A></B>()</CODE>
390
391	<BR>
392	Get the filterchains being applied to this operation.</TD>
393	</TR>
394	<TR BGCOLOR="white" CLASS="TableRowColor">
395	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
396	<CODE>protected  java.util.Vector</CODE></FONT></TD>
397	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#getFilterSets()">getFilterSets</A></B>()</CODE>
398
399	<BR>
400	Get the filtersets being applied to this operation.</TD>
401	</TR>
402	<TR BGCOLOR="white" CLASS="TableRowColor">
403	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
404	<CODE> java.lang.String</CODE></FONT></TD>
405	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#getOutputEncoding()">getOutputEncoding</A></B>()</CODE>
406
407	<BR>
408	</TD>
409	</TR>
410	<TR BGCOLOR="white" CLASS="TableRowColor">
411	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
412	<CODE> boolean</CODE></FONT></TD>
413	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#getPreserveLastModified()">getPreserveLastModified</A></B>()</CODE>
414
415	<BR>
416	Whether to give the copied files the same last modified time as
417	the original files.</TD>
418	</TR>
419	<TR BGCOLOR="white" CLASS="TableRowColor">
420	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
421	<CODE> boolean</CODE></FONT></TD>
422	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#isEnableMultipleMapping()">isEnableMultipleMapping</A></B>()</CODE>
423
424	<BR>
425	</TD>
426	</TR>
427	<TR BGCOLOR="white" CLASS="TableRowColor">
428	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
429	<CODE>protected  void</CODE></FONT></TD>
430	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#scan(java.io.File, java.io.File, java.lang.String[], java.lang.String[])">scan</A></B>(java.io.File fromDir,
431	java.io.File toDir,
432	java.lang.String[] files,
433	java.lang.String[] dirs)</CODE>
434
435	<BR>
436	Compares source files to destination files to see if they should be
437	copied.</TD>
438	</TR>
439	<TR BGCOLOR="white" CLASS="TableRowColor">
440	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
441	<CODE> void</CODE></FONT></TD>
442	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setEnableMultipleMappings(boolean)">setEnableMultipleMappings</A></B>(boolean enableMultipleMappings)</CODE>
443
444	<BR>
445	Attribute to handle mappers that return multiple
446	mappings for a given source path.</TD>
447	</TR>
448	<TR BGCOLOR="white" CLASS="TableRowColor">
449	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
450	<CODE> void</CODE></FONT></TD>
451	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setEncoding(java.lang.String)">setEncoding</A></B>(java.lang.String encoding)</CODE>
452
453	<BR>
454	Sets the character encoding</TD>
455	</TR>
456	<TR BGCOLOR="white" CLASS="TableRowColor">
457	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
458	<CODE> void</CODE></FONT></TD>
459	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setFailOnError(boolean)">setFailOnError</A></B>(boolean failonerror)</CODE>
460
461	<BR>
462	If false, note errors to the output but keep going.</TD>
463	</TR>
464	<TR BGCOLOR="white" CLASS="TableRowColor">
465	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
466	<CODE> void</CODE></FONT></TD>
467	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setFile(java.io.File)">setFile</A></B>(java.io.File file)</CODE>
468
469	<BR>
470	Sets a single source file to copy.</TD>
471	</TR>
472	<TR BGCOLOR="white" CLASS="TableRowColor">
473	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
474	<CODE> void</CODE></FONT></TD>
475	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setFiltering(boolean)">setFiltering</A></B>(boolean filtering)</CODE>
476
477	<BR>
478	If true, enables filtering.</TD>
479	</TR>
480	<TR BGCOLOR="white" CLASS="TableRowColor">
481	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
482	<CODE> void</CODE></FONT></TD>
483	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setFlatten(boolean)">setFlatten</A></B>(boolean flatten)</CODE>
484
485	<BR>
486	When copying directory trees, the files can be "flattened"
487	into a single directory.</TD>
488	</TR>
489	<TR BGCOLOR="white" CLASS="TableRowColor">
490	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
491	<CODE> void</CODE></FONT></TD>
492	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setGranularity(long)">setGranularity</A></B>(long granularity)</CODE>
493
494	<BR>
495	The number of milliseconds leeway to give before deciding a
496	target is out of date.</TD>
497	</TR>
498	<TR BGCOLOR="white" CLASS="TableRowColor">
499	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
500	<CODE> void</CODE></FONT></TD>
501	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setIncludeEmptyDirs(boolean)">setIncludeEmptyDirs</A></B>(boolean includeEmpty)</CODE>
502
503	<BR>
504	Used to copy empty directories.</TD>
505	</TR>
506	<TR BGCOLOR="white" CLASS="TableRowColor">
507	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
508	<CODE> void</CODE></FONT></TD>
509	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setOutputEncoding(java.lang.String)">setOutputEncoding</A></B>(java.lang.String encoding)</CODE>
510
511	<BR>
512	Sets the character encoding for output files.</TD>
513	</TR>
514	<TR BGCOLOR="white" CLASS="TableRowColor">
515	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
516	<CODE> void</CODE></FONT></TD>
517	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setOverwrite(boolean)">setOverwrite</A></B>(boolean overwrite)</CODE>
518
519	<BR>
520	Overwrite any existing destination file(s).</TD>
521	</TR>
522	<TR BGCOLOR="white" CLASS="TableRowColor">
523	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
524	<CODE> void</CODE></FONT></TD>
525	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setPreserveLastModified(boolean)">setPreserveLastModified</A></B>(boolean preserve)</CODE>
526
527	<BR>
528	Give the copied files the same last modified time as the original files.</TD>
529	</TR>
530	<TR BGCOLOR="white" CLASS="TableRowColor">
531	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
532	<CODE> void</CODE></FONT></TD>
533	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setPreserveLastModified(java.lang.String)">setPreserveLastModified</A></B>(java.lang.String preserve)</CODE>
534
535	<BR>
536	<B>Deprecated.</B> <I>setPreserveLastModified(String) has been deprecated and
537	replaced with setPreserveLastModified(boolean) to
538	consistently let the Introspection mechanism work.</I></TD>
539	</TR>
540	<TR BGCOLOR="white" CLASS="TableRowColor">
541	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
542	<CODE> void</CODE></FONT></TD>
543	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setTodir(java.io.File)">setTodir</A></B>(java.io.File destDir)</CODE>
544
545	<BR>
546	Sets the destination directory.</TD>
547	</TR>
548	<TR BGCOLOR="white" CLASS="TableRowColor">
549	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
550	<CODE> void</CODE></FONT></TD>
551	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setTofile(java.io.File)">setTofile</A></B>(java.io.File destFile)</CODE>
552
553	<BR>
554	Sets the destination file.</TD>
555	</TR>
556	<TR BGCOLOR="white" CLASS="TableRowColor">
557	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
558	<CODE> void</CODE></FONT></TD>
559	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setVerbose(boolean)">setVerbose</A></B>(boolean verbose)</CODE>
560
561	<BR>
562	Used to force listing of all names of copied files.</TD>
563	</TR>
564	<TR BGCOLOR="white" CLASS="TableRowColor">
565	<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
566	<CODE>protected  void</CODE></FONT></TD>
567	<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/taskdefs/Copy.html#validateAttributes()">validateAttributes</A></B>()</CODE>
568
569	<BR>
570	Ensure we have a consistent and legal set of attributes, and set
571	any internal flags necessary based on different combinations
572	of attributes.</TD>
573	</TR>
574	</TABLE>
575	<A NAME="methods_inherited_from_class_org.apache.tools.ant.Task"><!-- --></A>
576	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
577	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
578	<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></B></TD>
579	</TR>
580	<TR BGCOLOR="white" CLASS="TableRowColor">
581	<TD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#getDescription()">getDescription</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getLocation()">getLocation</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getOwningTarget()">getOwningTarget</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getRuntimeConfigurableWrapper()">getRuntimeConfigurableWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getTaskName()">getTaskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getTaskType()">getTaskType</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#getWrapper()">getWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleErrorFlush(java.lang.String)">handleErrorFlush</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleErrorOutput(java.lang.String)">handleErrorOutput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleFlush(java.lang.String)">handleFlush</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleInput(byte[], int, int)">handleInput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#handleOutput(java.lang.String)">handleOutput</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#init()">init</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#isInvalid()">isInvalid</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String)">log</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#maybeConfigure()">maybeConfigure</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#perform()">perform</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#reconfigure()">reconfigure</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setLocation(org.apache.tools.ant.Location)">setLocation</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setOwningTarget(org.apache.tools.ant.Target)">setOwningTarget</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable)">setRuntimeConfigurableWrapper</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setTaskName(java.lang.String)">setTaskName</A>, <A HREF="../../../../../org/apache/tools/ant/Task.html#setTaskType(java.lang.String)">setTaskType</A></CODE></TD>
582	</TR>
583	</TABLE>
584	<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
585	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
586	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
587	<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>
588	</TR>
589	<TR BGCOLOR="white" CLASS="TableRowColor">
590	<TD><CODE><A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
591	</TR>
592	</TABLE>
593	<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
594	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
595	<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
596	<TD><B>Methods inherited from class java.lang.Object</B></TD>
597	</TR>
598	<TR BGCOLOR="white" CLASS="TableRowColor">
599	<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
600	</TR>
601	</TABLE>
602
603	<P>
604
605	<!-- ============ FIELD DETAIL =========== -->
606
607	<A NAME="field_detail"><!-- --></A>
608	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
609	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
610	<TD COLSPAN=1><FONT SIZE="+2">
611	<B>Field Detail</B></FONT></TD>
612	</TR>
613	</TABLE>
614
615	<A NAME="file"><!-- --></A><H3>
616	file</H3>
617	<PRE>
618	protected java.io.File <B>file</B></PRE>
619	<DL>
620	<DL>
621	</DL>
622	</DL>
623	<HR>
624
625	<A NAME="destFile"><!-- --></A><H3>
626	destFile</H3>
627	<PRE>
628	protected java.io.File <B>destFile</B></PRE>
629	<DL>
630	<DL>
631	</DL>
632	</DL>
633	<HR>
634
635	<A NAME="destDir"><!-- --></A><H3>
636	destDir</H3>
637	<PRE>
638	protected java.io.File <B>destDir</B></PRE>
639	<DL>
640	<DL>
641	</DL>
642	</DL>
643	<HR>
644
645	<A NAME="filesets"><!-- --></A><H3>
646	filesets</H3>
647	<PRE>
648	protected java.util.Vector <B>filesets</B></PRE>
649	<DL>
650	<DL>
651	</DL>
652	</DL>
653	<HR>
654
655	<A NAME="filtering"><!-- --></A><H3>
656	filtering</H3>
657	<PRE>
658	protected boolean <B>filtering</B></PRE>
659	<DL>
660	<DL>
661	</DL>
662	</DL>
663	<HR>
664
665	<A NAME="preserveLastModified"><!-- --></A><H3>
666	preserveLastModified</H3>
667	<PRE>
668	protected boolean <B>preserveLastModified</B></PRE>
669	<DL>
670	<DL>
671	</DL>
672	</DL>
673	<HR>
674
675	<A NAME="forceOverwrite"><!-- --></A><H3>
676	forceOverwrite</H3>
677	<PRE>
678	protected boolean <B>forceOverwrite</B></PRE>
679	<DL>
680	<DL>
681	</DL>
682	</DL>
683	<HR>
684
685	<A NAME="flatten"><!-- --></A><H3>
686	flatten</H3>
687	<PRE>
688	protected boolean <B>flatten</B></PRE>
689	<DL>
690	<DL>
691	</DL>
692	</DL>
693	<HR>
694
695	<A NAME="verbosity"><!-- --></A><H3>
696	verbosity</H3>
697	<PRE>
698	protected int <B>verbosity</B></PRE>
699	<DL>
700	<DL>
701	</DL>
702	</DL>
703	<HR>
704
705	<A NAME="includeEmpty"><!-- --></A><H3>
706	includeEmpty</H3>
707	<PRE>
708	protected boolean <B>includeEmpty</B></PRE>
709	<DL>
710	<DL>
711	</DL>
712	</DL>
713	<HR>
714
715	<A NAME="failonerror"><!-- --></A><H3>
716	failonerror</H3>
717	<PRE>
718	protected boolean <B>failonerror</B></PRE>
719	<DL>
720	<DL>
721	</DL>
722	</DL>
723	<HR>
724
725	<A NAME="fileCopyMap"><!-- --></A><H3>
726	fileCopyMap</H3>
727	<PRE>
728	protected java.util.Hashtable <B>fileCopyMap</B></PRE>
729	<DL>
730	<DL>
731	</DL>
732	</DL>
733	<HR>
734
735	<A NAME="dirCopyMap"><!-- --></A><H3>
736	dirCopyMap</H3>
737	<PRE>
738	protected java.util.Hashtable <B>dirCopyMap</B></PRE>
739	<DL>
740	<DL>
741	</DL>
742	</DL>
743	<HR>
744
745	<A NAME="completeDirMap"><!-- --></A><H3>
746	completeDirMap</H3>
747	<PRE>
748	protected java.util.Hashtable <B>completeDirMap</B></PRE>
749	<DL>
750	<DL>
751	</DL>
752	</DL>
753	<HR>
754
755	<A NAME="mapperElement"><!-- --></A><H3>
756	mapperElement</H3>
757	<PRE>
758	protected <A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A> <B>mapperElement</B></PRE>
759	<DL>
760	<DL>
761	</DL>
762	</DL>
763	<HR>
764
765	<A NAME="fileUtils"><!-- --></A><H3>
766	fileUtils</H3>
767	<PRE>
768	protected <A HREF="../../../../../org/apache/tools/ant/util/FileUtils.html" title="class in org.apache.tools.ant.util">FileUtils</A> <B>fileUtils</B></PRE>
769	<DL>
770	<DL>
771	</DL>
772	</DL>
773
774	<!-- ========= CONSTRUCTOR DETAIL ======== -->
775
776	<A NAME="constructor_detail"><!-- --></A>
777	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
778	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
779	<TD COLSPAN=1><FONT SIZE="+2">
780	<B>Constructor Detail</B></FONT></TD>
781	</TR>
782	</TABLE>
783
784	<A NAME="Copy()"><!-- --></A><H3>
785	Copy</H3>
786	<PRE>
787	public <B>Copy</B>()</PRE>
788	<DL>
789	<DD>Copy task constructor.
790	<P>
791	</DL>
792
793	<!-- ============ METHOD DETAIL ========== -->
794
795	<A NAME="method_detail"><!-- --></A>
796	<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
797	<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
798	<TD COLSPAN=1><FONT SIZE="+2">
799	<B>Method Detail</B></FONT></TD>
800	</TR>
801	</TABLE>
802
803	<A NAME="getFileUtils()"><!-- --></A><H3>
804	getFileUtils</H3>
805	<PRE>
806	protected <A HREF="../../../../../org/apache/tools/ant/util/FileUtils.html" title="class in org.apache.tools.ant.util">FileUtils</A> <B>getFileUtils</B>()</PRE>
807	<DL>
808	<DD><DL>
809
810	<DT><B>Returns:</B><DD>the fileutils object</DL>
811	</DD>
812	</DL>
813	<HR>
814
815	<A NAME="setFile(java.io.File)"><!-- --></A><H3>
816	setFile</H3>
817	<PRE>
818	public void <B>setFile</B>(java.io.File file)</PRE>
819	<DL>
820	<DD>Sets a single source file to copy.
821	<P>
822	<DD><DL>
823	<DT><B>Parameters:</B><DD><CODE>file</CODE> - the file to copy</DL>
824	</DD>
825	</DL>
826	<HR>
827
828	<A NAME="setTofile(java.io.File)"><!-- --></A><H3>
829	setTofile</H3>
830	<PRE>
831	public void <B>setTofile</B>(java.io.File destFile)</PRE>
832	<DL>
833	<DD>Sets the destination file.
834	<P>
835	<DD><DL>
836	<DT><B>Parameters:</B><DD><CODE>destFile</CODE> - the file to copy to</DL>
837	</DD>
838	</DL>
839	<HR>
840
841	<A NAME="setTodir(java.io.File)"><!-- --></A><H3>
842	setTodir</H3>
843	<PRE>
844	public void <B>setTodir</B>(java.io.File destDir)</PRE>
845	<DL>
846	<DD>Sets the destination directory.
847	<P>
848	<DD><DL>
849	<DT><B>Parameters:</B><DD><CODE>destDir</CODE> - the destination directory</DL>
850	</DD>
851	</DL>
852	<HR>
853
854	<A NAME="createFilterChain()"><!-- --></A><H3>
855	createFilterChain</H3>
856	<PRE>
857	public <A HREF="../../../../../org/apache/tools/ant/types/FilterChain.html" title="class in org.apache.tools.ant.types">FilterChain</A> <B>createFilterChain</B>()</PRE>
858	<DL>
859	<DD>Adds a FilterChain.
860	<P>
861	<DD><DL>
862
863	<DT><B>Returns:</B><DD>a filter chain object</DL>
864	</DD>
865	</DL>
866	<HR>
867
868	<A NAME="createFilterSet()"><!-- --></A><H3>
869	createFilterSet</H3>
870	<PRE>
871	public <A HREF="../../../../../org/apache/tools/ant/types/FilterSet.html" title="class in org.apache.tools.ant.types">FilterSet</A> <B>createFilterSet</B>()</PRE>
872	<DL>
873	<DD>Adds a filterset.
874	<P>
875	<DD><DL>
876
877	<DT><B>Returns:</B><DD>a filter set object</DL>
878	</DD>
879	</DL>
880	<HR>
881
882	<A NAME="setPreserveLastModified(java.lang.String)"><!-- --></A><H3>
883	setPreserveLastModified</H3>
884	<PRE>
885	public void <B>setPreserveLastModified</B>(java.lang.String preserve)</PRE>
886	<DL>
887	<DD><B>Deprecated.</B> <I>setPreserveLastModified(String) has been deprecated and
888	replaced with setPreserveLastModified(boolean) to
889	consistently let the Introspection mechanism work.</I>
890	<P>
891	<DD>Give the copied files the same last modified time as the original files.
892	<P>
893	<DD><DL>
894	<DT><B>Parameters:</B><DD><CODE>preserve</CODE> - a boolean string</DL>
895	</DD>
896	</DL>
897	<HR>
898
899	<A NAME="setPreserveLastModified(boolean)"><!-- --></A><H3>
900	setPreserveLastModified</H3>
901	<PRE>
902	public void <B>setPreserveLastModified</B>(boolean preserve)</PRE>
903	<DL>
904	<DD>Give the copied files the same last modified time as the original files.
905	<P>
906	<DD><DL>
907	<DT><B>Parameters:</B><DD><CODE>preserve</CODE> - if true perverse the modified time, default is false</DL>
908	</DD>
909	</DL>
910	<HR>
911
912	<A NAME="getPreserveLastModified()"><!-- --></A><H3>
913	getPreserveLastModified</H3>
914	<PRE>
915	public boolean <B>getPreserveLastModified</B>()</PRE>
916	<DL>
917	<DD>Whether to give the copied files the same last modified time as
918	the original files.
919	<P>
920	<DD><DL>
921
922	<DT><B>Returns:</B><DD>the preserveLastModified attribute<DT><B>Since:</B></DT>
923	<DD>1.32, Ant 1.5</DD>
924	</DL>
925	</DD>
926	</DL>
927	<HR>
928
929	<A NAME="getFilterSets()"><!-- --></A><H3>
930	getFilterSets</H3>
931	<PRE>
932	protected java.util.Vector <B>getFilterSets</B>()</PRE>
933	<DL>
934	<DD>Get the filtersets being applied to this operation.
935	<P>
936	<DD><DL>
937
938	<DT><B>Returns:</B><DD>a vector of FilterSet objects</DL>
939	</DD>
940	</DL>
941	<HR>
942
943	<A NAME="getFilterChains()"><!-- --></A><H3>
944	getFilterChains</H3>
945	<PRE>
946	protected java.util.Vector <B>getFilterChains</B>()</PRE>
947	<DL>
948	<DD>Get the filterchains being applied to this operation.
949	<P>
950	<DD><DL>
951
952	<DT><B>Returns:</B><DD>a vector of FilterChain objects</DL>
953	</DD>
954	</DL>
955	<HR>
956
957	<A NAME="setFiltering(boolean)"><!-- --></A><H3>
958	setFiltering</H3>
959	<PRE>
960	public void <B>setFiltering</B>(boolean filtering)</PRE>
961	<DL>
962	<DD>If true, enables filtering.
963	<P>
964	<DD><DL>
965	<DT><B>Parameters:</B><DD><CODE>filtering</CODE> - if true enable filtering, default is false</DL>
966	</DD>
967	</DL>
968	<HR>
969
970	<A NAME="setOverwrite(boolean)"><!-- --></A><H3>
971	setOverwrite</H3>
972	<PRE>
973	public void <B>setOverwrite</B>(boolean overwrite)</PRE>
974	<DL>
975	<DD>Overwrite any existing destination file(s).
976	<P>
977	<DD><DL>
978	<DT><B>Parameters:</B><DD><CODE>overwrite</CODE> - if true force overwriting of destination file(s)
979	even if the destination file(s) are younger than
980	the corresponding source file. Default is false.</DL>
981	</DD>
982	</DL>
983	<HR>
984
985	<A NAME="setFlatten(boolean)"><!-- --></A><H3>
986	setFlatten</H3>
987	<PRE>
988	public void <B>setFlatten</B>(boolean flatten)</PRE>
989	<DL>
990	<DD>When copying directory trees, the files can be "flattened"
991	into a single directory. If there are multiple files with
992	the same name in the source directory tree, only the first
993	file will be copied into the "flattened" directory, unless
994	the forceoverwrite attribute is true.
995	<P>
996	<DD><DL>
997	<DT><B>Parameters:</B><DD><CODE>flatten</CODE> - if true flatten the destination directory. Default
998	is false.</DL>
999	</DD>
1000	</DL>
1001	<HR>
1002
1003	<A NAME="setVerbose(boolean)"><!-- --></A><H3>
1004	setVerbose</H3>
1005	<PRE>
1006	public void <B>setVerbose</B>(boolean verbose)</PRE>
1007	<DL>
1008	<DD>Used to force listing of all names of copied files.
1009	<P>
1010	<DD><DL>
1011	<DT><B>Parameters:</B><DD><CODE>verbose</CODE> - output the names of copied files. Default is false.</DL>
1012	</DD>
1013	</DL>
1014	<HR>
1015
1016	<A NAME="setIncludeEmptyDirs(boolean)"><!-- --></A><H3>
1017	setIncludeEmptyDirs</H3>
1018	<PRE>
1019	public void <B>setIncludeEmptyDirs</B>(boolean includeEmpty)</PRE>
1020	<DL>
1021	<DD>Used to copy empty directories.
1022	<P>
1023	<DD><DL>
1024	<DT><B>Parameters:</B><DD><CODE>includeEmpty</CODE> - if true copy empty directories. Default is true.</DL>
1025	</DD>
1026	</DL>
1027	<HR>
1028
1029	<A NAME="setEnableMultipleMappings(boolean)"><!-- --></A><H3>
1030	setEnableMultipleMappings</H3>
1031	<PRE>
1032	public void <B>setEnableMultipleMappings</B>(boolean enableMultipleMappings)</PRE>
1033	<DL>
1034	<DD>Attribute to handle mappers that return multiple
1035	mappings for a given source path.
1036	<P>
1037	<DD><DL>
1038	<DT><B>Parameters:</B><DD><CODE>enableMultipleMappings</CODE> - If true the task will
1039	copy to all the mappings for a given source path, if
1040	false, only the first file or directory is
1041	processed.
1042	By default, this setting is false to provide backward
1043	compatibility with earlier releases.<DT><B>Since:</B></DT>
1044	<DD>1.6</DD>
1045	</DL>
1046	</DD>
1047	</DL>
1048	<HR>
1049
1050	<A NAME="isEnableMultipleMapping()"><!-- --></A><H3>
1051	isEnableMultipleMapping</H3>
1052	<PRE>
1053	public boolean <B>isEnableMultipleMapping</B>()</PRE>
1054	<DL>
1055	<DD><DL>
1056
1057	<DT><B>Returns:</B><DD>the value of the enableMultipleMapping attribute</DL>
1058	</DD>
1059	</DL>
1060	<HR>
1061
1062	<A NAME="setFailOnError(boolean)"><!-- --></A><H3>
1063	setFailOnError</H3>
1064	<PRE>
1065	public void <B>setFailOnError</B>(boolean failonerror)</PRE>
1066	<DL>
1067	<DD>If false, note errors to the output but keep going.
1068	<P>
1069	<DD><DL>
1070	<DT><B>Parameters:</B><DD><CODE>failonerror</CODE> - true or false</DL>
1071	</DD>
1072	</DL>
1073	<HR>
1074
1075	<A NAME="addFileset(org.apache.tools.ant.types.FileSet)"><!-- --></A><H3>
1076	addFileset</H3>
1077	<PRE>
1078	public void <B>addFileset</B>(<A HREF="../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</A> set)</PRE>
1079	<DL>
1080	<DD>Adds a set of files to copy.
1081	<P>
1082	<DD><DL>
1083	<DT><B>Parameters:</B><DD><CODE>set</CODE> - a set of files to copy</DL>
1084	</DD>
1085	</DL>
1086	<HR>
1087
1088	<A NAME="createMapper()"><!-- --></A><H3>
1089	createMapper</H3>
1090	<PRE>
1091	public <A HREF="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</A> <B>createMapper</B>()
1092	throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1093	<DL>
1094	<DD>Defines the mapper to map source to destination files.
1095	<P>
1096	<DD><DL>
1097
1098	<DT><B>Returns:</B><DD>a mapper to be configured
1099	<DT><B>Throws:</B>
1100	<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if more than one mapper is defined</DL>
1101	</DD>
1102	</DL>
1103	<HR>
1104
1105	<A NAME="add(org.apache.tools.ant.util.FileNameMapper)"><!-- --></A><H3>
1106	add</H3>
1107	<PRE>
1108	public void <B>add</B>(<A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A> fileNameMapper)</PRE>
1109	<DL>
1110	<DD>A nested filenamemapper
1111	<P>
1112	<DD><DL>
1113	<DT><B>Parameters:</B><DD><CODE>fileNameMapper</CODE> - the mapper to add<DT><B>Since:</B></DT>
1114	<DD>Ant 1.6.3</DD>
1115	</DL>
1116	</DD>
1117	</DL>
1118	<HR>
1119
1120	<A NAME="setEncoding(java.lang.String)"><!-- --></A><H3>
1121	setEncoding</H3>
1122	<PRE>
1123	public void <B>setEncoding</B>(java.lang.String encoding)</PRE>
1124	<DL>
1125	<DD>Sets the character encoding
1126	<P>
1127	<DD><DL>
1128	<DT><B>Parameters:</B><DD><CODE>encoding</CODE> - the character encoding<DT><B>Since:</B></DT>
1129	<DD>1.32, Ant 1.5</DD>
1130	</DL>
1131	</DD>
1132	</DL>
1133	<HR>
1134
1135	<A NAME="getEncoding()"><!-- --></A><H3>
1136	getEncoding</H3>
1137	<PRE>
1138	public java.lang.String <B>getEncoding</B>()</PRE>
1139	<DL>
1140	<DD><DL>
1141
1142	<DT><B>Returns:</B><DD>the character encoding, <code>null</code> if not set.<DT><B>Since:</B></DT>
1143	<DD>1.32, Ant 1.5</DD>
1144	</DL>
1145	</DD>
1146	</DL>
1147	<HR>
1148
1149	<A NAME="setOutputEncoding(java.lang.String)"><!-- --></A><H3>
1150	setOutputEncoding</H3>
1151	<PRE>
1152	public void <B>setOutputEncoding</B>(java.lang.String encoding)</PRE>
1153	<DL>
1154	<DD>Sets the character encoding for output files.
1155	<P>
1156	<DD><DL>
1157	<DT><B>Parameters:</B><DD><CODE>encoding</CODE> - the character encoding<DT><B>Since:</B></DT>
1158	<DD>Ant 1.6</DD>
1159	</DL>
1160	</DD>
1161	</DL>
1162	<HR>
1163
1164	<A NAME="getOutputEncoding()"><!-- --></A><H3>
1165	getOutputEncoding</H3>
1166	<PRE>
1167	public java.lang.String <B>getOutputEncoding</B>()</PRE>
1168	<DL>
1169	<DD><DL>
1170
1171	<DT><B>Returns:</B><DD>the character encoding for output files,
1172	<code>null</code> if not set.<DT><B>Since:</B></DT>
1173	<DD>Ant 1.6</DD>
1174	</DL>
1175	</DD>
1176	</DL>
1177	<HR>
1178
1179	<A NAME="setGranularity(long)"><!-- --></A><H3>
1180	setGranularity</H3>
1181	<PRE>
1182	public void <B>setGranularity</B>(long granularity)</PRE>
1183	<DL>
1184	<DD>The number of milliseconds leeway to give before deciding a
1185	target is out of date.
1186
1187	<p>Default is 0 milliseconds, or 2 seconds on DOS systems.</p>
1188	<P>
1189	<DD><DL>
1190	<DT><B>Since:</B></DT>
1191	<DD>Ant 1.6.2</DD>
1192	</DL>
1193	</DD>
1194	</DL>
1195	<HR>
1196
1197	<A NAME="execute()"><!-- --></A><H3>
1198	execute</H3>
1199	<PRE>
1200	public void <B>execute</B>()
1201	throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1202	<DL>
1203	<DD>Performs the copy operation.
1204	<P>
1205	<DD><DL>
1206	<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/tools/ant/Task.html#execute()">execute</A></CODE> in class <CODE><A HREF="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A></CODE></DL>
1207	</DD>
1208	<DD><DL>
1209
1210	<DT><B>Throws:</B>
1211	<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if an error occurs</DL>
1212	</DD>
1213	</DL>
1214	<HR>
1215
1216	<A NAME="validateAttributes()"><!-- --></A><H3>
1217	validateAttributes</H3>
1218	<PRE>
1219	protected void <B>validateAttributes</B>()
1220	throws <A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
1221	<DL>
1222	<DD>Ensure we have a consistent and legal set of attributes, and set
1223	any internal flags necessary based on different combinations
1224	of attributes.
1225	<P>
1226	<DD><DL>
1227
1228	<DT><B>Throws:</B>
1229	<DD><CODE><A HREF="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if an error occurs</DL>
1230	</DD>
1231	</DL>
1232	<HR>
1233
1234	<A NAME="scan(java.io.File, java.io.File, java.lang.String[], java.lang.String[])"><!-- --></A><H3>
1235	scan</H3>
1236	<PRE>
1237	protected void <B>scan</B>(java.io.File fromDir,
1238	java.io.File toDir,
1239	java.lang.String[] files,
1240	java.lang.String[] dirs)</PRE>
1241	<DL>
1242	<DD>Compares source files to destination files to see if they should be
1243	copied.
1244	<P>
1245	<DD><DL>
1246	<DT><B>Parameters:</B><DD><CODE>fromDir</CODE> - The source directory<DD><CODE>toDir</CODE> - The destination directory<DD><CODE>files</CODE> - A list of files to copy<DD><CODE>dirs</CODE> - A list of directories to copy</DL>
1247	</DD>
1248	</DL>
1249	<HR>
1250
1251	<A NAME="buildMap(java.io.File, java.io.File, java.lang.String[], org.apache.tools.ant.util.FileNameMapper, java.util.Hashtable)"><!-- --></A><H3>
1252	buildMap</H3>
1253	<PRE>
1254	protected void <B>buildMap</B>(java.io.File fromDir,
1255	java.io.File toDir,
1256	java.lang.String[] names,
1257	<A HREF="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</A> mapper,
1258	java.util.Hashtable map)</PRE>
1259	<DL>
1260	<DD>Add to a map of files/directories to copy
1261	<P>
1262	<DD><DL>
1263	<DT><B>Parameters:</B><DD><CODE>fromDir</CODE> - the source directory<DD><CODE>toDir</CODE> - the destination directory<DD><CODE>names</CODE> - a list of filenames<DD><CODE>mapper</CODE> - a <code>FileNameMapper</code> value<DD><CODE>map</CODE> - a map of source file to array of destination files</DL>
1264	</DD>
1265	</DL>
1266	<HR>
1267
1268	<A NAME="doFileOperations()"><!-- --></A><H3>
1269	doFileOperations</H3>
1270	<PRE>
1271	protected void <B>doFileOperations</B>()</PRE>
1272	<DL>
1273	<DD>Actually does the file (and possibly empty directory) copies.
1274	This is a good method for subclasses to override.
1275	<P>
1276	<DD><DL>
1277	</DL>
1278	</DD>
1279	</DL>
1280	<!-- ========= END OF CLASS DATA ========= -->
1281	<HR>
1282
1283
1284	<!-- ======= START OF BOTTOM NAVBAR ====== -->
1285	<A NAME="navbar_bottom"><!-- --></A>
1286	<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1287	<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1288	<TR>
1289	<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1290	<A NAME="navbar_bottom_firstrow"><!-- --></A>
1291	<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1292	<TR ALIGN="center" VALIGN="top">
1293	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
1294	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
1295	<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
1296	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
1297	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
1298	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
1299	<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
1300	</TR>
1301	</TABLE>
1302	</TD>
1303	<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1304	</EM>
1305	</TD>
1306	</TR>
1307
1308	<TR>
1309	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1310	<A HREF="../../../../../org/apache/tools/ant/taskdefs/ConditionTask.html" title="class in org.apache.tools.ant.taskdefs"><B>PREV CLASS</B></A>
1311	<A HREF="../../../../../org/apache/tools/ant/taskdefs/Copydir.html" title="class in org.apache.tools.ant.taskdefs"><B>NEXT CLASS</B></A></FONT></TD>
1312	<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1313	<A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
1314	<A HREF="Copy.html" target="_top"><B>NO FRAMES</B></A>
1315	<SCRIPT type="text/javascript">
1316	<!--
1317	if(window==top) {
1318	document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1319	}
1320	//-->
1321	</SCRIPT>
1322	<NOSCRIPT>
1323	<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
1324	</NOSCRIPT>
1325
1326	</FONT></TD>
1327	</TR>
1328	<TR>
1329	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1330	SUMMARY: NESTED \| <A HREF="#field_summary">FIELD</A> \| <A HREF="#constructor_summary">CONSTR</A> \| <A HREF="#method_summary">METHOD</A></FONT></TD>
1331	<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1332	DETAIL: <A HREF="#field_detail">FIELD</A> \| <A HREF="#constructor_detail">CONSTR</A> \| <A HREF="#method_detail">METHOD</A></FONT></TD>
1333	</TR>
1334	</TABLE>
1335	<A NAME="skip-navbar_bottom"></A>
1336	<!-- ======== END OF BOTTOM NAVBAR ======= -->
1337
1338	<HR>
1339	Copyright Â© 2000-2007 Apache Software Foundation. All Rights Reserved.
1340	</BODY>
1341	</HTML>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: