Sync

@DisableCachingByDefault(because = "Not worth caching")

abstract class Sync : AbstractCopyTask(source)

Synchronizes the contents of a destination directory with some source directories and files.

This task is like the Copy task, except the destination directory will only contain the files copied. All files that exist in the destination directory will be deleted before copying files, unless a preserve is specified.

Examples:


// Sync can be used like a Copy task
// See the Copy documentation for more examples
task syncDependencies(type: Sync) {
    from 'my/shared/dependencyDir'
    into 'build/deps/compile'
}

// You can preserve output that already exists in the
// destination directory. Files matching the preserve
// filter will not be deleted.
task sync(type: Sync) {
    from 'source'
    into 'dest'
    preserve {
        include 'extraDir/**'
        include 'dir1/**'
        exclude 'dir1/extra.txt'
    }
}

Constructors

Sync

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.