Package org.gradle.api.tasks
Class Copy
java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.AbstractCopyTask
org.gradle.api.tasks.Copy
- All Implemented Interfaces:
- Comparable<Task>,- ContentFilterable,- CopyProcessingSpec,- CopySourceSpec,- CopySpec,- org.gradle.api.internal.DynamicObjectAware,- org.gradle.api.internal.file.copy.CopySpecSource,- org.gradle.api.internal.IConventionAware,- org.gradle.api.internal.TaskInternal,- Named,- ExtensionAware,- Task,- PatternFilterable,- Configurable<Task>
- Direct Known Subclasses:
- ProcessResources
@DisableCachingByDefault(because="Not worth caching")
public abstract class Copy
extends AbstractCopyTask
Copies files into a destination directory. This task can also rename and filter files as it copies. The task
 implements 
CopySpec for specifying what to copy.
 Examples:
 task copyDocs(type: Copy) {
     from 'src/main/doc'
     into 'build/target/doc'
 }
 //for Ant filter
 import org.apache.tools.ant.filters.ReplaceTokens
 //for including in the copy task
 def dataContent = copySpec {
     from 'src/data'
     include '*.data'
 }
 task initConfig(type: Copy) {
     from('src/main/config') {
         include '**/*.properties'
         include '**/*.xml'
         filter(ReplaceTokens, tokens: [version: '2.3.1'])
     }
     from('src/main/config') {
         exclude '**/*.properties', '**/*.xml'
     }
     from('src/main/languages') {
         rename 'EN_US_(.*)', '$1'
     }
     into 'build/target/config'
     exclude '**/*.bak'
     includeEmptyDirs = false
     with dataContent
 }
 - 
Nested Class SummaryNested classes/interfaces inherited from interface org.gradle.api.TaskTask.Namer
- 
Field SummaryFields inherited from interface org.gradle.api.TaskTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected org.gradle.api.internal.file.copy.CopyActionprotected org.gradle.api.internal.file.copy.CopySpecInternalReturns the directory to copy files into.org.gradle.api.internal.file.copy.DestinationRootCopySpecvoidsetDestinationDir(File destinationDir) Sets the directory to copy files into.Methods inherited from class org.gradle.api.tasks.AbstractCopyTaskcopy, createCopyActionExecuter, dirPermissions, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, expand, filePermissions, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirectoryFileTreeFactory, getDirMode, getDirPermissions, getDocumentationRegistry, getDuplicatesStrategy, getExcludes, getFileLookup, getFileMode, getFilePermissions, getFileResolver, getFileSystem, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getInstantiator, getMainSpec, getObjectFactory, getPropertyFactory, getSource, include, include, include, include, into, into, into, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setFilteringCharset, setIncludeEmptyDirs, setIncludes, withMethods inherited from class org.gradle.api.internal.ConventionTaskconventionMapping, conventionMapping, getConventionMappingMethods inherited from class org.gradle.api.DefaultTaskcompareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTaskacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.TaskdoNotTrackState, getConvention, notCompatibleWithConfigurationCache
- 
Constructor Details- 
Copypublic Copy()
 
- 
- 
Method Details- 
createCopyActionprotected org.gradle.api.internal.file.copy.CopyAction createCopyAction()- Specified by:
- createCopyActionin class- AbstractCopyTask
 
- 
createRootSpecprotected org.gradle.api.internal.file.copy.CopySpecInternal createRootSpec()- Overrides:
- createRootSpecin class- AbstractCopyTask
 
- 
getRootSpecpublic org.gradle.api.internal.file.copy.DestinationRootCopySpec getRootSpec()- Specified by:
- getRootSpecin interface- org.gradle.api.internal.file.copy.CopySpecSource
- Overrides:
- getRootSpecin class- AbstractCopyTask
 
- 
getDestinationDirReturns the directory to copy files into.- Returns:
- The destination dir.
 
- 
setDestinationDirSets the directory to copy files into. This is the same as callingAbstractCopyTask.into(Object)on this task.- Parameters:
- destinationDir- The destination directory. Must not be null.
 
 
-