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, DynamicObjectAware, CopySpecSource, IConventionAware, TaskInternal, ExtensionAware, Task, PatternFilterable, Configurable<Task>

Direct Known Subclasses:

ProcessResources

public 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 mydoc(type:Copy) {
    from 'src/main/doc'
    into 'build/target/doc'
 }

 //for ant filter
 import org.apache.tools.ant.filters.ReplaceTokens

 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
 }
 

Author:

Steve Appling

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

Task.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
Copy()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	configureRootSpec()
FileCopyActionImpl	getCopyAction()
File	getDestinationDir() Returns the directory to copy files into.
void	setCopyAction(FileCopyActionImpl copyAction)
void	setDestinationDir(File destinationDir) Sets the directory to copy files into.

Methods inherited from class org.gradle.api.tasks.AbstractCopyTask

copy, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, filter, filter, filter, from, from, getDefaultSource, getDirMode, getExcludes, getFileMode, getIncludeEmptyDirs, getIncludes, getMainSpec, getRootSpec, getSource, include, include, include, include, into, into, isCaseSensitive, rename, rename, rename, setCaseSensitive, setDirMode, setExcludes, setFileMode, setIncludeEmptyDirs, setIncludes, with

Methods inherited from class org.gradle.api.internal.ConventionTask

conventionMapping, conventionMapping, getConventionMapping

Methods inherited from class org.gradle.api.internal.AbstractTask

addValidator, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, executeWithoutThrowingTaskFailure, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getDynamicObjectHelper, getEnabled, getExecuter, getExtensions, getGroup, getInputs, getLogger, getLogging, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getStandardOutputCapture, getState, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, leftShift, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setGroup, setName, setOnlyIf, setOnlyIf, setProject, setProperty, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Copy

public Copy()

Method Detail

configureRootSpec

protected void configureRootSpec()

Overrides:

configureRootSpec in class AbstractCopyTask

getCopyAction

public FileCopyActionImpl getCopyAction()

Specified by:

getCopyAction in class AbstractCopyTask

setCopyAction

public void setCopyAction(FileCopyActionImpl copyAction)

getDestinationDir

public File getDestinationDir()

Returns the directory to copy files into.

Returns:

The destination dir.

setDestinationDir

public void setDestinationDir(File destinationDir)

Sets the directory to copy files into. This is the same as calling AbstractCopyTask.into(Object) on this task.

Parameters:

destinationDir - The destination directory. Must not be null.