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
}

Inheritors

ProcessResources

Constructors

Copy

constructor()

Properties

conventionMapping

open val conventionMapping: ConventionMapping

description

open var description: String

enabled

open var enabled: Boolean

extra

val ExtensionAware.extra: ExtraPropertiesExtension

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

group

open var group: String

impliesSubProjects

open var impliesSubProjects: Boolean

rootSpec

val rootSpec: CopySpecInternal

state

val state: TaskStateInternal

TASK_ACTION

val TASK_ACTION: String = "action"

TASK_CONSTRUCTOR_ARGS

val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"

TASK_DEPENDS_ON

val TASK_DEPENDS_ON: String = "dependsOn"

TASK_DESCRIPTION

val TASK_DESCRIPTION: String = "description"

TASK_GROUP

val TASK_GROUP: String = "group"

TASK_NAME

val TASK_NAME: String = "name"

TASK_OVERWRITE

val TASK_OVERWRITE: String = "overwrite"

TASK_TYPE

val TASK_TYPE: String = "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(cl: Closure): T

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

dirPermissions

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

doFirst

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

doLast

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

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String)

eachFile

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

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

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

exclude

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

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

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

expand

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

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

open fun expand(properties: Map<String, out Any>): 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

filesMatching

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

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

filesNotMatching

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

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

filter

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

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

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

filter

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

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

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

fun <T : FilterReader> ContentFilterable.filter(filterType: KClass<T>, properties: Map<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.