Copy

@DisableCachingByDefault(because = "Not worth caching")

abstract class Copy : AbstractCopyTask(source)

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
}

Since

0.7

Inheritors

ProcessResources

Constructors

Copy

constructor()

Properties

conventionMapping

open val conventionMapping: @Nullable ConventionMapping

description

@get:Nullable

open var description: @Nullable String

enabled

open var enabled: Boolean

extra

val ExtensionAware.extra: ExtraPropertiesExtension

The extra properties extension in this object's extension container.

group

@get:Nullable

open var group: @Nullable String

impliesSubProjects

open var impliesSubProjects: Boolean

loggingManager

open val loggingManager: LoggingManagerInternal

rootSpec

@get:Internal

val rootSpec: CopySpecInternal

state

val state: TaskStateInternal

TASK_ACTION

val TASK_ACTION: String = "action"

The task action.

TASK_CONSTRUCTOR_ARGS

val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"

Constructor arguments for the Task

TASK_DEPENDS_ON

val TASK_DEPENDS_ON: String = "dependsOn"

The task depends on.

TASK_DESCRIPTION

val TASK_DESCRIPTION: String = "description"

The task description.

TASK_GROUP

val TASK_GROUP: String = "group"

The task group.

TASK_NAME

val TASK_NAME: String = "name"

The task name.

TASK_OVERWRITE

val TASK_OVERWRITE: String = "overwrite"

The task overwrite.

TASK_TYPE

val TASK_TYPE: String = "type"

The task type.

timeout

val timeout: Property<Duration>

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task>)

compareTo

open fun compareTo(otherTask: Task): Int

configure

open fun configure(closure: Closure): Task

abstract fun configure(configureClosure: Closure): Task

open fun configure(closure: Closure): Task

Applies the statements of the closure against this task object.

abstract fun configure(cl: Closure): T

Configure.

configure

inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

Executes the given configuration block against the extension of the specified type.

conventionMapping

open fun conventionMapping(property: String, mapping: Callable<out Any>): Task

dependsOn

open fun dependsOn(paths: Array<Any>): Task

Adds the given dependencies to this task.

dirPermissions

open fun dirPermissions(configureAction: Action<in ConfigurableFilePermissions>): CopyProcessingSpec

Configuration action for specifying directory access permissions.

doFirst

open fun doFirst(action: Closure): Task

abstract fun doFirst(@DelegatesTo(value = Task::class) action: Closure): Task

Adds the given closure to the beginning of this task's action list.

open fun doFirst(action: Action<in Task>): Task

open fun doFirst(actionName: String, action: Action<in Task>): Task

open fun doFirst(action: Action<in Task>): Task

Adds the given Action to the beginning of this task's action list.

doLast

open fun doLast(action: Closure): Task

abstract fun doLast(@DelegatesTo(value = Task::class) action: Closure): Task

Adds the given closure to the end of this task's action list.

open fun doLast(action: Action<in Task>): Task

open fun doLast(actionName: String, action: Action<in Task>): Task

open fun doLast(action: Action<in Task>): Task

Adds the given Action to the end of this task's action list.

doNotTrackState

abstract fun doNotTrackState(reasonNotToTrackState: String)

open fun doNotTrackState(reasonNotToTrackState: String)

Do not track the state of the task.

doNotTrackStateIf

open fun doNotTrackStateIf(reason: String, spec: Spec<in TaskInternal>)

eachFile

abstract fun eachFile(@DelegatesTo(value = FileCopyDetails::class, strategy = Closure.DELEGATE_FIRST) closure: Closure): CopyProcessingSpec

abstract fun eachFile(@DelegatesTo(value = FileCopyDetails::class) closure: Closure): CopySpec

Adds an action to be applied to each file as it about to be copied into its destination.

abstract fun eachFile(action: Action<in FileCopyDetails>): CopyProcessingSpec

abstract fun eachFile(action: Action<in FileCopyDetails>): CopySpec

Adds an action to be applied to each file as it is about to be copied into its destination.

open fun eachFile(closure: Closure): AbstractCopyTask

open fun eachFile(action: Action<in FileCopyDetails>): AbstractCopyTask

exclude

abstract fun exclude(excludeSpec: Closure): CopySpec

abstract fun exclude(excludeSpec: Spec<FileTreeElement>): CopySpec

abstract fun exclude(excludeSpec: Closure): PatternFilterable

abstract fun exclude(excludeSpec: Spec<FileTreeElement>): PatternFilterable

Adds an exclude spec.

abstract fun exclude(excludes: Iterable<String>): CopySpec

abstract fun exclude(excludes: Array<String>): CopySpec

abstract fun exclude(excludes: Iterable<String>): PatternFilterable

abstract fun exclude(excludes: Array<String>): PatternFilterable

Adds an Ant style exclude pattern.

open fun exclude(excludeSpec: Closure): AbstractCopyTask

open fun exclude(excludes: Iterable<String>): AbstractCopyTask

open fun exclude(excludes: Array<String>): AbstractCopyTask

open fun exclude(excludeSpec: Spec<FileTreeElement>): AbstractCopyTask

expand

abstract fun expand(properties: Map<String, out Any>): ContentFilterable

abstract fun expand(properties: Map<String, out Any>, action: Action<in ExpandDetails>): ContentFilterable

abstract fun expand(properties: Map<String, out Any>): CopySpec

abstract fun expand(properties: Map<String, out Any>, action: Action<in ExpandDetails>): CopySpec

Expands property references in each file as it is copied.

open fun expand(properties: Map<String, out Any>): AbstractCopyTask

open fun expand(properties: Map<String, out Any>, action: Action<in ExpandDetails>): AbstractCopyTask

expand

inline fun ContentFilterable.expand(vararg properties: Pair<String, Any>): ContentFilterable

inline fun ContentFilterable.expand(vararg properties: Pair<String, Any>, action: Action<in ExpandDetails>): ContentFilterable

Kotlin extension function for org.gradle.api.file.ContentFilterable.expand.

inline fun CopySpec.expand(vararg properties: Pair<String, Any>): CopySpec

inline fun CopySpec.expand(vararg properties: Pair<String, Any>, action: Action<in ExpandDetails>): CopySpec

Kotlin extension function for org.gradle.api.file.CopySpec.expand.

inline fun AbstractCopyTask.expand(vararg properties: Pair<String, Any>): AbstractCopyTask

inline fun AbstractCopyTask.expand(vararg properties: Pair<String, Any>, action: Action<in ExpandDetails>): AbstractCopyTask

Kotlin extension function for org.gradle.api.tasks.AbstractCopyTask.expand.

filePermissions

open fun filePermissions(configureAction: Action<in ConfigurableFilePermissions>): CopyProcessingSpec

Configuration action for specifying file access permissions.

filesMatching

abstract fun filesMatching(patterns: Iterable<String>, action: Action<in FileCopyDetails>): CopySpec

Configure the org.gradle.api.file.FileCopyDetails for each file whose path matches any of the specified Ant-style patterns.

abstract fun filesMatching(pattern: String, action: Action<in FileCopyDetails>): CopySpec

Configure the org.gradle.api.file.FileCopyDetails for each file whose path matches the specified Ant-style pattern.

open fun filesMatching(patterns: Iterable<String>, action: Action<in FileCopyDetails>): AbstractCopyTask

Configure the for each file whose path matches any of the specified Ant-style patterns.

open fun filesMatching(pattern: String, action: Action<in FileCopyDetails>): AbstractCopyTask

Configure the for each file whose path matches the specified Ant-style pattern.

filesNotMatching

abstract fun filesNotMatching(patterns: Iterable<String>, action: Action<in FileCopyDetails>): CopySpec

Configure the org.gradle.api.file.FileCopyDetails for each file whose path does not match any of the specified Ant-style patterns.

abstract fun filesNotMatching(pattern: String, action: Action<in FileCopyDetails>): CopySpec

Configure the org.gradle.api.file.FileCopyDetails for each file whose path does not match the specified Ant-style pattern.

open fun filesNotMatching(patterns: Iterable<String>, action: Action<in FileCopyDetails>): AbstractCopyTask

Configure the for each file whose path does not match any of the specified Ant-style patterns.

open fun filesNotMatching(pattern: String, action: Action<in FileCopyDetails>): AbstractCopyTask

Configure the for each file whose path does not match the specified Ant-style pattern.

filter

abstract fun filter(closure: Closure): ContentFilterable

abstract fun filter(closure: Closure): CopySpec

Adds a content filter based on the provided closure.

abstract fun filter(filterType: Class<out FilterReader>): ContentFilterable

abstract fun filter(properties: Map<String, out Any>, filterType: Class<out FilterReader>): ContentFilterable

abstract fun filter(filterType: Class<out FilterReader>): CopySpec

abstract fun filter(properties: Map<String, out Any>, filterType: Class<out FilterReader>): CopySpec

Adds a content filter to be used during the copy.

abstract fun filter(transformer: Transformer<@Nullable String, String>): ContentFilterable

abstract fun filter(transformer: Transformer<@Nullable String, String>): CopySpec

Adds a content filter based on the provided transformer.

open fun filter(closure: Closure): AbstractCopyTask

open fun filter(filterType: Class<out FilterReader>): AbstractCopyTask

open fun filter(transformer: Transformer<@Nullable String, String>): AbstractCopyTask

open fun filter(properties: Map<String, out Any>, filterType: Class<out FilterReader>): AbstractCopyTask

filter

inline fun <T : FilterReader> ContentFilterable.filter(properties: Map<String, Any?>): ContentFilterable?

inline fun <T : FilterReader> ContentFilterable.filter(vararg properties: Pair<String, Any?>): ContentFilterable?

fun <T : FilterReader> ContentFilterable.filter(filterType: KClass<T>, properties: Map<String, Any?>): ContentFilterable?

fun <T : FilterReader> ContentFilterable.filter(filterType: KClass<T>, vararg properties: Pair<String, Any?>): ContentFilterable?

Adds a content filter to be used during the copy. Multiple calls add additional filters to the filter chain. Each filter should implement FilterReader. Import org.apache.tools.ant.filters.* for access to all the standard Ant filters.

inline fun ContentFilterable.filter(filterType: KClass<out FilterReader>): ContentFilterable

inline fun ContentFilterable.filter(filterType: KClass<out FilterReader>, vararg properties: Pair<String, Any>): ContentFilterable

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.file.ContentFilterable.filter.

inline fun <T : FilterReader> CopySpec.filter(properties: Map<String, Any?>): CopySpec?

inline fun <T : FilterReader> CopySpec.filter(vararg properties: Pair<String, Any?>): CopySpec?

Adds a content filter to be used during the copy.

inline fun CopySpec.filter(filterType: KClass<out FilterReader>): CopySpec

inline fun CopySpec.filter(filterType: KClass<out FilterReader>, vararg properties: Pair<String, Any>): CopySpec

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.file.CopySpec.filter.

inline fun AbstractCopyTask.filter(filterType: KClass<out FilterReader>): AbstractCopyTask

inline fun AbstractCopyTask.filter(filterType: KClass<out FilterReader>, vararg properties: Pair<String, Any>): AbstractCopyTask

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.tasks.AbstractCopyTask.filter.

finalizedBy

open fun finalizedBy(paths: Array<Any>): Task

Adds the given finalizer tasks for this task.

from

abstract fun from(@Nullable sourcePaths: Array<@Nullable Any>): CopySourceSpec

abstract fun from(@Nullable sourcePaths: Array<@Nullable Any>): CopySpec

Specifies source files or directories for a copy.

abstract fun from(sourcePath: Any, @DelegatesTo(value = CopySpec::class) configureClosure: Closure): CopySourceSpec

Specifies the source files or directories for a copy and creates a child CopySourceSpec.

abstract fun from(sourcePath: Any, configureAction: Action<in CopySpec>): CopySourceSpec

Specifies the source files or directories for a copy and creates a child CopySpec.

abstract fun from(sourcePath: Any, @DelegatesTo(value = CopySpec::class) c: Closure): CopySpec

Specifies the source files or directories for a copy and creates a child CopySourceSpec}.

abstract fun from(sourcePath: Any, configureAction: Action<in CopySpec>): CopySpec

Specifies the source files or directories for a copy and creates a child CopySpec}.

open fun from(@Nullable sourcePaths: Array<@Nullable Any>): AbstractCopyTask

open fun from(sourcePath: Any, c: Closure): AbstractCopyTask

open fun from(sourcePath: Any, configureAction: Action<in CopySpec>): AbstractCopyTask

getActions

open fun getActions(): List<Action<in Task>>

Returns the sequence of Action objects which will be executed by this task, in the order of execution.

getAnt

open fun getAnt(): AntBuilder

Returns the AntBuilder for this task.

getAsDynamicObject

open fun getAsDynamicObject(): DynamicObject

getDependsOn

open fun getDependsOn(): Set<Any>

Returns the dependencies of this task.

getDestinationDir

@OutputDirectory

open fun getDestinationDir(): File

Returns the directory to copy files into.

getDestroyables

open fun getDestroyables(): TaskDestroyables

Returns the destroyables of this task.

getDidWork

open fun getDidWork(): Boolean

Checks if the task actually did any work.

getDirPermissions

@Internal

open fun getDirPermissions(): Property<ConfigurableFilePermissions>

Property for querying and configuring directory access permissions.

getDuplicatesStrategy

@Internal

open fun getDuplicatesStrategy(): DuplicatesStrategy

Returns the strategy to use when trying to copy more than one file to the same destination.

getExcludes

@Internal

open fun getExcludes(): Set<String>

Returns the set of exclude patterns.

getExtensions

open fun getExtensions(): ExtensionContainer

The container of extensions.

getFilePermissions

@Internal

open fun getFilePermissions(): Property<ConfigurableFilePermissions>

Property for querying and configuring file access permissions.

getFilteringCharset

@Internal

open fun getFilteringCharset(): String

Gets the charset used to read and write files when filtering.

getFinalizedBy

open fun getFinalizedBy(): TaskDependency

Returns tasks that finalize this task.

getIdentityPath

open fun getIdentityPath(): Path

getIncludeEmptyDirs

@Internal

open fun getIncludeEmptyDirs(): Boolean

Tells if empty target directories will be included in the copy.

getIncludes

@Internal

open fun getIncludes(): Set<String>

Returns the set of include patterns.

getInputs

open fun getInputs(): TaskInputsInternal

@Internal

abstract fun getInputs(): TaskInputs

open fun getInputs(): TaskInputsInternal

Returns the inputs of this task.

getLifecycleDependencies

open fun getLifecycleDependencies(): TaskDependencyInternal

abstract fun getLifecycleDependencies(): TaskDependency

getLocalState

open fun getLocalState(): TaskLocalState

Returns the local state of this task.

getLogger

open fun getLogger(): Logger

Returns the logger for this task.

getLogging

open fun getLogging(): LoggingManager

Returns the org.gradle.api.logging.LoggingManager which can be used to receive logging and to control the standard output/error capture for this task.

getMustRunAfter

open fun getMustRunAfter(): TaskDependency

Returns tasks that this task must run after.

getName

open fun getName(): String

Returns the name of this task.

getOnlyIf

open fun getOnlyIf(): Spec<in TaskInternal>

getOutputs

open fun getOutputs(): TaskOutputsInternal

@Internal

abstract fun getOutputs(): TaskOutputs

open fun getOutputs(): TaskOutputsInternal

Returns the outputs of this task.

getPath

open fun getPath(): String

Returns the path of the task, which is a fully qualified name for the task.

getProject

open fun getProject(): Project

Returns the Project which this task belongs to.

getReasonNotToTrackState

open fun getReasonNotToTrackState(): Optional<String>

getReasonsNotToTrackState

open fun getReasonsNotToTrackState(): Set<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open fun getRequiredServices(): TaskRequiredServices

getRootSpec

open fun getRootSpec(): DestinationRootCopySpec

getSharedResources

open fun getSharedResources(): List<ResourceLock>

abstract fun getSharedResources(): List<out ResourceLock>

getShouldRunAfter

open fun getShouldRunAfter(): TaskDependency

Returns tasks that this task should run after.

getSource

@Internal

open fun getSource(): FileCollection

Returns the source files for this task.

getStandardOutputCapture

open fun getStandardOutputCapture(): StandardOutputCapture

getState

@Internal

abstract fun getState(): TaskState

Returns the execution state of this task.

getTaskActions

open fun getTaskActions(): List<InputChangesAwareTaskAction>

getTaskDependencies

open fun getTaskDependencies(): TaskDependencyInternal

@Internal

abstract fun getTaskDependencies(): TaskDependency

open fun getTaskDependencies(): TaskDependencyInternal

Returns a TaskDependency which contains all the tasks that this task depends on.

getTaskIdentity

open fun getTaskIdentity(): TaskIdentity<out Any>

getTemporaryDir

open fun getTemporaryDir(): File

Returns a directory which this task can use to write temporary files to.

getTemporaryDirFactory

open fun getTemporaryDirFactory(): Factory<File>

hasProperty

open fun hasProperty(propertyName: String): Boolean

Determines if this task has the given property.

hasTaskActions

open fun hasTaskActions(): Boolean

include

abstract fun include(includeSpec: Closure): CopySpec

abstract fun include(includeSpec: Spec<FileTreeElement>): CopySpec

abstract fun include(includeSpec: Closure): PatternFilterable

abstract fun include(includeSpec: Spec<FileTreeElement>): PatternFilterable

Adds an include spec.

abstract fun include(includes: Iterable<String>): CopySpec

abstract fun include(includes: Array<String>): CopySpec

abstract fun include(includes: Iterable<String>): PatternFilterable

abstract fun include(includes: Array<String>): PatternFilterable

Adds an Ant style include pattern.

open fun include(includeSpec: Closure): AbstractCopyTask

open fun include(includes: Iterable<String>): AbstractCopyTask

open fun include(includes: Array<String>): AbstractCopyTask

open fun include(includeSpec: Spec<FileTreeElement>): AbstractCopyTask

injectIntoNewInstance

open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T

into

abstract fun into(destPath: Any): CopyProcessingSpec

abstract fun into(destPath: Any): CopySpec

Specifies the destination directory for a copy.

abstract fun into(destPath: Any, @DelegatesTo(value = CopySpec::class) configureClosure: Closure): CopySpec

Creates and configures a child CopySpec with the given destination path.

open fun into(destDir: Any): AbstractCopyTask

open fun into(destPath: Any, configureClosure: Closure): AbstractCopyTask

open fun into(destPath: Any, copySpec: Action<in CopySpec>): CopySpec

Creates and configures a child CopySpec} with the given destination path.

isCaseSensitive

@Internal

open fun isCaseSensitive(): Boolean

Specifies whether case-sensitive pattern matching should be used.

isCompatibleWithConfigurationCache

open fun isCompatibleWithConfigurationCache(): Boolean

isEnabled

open fun isEnabled(): Boolean

isHasCustomActions

open fun isHasCustomActions(): Boolean

mustRunAfter

open fun mustRunAfter(paths: Array<Any>): Task

Specifies that this task must run after all of the supplied tasks.

notCompatibleWithConfigurationCache

abstract fun notCompatibleWithConfigurationCache(reason: String)

open fun notCompatibleWithConfigurationCache(reason: String)

Specifies that this task is not compatible with the configuration cache.

onlyIf

open fun onlyIf(onlyIfClosure: Closure)

abstract fun onlyIf(onlyIfClosure: Closure<out Any>)

open fun onlyIf(onlyIfClosure: Closure)

Execute the task only if the given closure returns true.

open fun onlyIf(spec: Spec<in Task>)

open fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)

abstract fun onlyIf(onlyIfSpec: Spec<in Task>)

@Incubating

abstract fun onlyIf(onlyIfReason: String, onlyIfSpec: Spec<in Task>)

Execute the task only if the given spec is satisfied.

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task>)

property

open fun property(propertyName: String): Any

Returns the value of the given property of this task.

rename

abstract fun rename(closure: Closure): CopyProcessingSpec

abstract fun rename(renamer: Transformer<@Nullable String, String>): CopyProcessingSpec

abstract fun rename(closure: Closure): CopySpec

abstract fun rename(renamer: Transformer<@Nullable String, String>): CopySpec

Renames a source file.

abstract fun rename(sourceRegEx: String, replaceWith: String): CopyProcessingSpec

abstract fun rename(sourceRegEx: String, replaceWith: String): CopySpec

abstract fun rename(sourceRegEx: Pattern, replaceWith: String): CopyProcessingSpec

Renames files based on a regular expression.

open fun rename(closure: Closure): AbstractCopyTask

open fun rename(renamer: Transformer<@Nullable String, String>): AbstractCopyTask

open fun rename(sourceRegEx: String, replaceWith: String): AbstractCopyTask

open fun rename(sourceRegEx: Pattern, replaceWith: String): AbstractCopyTask

restoreOnlyIf

open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal>)

restoreTaskActions

open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction>)

service

@Incubating

abstract fun <T : TaskService?> service(serviceType: Class<T>): T

open fun <T : TaskService?> service(serviceType: Class<T>): T

Looks up a service provided by Gradle for use in this task.

service

@Incubating

inline fun <T : TaskService> Task.service(): T

Looks up a service provided by Gradle for use in this task.

@Incubating

inline fun <T : TaskService> Task.service(serviceType: KClass<T>): T

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.Task.service.

setActions

open fun setActions(replacements: List<Action<in Task>>)

abstract fun setActions(actions: List<Action<in Task>>)

open fun setActions(replacements: List<Action<in Task>>)

Sets the sequence of Action objects which will be executed by this task.

setCaseSensitive

open fun setCaseSensitive(caseSensitive: Boolean)

Specifies whether case-sensitive pattern matching should be used for this CopySpec.

setDependsOn

open fun setDependsOn(dependsOn: Iterable<out Any>)

abstract fun setDependsOn(dependsOnTasks: Iterable<out Any>)

open fun setDependsOn(dependsOn: Iterable<out Any>)

Sets the dependencies of this task.

setDestinationDir

open fun setDestinationDir(destinationDir: File)

Sets the directory to copy files into.

setDidWork

open fun setDidWork(didWork: Boolean)

Sets whether the task actually did any work.

setDuplicatesStrategy

open fun setDuplicatesStrategy(strategy: DuplicatesStrategy)

The strategy to use when trying to copy more than one file to the same destination.

setExcludes

abstract fun setExcludes(excludes: Iterable<String>): CopySpec

abstract fun setExcludes(excludes: Iterable<String>): PatternFilterable

Set the allowable exclude patterns.

open fun setExcludes(excludes: Iterable<String>): AbstractCopyTask

setFilteringCharset

open fun setFilteringCharset(charset: String)

Specifies the charset used to read and write files when filtering.

setFinalizedBy

open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)

abstract fun setFinalizedBy(finalizedBy: Iterable<out Any>)

open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)

Specifies the set of finalizer tasks for this task.

setIncludeEmptyDirs

open fun setIncludeEmptyDirs(includeEmptyDirs: Boolean)

Controls if empty target directories should be included in the copy.

setIncludes

abstract fun setIncludes(includes: Iterable<String>): CopySpec

abstract fun setIncludes(includes: Iterable<String>): PatternFilterable

Set the allowable include patterns.

open fun setIncludes(includes: Iterable<String>): AbstractCopyTask

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)

abstract fun setMustRunAfter(mustRunAfter: Iterable<out Any>)

open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)

Specifies the set of tasks that this task must run after.

setOnlyIf

open fun setOnlyIf(onlyIfClosure: Closure)

abstract fun setOnlyIf(onlyIfClosure: Closure<out Any>)

Execute the task only if the given closure returns true.

open fun setOnlyIf(spec: Spec<in Task>)

open fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)

abstract fun setOnlyIf(onlyIfSpec: Spec<in Task>)

@Incubating

abstract fun setOnlyIf(onlyIfReason: String, onlyIfSpec: Spec<in Task>)

open fun setOnlyIf(spec: Spec<in Task>)

Execute the task only if the given spec is satisfied.

setProperty

open fun setProperty(name: String, value: Any)

Sets a property of this task.

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)

abstract fun setShouldRunAfter(shouldRunAfter: Iterable<out Any>)

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)

Specifies the set of tasks that this task should run after.

shouldRunAfter

open fun shouldRunAfter(paths: Array<Any>): TaskDependency

Specifies that this task should run after all of the supplied tasks.

the

inline fun <T : Any> ExtensionAware.the(): T

Returns the extension of the specified type.

fun <T : Any> ExtensionAware.the(extensionType: KClass<T>): T

Returns the extension of the specified extensionType.

usesService

open fun usesService(service: Provider<out BuildService<out Any>>)

Registers a BuildService that is used by this task so its constraint on parallel execution can be honored.

with

open fun with(sourceSpecs: Array<CopySpec>): CopySpec

Adds the given specs as a child of this spec.