????
| Current Path : /opt/ant/manual/api/org/apache/tools/ant/taskdefs/ |
| Current File : //opt/ant/manual/api/org/apache/tools/ant/taskdefs/Copy.html |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Tue May 22 06:24:52 CEST 2012 -->
<title>Copy (Apache Ant API)</title>
<meta name="date" content="2012-05-22">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Copy (Apache Ant API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/tools/ant/taskdefs/ConditionTask.html" title="class in org.apache.tools.ant.taskdefs"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/tools/ant/taskdefs/Copydir.html" title="class in org.apache.tools.ant.taskdefs"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/tools/ant/taskdefs/Copy.html" target="_top">Frames</a></li>
<li><a href="Copy.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.tools.ant.taskdefs</div>
<h2 title="Class Copy" class="title">Class Copy</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">org.apache.tools.ant.Task</a></li>
<li>
<ul class="inheritance">
<li>org.apache.tools.ant.taskdefs.Copy</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Cloneable</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<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>
</dl>
<hr>
<br>
<pre>public class <span class="strong">Copy</span>
extends <a href="../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</a></pre>
<div class="block">Copies a file or directory to a new file
or directory. Files are only copied if the source file is newer
than the destination file, or when the destination file does not
exist. It is possible to explicitly overwrite existing files.</p>
<p>This implementation is based on Arnout Kuiper's initial design
document, the following mailing list discussions, and the
copyfile/copydir tasks.</p></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.2</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Hashtable</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#completeDirMap">completeDirMap</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.io.File</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#destDir">destDir</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.io.File</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#destFile">destFile</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.Hashtable</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#dirCopyMap">dirCopyMap</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#failonerror">failonerror</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.io.File</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#file">file</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Hashtable</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#fileCopyMap">fileCopyMap</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.Vector</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#filesets">filesets</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/tools/ant/util/FileUtils.html" title="class in org.apache.tools.ant.util">FileUtils</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#fileUtils">fileUtils</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#filtering">filtering</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#flatten">flatten</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#forceOverwrite">forceOverwrite</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#includeEmpty">includeEmpty</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#mapperElement">mapperElement</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#preserveLastModified">preserveLastModified</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.Vector</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#rcs">rcs</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#verbosity">verbosity</a></strong></code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.tools.ant.Task">
<!-- -->
</a>
<h3>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></h3>
<code><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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent">
<!-- -->
</a>
<h3>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></h3>
<code><a href="../../../../../org/apache/tools/ant/ProjectComponent.html#description">description</a>, <a href="../../../../../org/apache/tools/ant/ProjectComponent.html#location">location</a>, <a href="../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#Copy()">Copy</a></strong>()</code>
<div class="block">Copy task constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#add(org.apache.tools.ant.util.FileNameMapper)">add</a></strong>(<a href="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</a> fileNameMapper)</code>
<div class="block">Add a nested filenamemapper.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#add(org.apache.tools.ant.types.ResourceCollection)">add</a></strong>(<a href="../../../../../org/apache/tools/ant/types/ResourceCollection.html" title="interface in org.apache.tools.ant.types">ResourceCollection</a> res)</code>
<div class="block">Add a collection of files to copy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#addFileset(org.apache.tools.ant.types.FileSet)">addFileset</a></strong>(<a href="../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</a> set)</code>
<div class="block">Add a set of files to copy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><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></strong>(java.io.File fromDir,
java.io.File toDir,
java.lang.String[] names,
<a href="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</a> mapper,
java.util.Hashtable map)</code>
<div class="block">Add to a map of files/directories to copy.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Map</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#buildMap(org.apache.tools.ant.types.Resource[], java.io.File, org.apache.tools.ant.util.FileNameMapper)">buildMap</a></strong>(<a href="../../../../../org/apache/tools/ant/types/Resource.html" title="class in org.apache.tools.ant.types">Resource</a>[] fromResources,
java.io.File toDir,
<a href="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</a> mapper)</code>
<div class="block">Create a map of resources to copy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/tools/ant/types/FilterChain.html" title="class in org.apache.tools.ant.types">FilterChain</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#createFilterChain()">createFilterChain</a></strong>()</code>
<div class="block">Add a FilterChain.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/tools/ant/types/FilterSet.html" title="class in org.apache.tools.ant.types">FilterSet</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#createFilterSet()">createFilterSet</a></strong>()</code>
<div class="block">Add a filterset.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#createMapper()">createMapper</a></strong>()</code>
<div class="block">Define the mapper to map source to destination files.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#doFileOperations()">doFileOperations</a></strong>()</code>
<div class="block">Actually does the file (and possibly empty directory) copies.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#doResourceOperations(java.util.Map)">doResourceOperations</a></strong>(java.util.Map map)</code>
<div class="block">Actually does the resource copies.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#execute()">execute</a></strong>()</code>
<div class="block">Perform the copy operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#getEncoding()">getEncoding</a></strong>()</code>
<div class="block">Get the character encoding to be used.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../../org/apache/tools/ant/util/FileUtils.html" title="class in org.apache.tools.ant.util">FileUtils</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#getFileUtils()">getFileUtils</a></strong>()</code>
<div class="block">Get the FileUtils for this task.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.util.Vector</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#getFilterChains()">getFilterChains</a></strong>()</code>
<div class="block">Get the filterchains being applied to this operation.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Vector</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#getFilterSets()">getFilterSets</a></strong>()</code>
<div class="block">Get the filtersets being applied to this operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#getForce()">getForce</a></strong>()</code>
<div class="block">Whether read-only destinations will be overwritten.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#getOutputEncoding()">getOutputEncoding</a></strong>()</code>
<div class="block">Get the character encoding for output files.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#getPreserveLastModified()">getPreserveLastModified</a></strong>()</code>
<div class="block">Get whether to give the copied files the same last modified time as
the original files.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#isEnableMultipleMapping()">isEnableMultipleMapping</a></strong>()</code>
<div class="block">Get whether multiple mapping is enabled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#scan(java.io.File, java.io.File, java.lang.String[], java.lang.String[])">scan</a></strong>(java.io.File fromDir,
java.io.File toDir,
java.lang.String[] files,
java.lang.String[] dirs)</code>
<div class="block">Compares source files to destination files to see if they should be
copied.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Map</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#scan(org.apache.tools.ant.types.Resource[], java.io.File)">scan</a></strong>(<a href="../../../../../org/apache/tools/ant/types/Resource.html" title="class in org.apache.tools.ant.types">Resource</a>[] fromResources,
java.io.File toDir)</code>
<div class="block">Compares source resources to destination files to see if they
should be copied.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setEnableMultipleMappings(boolean)">setEnableMultipleMappings</a></strong>(boolean enableMultipleMappings)</code>
<div class="block">Set method of handling mappers that return multiple
mappings for a given source path.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setEncoding(java.lang.String)">setEncoding</a></strong>(java.lang.String encoding)</code>
<div class="block">Set the character encoding.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setFailOnError(boolean)">setFailOnError</a></strong>(boolean failonerror)</code>
<div class="block">Set whether to fail when errors are encountered.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setFile(java.io.File)">setFile</a></strong>(java.io.File file)</code>
<div class="block">Set a single source file to copy.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setFiltering(boolean)">setFiltering</a></strong>(boolean filtering)</code>
<div class="block">Set filtering mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setFlatten(boolean)">setFlatten</a></strong>(boolean flatten)</code>
<div class="block">Set whether files copied from directory trees will be "flattened"
into a single directory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setForce(boolean)">setForce</a></strong>(boolean f)</code>
<div class="block">Whether read-only destinations will be overwritten.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setGranularity(long)">setGranularity</a></strong>(long granularity)</code>
<div class="block">Set the number of milliseconds leeway to give before deciding a
target is out of date.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setIncludeEmptyDirs(boolean)">setIncludeEmptyDirs</a></strong>(boolean includeEmpty)</code>
<div class="block">Set whether to copy empty directories.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setOutputEncoding(java.lang.String)">setOutputEncoding</a></strong>(java.lang.String encoding)</code>
<div class="block">Set the character encoding for output files.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setOverwrite(boolean)">setOverwrite</a></strong>(boolean overwrite)</code>
<div class="block">Set overwrite mode regarding existing destination file(s).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setPreserveLastModified(boolean)">setPreserveLastModified</a></strong>(boolean preserve)</code>
<div class="block">Give the copied files the same last modified time as the original files.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setPreserveLastModified(java.lang.String)">setPreserveLastModified</a></strong>(java.lang.String preserve)</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>since 1.5.x.
setPreserveLastModified(String) has been deprecated and
replaced with setPreserveLastModified(boolean) to
consistently let the Introspection mechanism work.</i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setQuiet(boolean)">setQuiet</a></strong>(boolean quiet)</code>
<div class="block">Set quiet mode.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setTodir(java.io.File)">setTodir</a></strong>(java.io.File destDir)</code>
<div class="block">Set the destination directory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setTofile(java.io.File)">setTofile</a></strong>(java.io.File destFile)</code>
<div class="block">Set the destination file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#setVerbose(boolean)">setVerbose</a></strong>(boolean verbose)</code>
<div class="block">Set verbose mode.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#supportsNonFileResources()">supportsNonFileResources</a></strong>()</code>
<div class="block">Whether this task can deal with non-file resources.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/tools/ant/taskdefs/Copy.html#validateAttributes()">validateAttributes</a></strong>()</code>
<div class="block">Ensure we have a consistent and legal set of attributes, and set
any internal flags necessary based on different combinations
of attributes.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.tools.ant.Task">
<!-- -->
</a>
<h3>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></h3>
<code><a href="../../../../../org/apache/tools/ant/Task.html#bindToOwner(org.apache.tools.ant.Task)">bindToOwner</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#log(java.lang.String, java.lang.Throwable, int)">log</a>, <a href="../../../../../org/apache/tools/ant/Task.html#log(java.lang.Throwable, 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#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></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent">
<!-- -->
</a>
<h3>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></h3>
<code><a href="../../../../../org/apache/tools/ant/ProjectComponent.html#clone()">clone</a>, <a href="../../../../../org/apache/tools/ant/ProjectComponent.html#getDescription()">getDescription</a>, <a href="../../../../../org/apache/tools/ant/ProjectComponent.html#getLocation()">getLocation</a>, <a href="../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</a>, <a href="../../../../../org/apache/tools/ant/ProjectComponent.html#setDescription(java.lang.String)">setDescription</a>, <a href="../../../../../org/apache/tools/ant/ProjectComponent.html#setLocation(org.apache.tools.ant.Location)">setLocation</a>, <a href="../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="file">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>file</h4>
<pre>protected java.io.File file</pre>
</li>
</ul>
<a name="destFile">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destFile</h4>
<pre>protected java.io.File destFile</pre>
</li>
</ul>
<a name="destDir">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destDir</h4>
<pre>protected java.io.File destDir</pre>
</li>
</ul>
<a name="rcs">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>rcs</h4>
<pre>protected java.util.Vector rcs</pre>
</li>
</ul>
<a name="filesets">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filesets</h4>
<pre>protected java.util.Vector filesets</pre>
</li>
</ul>
<a name="filtering">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filtering</h4>
<pre>protected boolean filtering</pre>
</li>
</ul>
<a name="preserveLastModified">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>preserveLastModified</h4>
<pre>protected boolean preserveLastModified</pre>
</li>
</ul>
<a name="forceOverwrite">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>forceOverwrite</h4>
<pre>protected boolean forceOverwrite</pre>
</li>
</ul>
<a name="flatten">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>flatten</h4>
<pre>protected boolean flatten</pre>
</li>
</ul>
<a name="verbosity">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verbosity</h4>
<pre>protected int verbosity</pre>
</li>
</ul>
<a name="includeEmpty">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>includeEmpty</h4>
<pre>protected boolean includeEmpty</pre>
</li>
</ul>
<a name="failonerror">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>failonerror</h4>
<pre>protected boolean failonerror</pre>
</li>
</ul>
<a name="fileCopyMap">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fileCopyMap</h4>
<pre>protected java.util.Hashtable fileCopyMap</pre>
</li>
</ul>
<a name="dirCopyMap">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dirCopyMap</h4>
<pre>protected java.util.Hashtable dirCopyMap</pre>
</li>
</ul>
<a name="completeDirMap">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>completeDirMap</h4>
<pre>protected java.util.Hashtable completeDirMap</pre>
</li>
</ul>
<a name="mapperElement">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>mapperElement</h4>
<pre>protected <a href="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</a> mapperElement</pre>
</li>
</ul>
<a name="fileUtils">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>fileUtils</h4>
<pre>protected <a href="../../../../../org/apache/tools/ant/util/FileUtils.html" title="class in org.apache.tools.ant.util">FileUtils</a> fileUtils</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Copy()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Copy</h4>
<pre>public Copy()</pre>
<div class="block">Copy task constructor.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getFileUtils()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFileUtils</h4>
<pre>protected <a href="../../../../../org/apache/tools/ant/util/FileUtils.html" title="class in org.apache.tools.ant.util">FileUtils</a> getFileUtils()</pre>
<div class="block">Get the FileUtils for this task.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the fileutils object.</dd></dl>
</li>
</ul>
<a name="setFile(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFile</h4>
<pre>public void setFile(java.io.File file)</pre>
<div class="block">Set a single source file to copy.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - the file to copy.</dd></dl>
</li>
</ul>
<a name="setTofile(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTofile</h4>
<pre>public void setTofile(java.io.File destFile)</pre>
<div class="block">Set the destination file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>destFile</code> - the file to copy to.</dd></dl>
</li>
</ul>
<a name="setTodir(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTodir</h4>
<pre>public void setTodir(java.io.File destDir)</pre>
<div class="block">Set the destination directory.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>destDir</code> - the destination directory.</dd></dl>
</li>
</ul>
<a name="createFilterChain()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFilterChain</h4>
<pre>public <a href="../../../../../org/apache/tools/ant/types/FilterChain.html" title="class in org.apache.tools.ant.types">FilterChain</a> createFilterChain()</pre>
<div class="block">Add a FilterChain.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a filter chain object.</dd></dl>
</li>
</ul>
<a name="createFilterSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFilterSet</h4>
<pre>public <a href="../../../../../org/apache/tools/ant/types/FilterSet.html" title="class in org.apache.tools.ant.types">FilterSet</a> createFilterSet()</pre>
<div class="block">Add a filterset.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a filter set object.</dd></dl>
</li>
</ul>
<a name="setPreserveLastModified(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPreserveLastModified</h4>
<pre>public void setPreserveLastModified(java.lang.String preserve)</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>since 1.5.x.
setPreserveLastModified(String) has been deprecated and
replaced with setPreserveLastModified(boolean) to
consistently let the Introspection mechanism work.</i></div>
<div class="block">Give the copied files the same last modified time as the original files.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>preserve</code> - a boolean string.</dd></dl>
</li>
</ul>
<a name="setPreserveLastModified(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPreserveLastModified</h4>
<pre>public void setPreserveLastModified(boolean preserve)</pre>
<div class="block">Give the copied files the same last modified time as the original files.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>preserve</code> - if true preserve the modified time; default is false.</dd></dl>
</li>
</ul>
<a name="getPreserveLastModified()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPreserveLastModified</h4>
<pre>public boolean getPreserveLastModified()</pre>
<div class="block">Get whether to give the copied files the same last modified time as
the original files.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the whether destination files will inherit the modification
times of the corresponding source files.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.32, Ant 1.5</dd></dl>
</li>
</ul>
<a name="getFilterSets()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilterSets</h4>
<pre>protected java.util.Vector getFilterSets()</pre>
<div class="block">Get the filtersets being applied to this operation.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a vector of FilterSet objects.</dd></dl>
</li>
</ul>
<a name="getFilterChains()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilterChains</h4>
<pre>protected java.util.Vector getFilterChains()</pre>
<div class="block">Get the filterchains being applied to this operation.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a vector of FilterChain objects.</dd></dl>
</li>
</ul>
<a name="setFiltering(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFiltering</h4>
<pre>public void setFiltering(boolean filtering)</pre>
<div class="block">Set filtering mode.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>filtering</code> - if true enable filtering; default is false.</dd></dl>
</li>
</ul>
<a name="setOverwrite(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOverwrite</h4>
<pre>public void setOverwrite(boolean overwrite)</pre>
<div class="block">Set overwrite mode regarding existing destination file(s).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>overwrite</code> - if true force overwriting of destination file(s)
even if the destination file(s) are younger than
the corresponding source file. Default is false.</dd></dl>
</li>
</ul>
<a name="setForce(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForce</h4>
<pre>public void setForce(boolean f)</pre>
<div class="block">Whether read-only destinations will be overwritten.
<p>Defaults to false</p></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.8.2</dd></dl>
</li>
</ul>
<a name="getForce()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getForce</h4>
<pre>public boolean getForce()</pre>
<div class="block">Whether read-only destinations will be overwritten.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.8.2</dd></dl>
</li>
</ul>
<a name="setFlatten(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFlatten</h4>
<pre>public void setFlatten(boolean flatten)</pre>
<div class="block">Set whether files copied from directory trees will be "flattened"
into a single directory. If there are multiple files with
the same name in the source directory tree, only the first
file will be copied into the "flattened" directory, unless
the forceoverwrite attribute is true.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>flatten</code> - if true flatten the destination directory. Default
is false.</dd></dl>
</li>
</ul>
<a name="setVerbose(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVerbose</h4>
<pre>public void setVerbose(boolean verbose)</pre>
<div class="block">Set verbose mode. Used to force listing of all names of copied files.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>verbose</code> - whether to output the names of copied files.
Default is false.</dd></dl>
</li>
</ul>
<a name="setIncludeEmptyDirs(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setIncludeEmptyDirs</h4>
<pre>public void setIncludeEmptyDirs(boolean includeEmpty)</pre>
<div class="block">Set whether to copy empty directories.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>includeEmpty</code> - if true copy empty directories. Default is true.</dd></dl>
</li>
</ul>
<a name="setQuiet(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setQuiet</h4>
<pre>public void setQuiet(boolean quiet)</pre>
<div class="block">Set quiet mode. Used to hide messages when a file or directory to be
copied does not exist.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>quiet</code> - whether or not to display error messages when a file or
directory does not exist. Default is false.</dd></dl>
</li>
</ul>
<a name="setEnableMultipleMappings(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEnableMultipleMappings</h4>
<pre>public void setEnableMultipleMappings(boolean enableMultipleMappings)</pre>
<div class="block">Set method of handling mappers that return multiple
mappings for a given source path.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>enableMultipleMappings</code> - If true the task will
copy to all the mappings for a given source path, if
false, only the first file or directory is
processed.
By default, this setting is false to provide backward
compatibility with earlier releases.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6</dd></dl>
</li>
</ul>
<a name="isEnableMultipleMapping()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEnableMultipleMapping</h4>
<pre>public boolean isEnableMultipleMapping()</pre>
<div class="block">Get whether multiple mapping is enabled.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if multiple mapping is enabled; false otherwise.</dd></dl>
</li>
</ul>
<a name="setFailOnError(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFailOnError</h4>
<pre>public void setFailOnError(boolean failonerror)</pre>
<div class="block">Set whether to fail when errors are encountered. If false, note errors
to the output but keep going. Default is true.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>failonerror</code> - true or false.</dd></dl>
</li>
</ul>
<a name="addFileset(org.apache.tools.ant.types.FileSet)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFileset</h4>
<pre>public void addFileset(<a href="../../../../../org/apache/tools/ant/types/FileSet.html" title="class in org.apache.tools.ant.types">FileSet</a> set)</pre>
<div class="block">Add a set of files to copy.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>set</code> - a set of files to copy.</dd></dl>
</li>
</ul>
<a name="add(org.apache.tools.ant.types.ResourceCollection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public void add(<a href="../../../../../org/apache/tools/ant/types/ResourceCollection.html" title="interface in org.apache.tools.ant.types">ResourceCollection</a> res)</pre>
<div class="block">Add a collection of files to copy.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>res</code> - a resource collection to copy.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.7</dd></dl>
</li>
</ul>
<a name="createMapper()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createMapper</h4>
<pre>public <a href="../../../../../org/apache/tools/ant/types/Mapper.html" title="class in org.apache.tools.ant.types">Mapper</a> createMapper()
throws <a href="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Define the mapper to map source to destination files.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a mapper to be configured.</dd>
<dt><span class="strong">Throws:</span></dt>
<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.</dd></dl>
</li>
</ul>
<a name="add(org.apache.tools.ant.util.FileNameMapper)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>public void add(<a href="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</a> fileNameMapper)</pre>
<div class="block">Add a nested filenamemapper.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fileNameMapper</code> - the mapper to add.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6.3</dd></dl>
</li>
</ul>
<a name="setEncoding(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEncoding</h4>
<pre>public void setEncoding(java.lang.String encoding)</pre>
<div class="block">Set the character encoding.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>encoding</code> - the character encoding.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.32, Ant 1.5</dd></dl>
</li>
</ul>
<a name="getEncoding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEncoding</h4>
<pre>public java.lang.String getEncoding()</pre>
<div class="block">Get the character encoding to be used.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the character encoding, <code>null</code> if not set.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.32, Ant 1.5</dd></dl>
</li>
</ul>
<a name="setOutputEncoding(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setOutputEncoding</h4>
<pre>public void setOutputEncoding(java.lang.String encoding)</pre>
<div class="block">Set the character encoding for output files.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>encoding</code> - the output character encoding.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6</dd></dl>
</li>
</ul>
<a name="getOutputEncoding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputEncoding</h4>
<pre>public java.lang.String getOutputEncoding()</pre>
<div class="block">Get the character encoding for output files.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the character encoding for output files,
<code>null</code> if not set.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6</dd></dl>
</li>
</ul>
<a name="setGranularity(long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGranularity</h4>
<pre>public void setGranularity(long granularity)</pre>
<div class="block">Set the number of milliseconds leeway to give before deciding a
target is out of date.
<p>Default is 1 second, or 2 seconds on DOS systems.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>granularity</code> - the granularity used to decide if a target is out of
date.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6.2</dd></dl>
</li>
</ul>
<a name="execute()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>public void execute()
throws <a href="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Perform the copy operation.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<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></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if an error occurs.</dd></dl>
</li>
</ul>
<a name="validateAttributes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>validateAttributes</h4>
<pre>protected void validateAttributes()
throws <a href="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Ensure we have a consistent and legal set of attributes, and set
any internal flags necessary based on different combinations
of attributes.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if an error occurs.</dd></dl>
</li>
</ul>
<a name="scan(java.io.File, java.io.File, java.lang.String[], java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scan</h4>
<pre>protected void scan(java.io.File fromDir,
java.io.File toDir,
java.lang.String[] files,
java.lang.String[] dirs)</pre>
<div class="block">Compares source files to destination files to see if they should be
copied.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fromDir</code> - The source directory.</dd><dd><code>toDir</code> - The destination directory.</dd><dd><code>files</code> - A list of files to copy.</dd><dd><code>dirs</code> - A list of directories to copy.</dd></dl>
</li>
</ul>
<a name="scan(org.apache.tools.ant.types.Resource[], java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>scan</h4>
<pre>protected java.util.Map scan(<a href="../../../../../org/apache/tools/ant/types/Resource.html" title="class in org.apache.tools.ant.types">Resource</a>[] fromResources,
java.io.File toDir)</pre>
<div class="block">Compares source resources to destination files to see if they
should be copied.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fromResources</code> - The source resources.</dd><dd><code>toDir</code> - The destination directory.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a Map with the out-of-date resources as keys and an
array of target file names as values.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.7</dd></dl>
</li>
</ul>
<a name="buildMap(java.io.File, java.io.File, java.lang.String[], org.apache.tools.ant.util.FileNameMapper, java.util.Hashtable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildMap</h4>
<pre>protected void buildMap(java.io.File fromDir,
java.io.File toDir,
java.lang.String[] names,
<a href="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</a> mapper,
java.util.Hashtable map)</pre>
<div class="block">Add to a map of files/directories to copy.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fromDir</code> - the source directory.</dd><dd><code>toDir</code> - the destination directory.</dd><dd><code>names</code> - a list of filenames.</dd><dd><code>mapper</code> - a <code>FileNameMapper</code> value.</dd><dd><code>map</code> - a map of source file to array of destination files.</dd></dl>
</li>
</ul>
<a name="buildMap(org.apache.tools.ant.types.Resource[], java.io.File, org.apache.tools.ant.util.FileNameMapper)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildMap</h4>
<pre>protected java.util.Map buildMap(<a href="../../../../../org/apache/tools/ant/types/Resource.html" title="class in org.apache.tools.ant.types">Resource</a>[] fromResources,
java.io.File toDir,
<a href="../../../../../org/apache/tools/ant/util/FileNameMapper.html" title="interface in org.apache.tools.ant.util">FileNameMapper</a> mapper)</pre>
<div class="block">Create a map of resources to copy.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fromResources</code> - The source resources.</dd><dd><code>toDir</code> - the destination directory.</dd><dd><code>mapper</code> - a <code>FileNameMapper</code> value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a map of source resource to array of destination files.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.7</dd></dl>
</li>
</ul>
<a name="doFileOperations()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doFileOperations</h4>
<pre>protected void doFileOperations()</pre>
<div class="block">Actually does the file (and possibly empty directory) copies.
This is a good method for subclasses to override.</div>
</li>
</ul>
<a name="doResourceOperations(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doResourceOperations</h4>
<pre>protected void doResourceOperations(java.util.Map map)</pre>
<div class="block">Actually does the resource copies.
This is a good method for subclasses to override.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - a map of source resource to array of destination files.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.7</dd></dl>
</li>
</ul>
<a name="supportsNonFileResources()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>supportsNonFileResources</h4>
<pre>protected boolean supportsNonFileResources()</pre>
<div class="block">Whether this task can deal with non-file resources.
<p><copy> can while <move> can't since we don't
know how to remove non-file resources.</p>
<p>This implementation returns true only if this task is
<copy>. Any subclass of this class that also wants to
support non-file resources needs to override this method. We
need to do so for backwards compatibility reasons since we
can't expect subclasses to support resources.</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true if this task supports non file resources.</dd><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.7</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/tools/ant/taskdefs/ConditionTask.html" title="class in org.apache.tools.ant.taskdefs"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/tools/ant/taskdefs/Copydir.html" title="class in org.apache.tools.ant.taskdefs"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/tools/ant/taskdefs/Copy.html" target="_top">Frames</a></li>
<li><a href="Copy.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>