org.gradle.api.tasks
Class Copy

java.lang.Object
  extended by org.gradle.api.internal.AbstractTask
      extended by org.gradle.api.DefaultTask
          extended by org.gradle.api.internal.ConventionTask
              extended by org.gradle.api.tasks.Copy
All Implemented Interfaces:
groovy.lang.GroovyObject, java.lang.Comparable<Task>, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, Task, CopyAction, CopySpec

public class Copy
extends org.gradle.api.internal.ConventionTask
implements CopyAction

Task for copying files. This task can also rename and filter files as it copies. The task implements CopySpec for specifying what to copy.

Examples:

 task(mydoc, type:Copy) {
    from 'src/main/doc'
    into 'build/target/doc'
 }


 task(initconfig, type:Copy) {
    from('src/main/config') {
       include '**/*.properties'
       include '**/*.xml'
       filter(ReplaceTokens, tokens:[version:'2.3.1'])
    }
    from('src/main/languages') {
       rename 'EN_US_(*.)', '$1'
    }
    into 'build/target/config'
    exclude '**/*.bak', '**/CVS/'
 }
 


Field Summary
 
Fields inherited from interface org.gradle.api.Task
AUTOSKIP_PROPERTY_PREFIX, TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
 
Constructor Summary
Copy(Project project, java.lang.String name)
           
 
Method Summary
 CopySpec exclude(java.lang.String... excludes)
          Adds an ANT style exclude pattern to the copy specification.
 CopySpec filter(java.lang.Class<java.io.FilterReader> filterType)
          Adds a content filter to be used during the copy.
 CopySpec filter(java.util.Map<java.lang.String,java.lang.Object> map, java.lang.Class<java.io.FilterReader> filterType)
          Adds a content filter to be used during the copy.
 CopySpec from(java.lang.Iterable<java.lang.Object> sourcePaths)
          Specifies sources for a copy.
 CopySpec from(java.lang.Iterable<java.lang.Object> sourcePaths, groovy.lang.Closure c)
          Specifies sources for a copy and creates a child CopySpec which is configured with the Closure.
 CopySpec from(java.lang.Object... sourcePaths)
          Specifies sources for a copy.
 CopySpec from(java.lang.Object sourcePath, groovy.lang.Closure c)
          Specifies the source for a copy and creates a child CopySpec.
 java.io.File getDestinationDir()
           
 java.util.List<? extends CopySpec> getLeafSyncSpecs()
           
 CopySpec getRootSyncSpec()
           
 java.util.List getSrcDirs()
           
static void globalExclude(java.lang.String... excludes)
          Set the exclude patterns used by all Copy tasks.
 CopySpec include(java.lang.String... includes)
          Adds an ANT style include pattern to the copy specification.
 CopySpec into(java.lang.Object destDir)
          Specifies the destination directory for a copy.
 CopySpec remapTarget(groovy.lang.Closure closure)
          Maps a source file to a different relative location under the target directory.
 CopySpec rename(java.lang.String sourceRegEx, java.lang.String replaceWith)
          Renames files based on a regular expression.
 void setCaseSensitive(boolean caseSensitive)
          Set case sensitivity for comparisons.
 void setDestinationDir(java.io.File destinationDir)
           
 void setSrcDirs(java.util.List srcDirs)
           
 
Methods inherited from class org.gradle.api.internal.ConventionTask
conv, conventionMapping, conventionMapping, conventionProperty, getConventionAwareHelper, getConventionMapping, setConventionAwareHelper, setConventionMapping
 
Methods inherited from class org.gradle.api.DefaultTask
configure, doFirst, doLast, leftShift, methodMissing, propertyMissing, setProperty
 
Methods inherited from class org.gradle.api.internal.AbstractTask
captureStandardOutput, compareTo, defineProperty, deleteAllActions, dependsOn, dependsOnTaskDidWork, disableStandardOutputCapture, doFirst, doLast, equals, execute, getActions, getAdditionalProperties, getAnt, getConvention, getDependsOn, getDescription, getDidWork, getDynamicObjectHelper, getEnabled, getExecuted, getLogger, getName, getPath, getProject, getSkipProperties, getStandardOutputCapture, getTaskDependencies, hashCode, hasProperty, isDidWork, isEnabled, isExecuted, onlyIf, onlyIf, property, setActions, setAdditionalProperties, setDependsOn, setDescription, setDidWork, setEnabled, setExecuted, setName, setProject, setSkipProperties, setStandardOutputCapture, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.gradle.api.tasks.copy.CopyAction
execute, getDidWork
 
Methods inherited from interface groovy.lang.GroovyObject
getMetaClass, getProperty, invokeMethod, setMetaClass
 

Constructor Detail

Copy

public Copy(Project project,
            java.lang.String name)
Method Detail

globalExclude

public static void globalExclude(java.lang.String... excludes)
Set the exclude patterns used by all Copy tasks. This is typically used to set VCS type excludes like:
 Copy.globalExclude( '**/.svn/' )
 
Note that there are no global excludes by default. Unlike CopySpec.exclude, this does not add a new exclude pattern, it sets (or resets) the exclude patterns. You can't use sequential calls to this method to add multiple global exclude patterns.

Parameters:
excludes - exclude patterns to use

getSrcDirs

public java.util.List getSrcDirs()

setSrcDirs

public void setSrcDirs(java.util.List srcDirs)

getDestinationDir

public java.io.File getDestinationDir()

setDestinationDir

public void setDestinationDir(java.io.File destinationDir)

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)
Set case sensitivity for comparisons.

Specified by:
setCaseSensitive in interface CopyAction
Parameters:
caseSensitive -

getLeafSyncSpecs

public java.util.List<? extends CopySpec> getLeafSyncSpecs()
Specified by:
getLeafSyncSpecs in interface CopyAction

getRootSyncSpec

public CopySpec getRootSyncSpec()
Specified by:
getRootSyncSpec in interface CopyAction

from

public CopySpec from(java.lang.Object... sourcePaths)
Specifies sources for a copy. The toString() method of each sourcePath is used to get a path. The paths are evaluated like Project.file() . Relative paths will be evaluated relative to the project directory.

Specified by:
from in interface CopySpec
Parameters:
sourcePaths - Paths to source directories for the copy

from

public CopySpec from(java.lang.Object sourcePath,
                     groovy.lang.Closure c)
Specifies the source for a copy and creates a child CopySpec. SourcePath.toString is used as the path. The source is set on the child CopySpec, not on this one. This may be a path to a single file to copy or to a directory. If the path is to a directory, then the contents of the directory will be copied. The paths are evaluated like Project.file() .

Specified by:
from in interface CopySpec
Parameters:
sourcePath - Path to source for the copy
c - closure for configuring the child CopySpec

from

public CopySpec from(java.lang.Iterable<java.lang.Object> sourcePaths)
Specifies sources for a copy. The paths are evaluated like Project.file() .

Specified by:
from in interface CopySpec
Parameters:
sourcePaths - Paths to source directories for the copy

from

public CopySpec from(java.lang.Iterable<java.lang.Object> sourcePaths,
                     groovy.lang.Closure c)
Specifies sources for a copy and creates a child CopySpec which is configured with the Closure. The sources are set on the child CopySpec, not on this one. The paths are evaluated like Project.file() .

Specified by:
from in interface CopySpec
Parameters:
sourcePaths - Paths to source directories for the copy
c - Closure for configuring the child CopySpec

into

public CopySpec into(java.lang.Object destDir)
Specifies the destination directory for a copy.

Specified by:
into in interface CopySpec
Parameters:
destDir - Destination directory

include

public CopySpec include(java.lang.String... includes)
Adds an ANT style include pattern to the copy specification. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. Patterns may include: Either '/' or '\' may be used in a pattern to separate directories. Patterns ending with '/' or '\' will have '**' automatically appended. Examples:
 all files ending with 'jsp' (including subdirectories)
    **/*.jsp

 all files beginning with 'template_' in the level1/level2 directory
    level1/level2/template_*

 all files (including subdirectories) beneath src/main/webapp
   src/main/webapp/

 all files beneath any CVS directory (including subdirectories) under src/main/java
   src/main/java/**/CVS/**
 
If this method is not called, then all files beneath the source directory will be included. If this method is called, then a file must match at least one of the include patterns to be copied.

Specified by:
include in interface CopySpec
Parameters:
includes - a vararg list of include patterns

exclude

public CopySpec exclude(java.lang.String... excludes)
Adds an ANT style exclude pattern to the copy specification. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. See include for a description of the syntax for patterns. If this method is not called, then no files will be excluded. If this method is called, then files must not match any exclude pattern to be copied.

Specified by:
exclude in interface CopySpec
Parameters:
excludes - a vararg list of exclude patterns

remapTarget

public CopySpec remapTarget(groovy.lang.Closure closure)
Maps a source file to a different relative location under the target directory. The closure will be called with a single parameter, the File object for the default location of the copy. This File will have the same relative path from the destination directory that the source file has from its source directory. The closure should return a File object with a new target destination.

Specified by:
remapTarget in interface CopySpec
Parameters:
closure - remap closure

rename

public CopySpec rename(java.lang.String sourceRegEx,
                       java.lang.String replaceWith)
Renames files based on a regular expression. Uses java.util.regex type of regular expressions. Note that the replace string should use the '$1' syntax to refer to capture groups in the source regular expression. Files that do not match the source regular expression will be copied with the original name.

Example:

 rename '(.*)_OEM_BLUE_(.*)', '$1$2'
 
would map the file 'style_OEM_BLUE_.css' to 'style.css'

Specified by:
rename in interface CopySpec
Parameters:
sourceRegEx - Source regular expression
replaceWith - Replacement string (use $ syntax for capture groups)

filter

public CopySpec filter(java.util.Map<java.lang.String,java.lang.Object> map,
                       java.lang.Class<java.io.FilterReader> filterType)
Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to the filter chain. Each filter should implement java.io.FilterReader. Include org.apache.tools.ant.filters.* for access to all the standard ANT filters.

Filter parameters may be specified using groovy map syntax.

Examples:

    filter(HeadFilter, lines:25, skip:2)
    filter(ReplaceTokens, tokens:[copyright:'2009', version:'2.3.1'])
 

Specified by:
filter in interface CopySpec
Parameters:
map - map of filter parameters
filterType - Class of filter to add

filter

public CopySpec filter(java.lang.Class<java.io.FilterReader> filterType)
Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to the filter chain. Each filter should implement java.io.FilterReader. Include org.apache.tools.ant.filters.* for access to all the standard ANT filters.

Examples:

    filter(StripJavaComments)
    filter(com.mycompany.project.CustomFilter)
 

Specified by:
filter in interface CopySpec
Parameters:
filterType - Class of filter to add