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: @Nullable ConventionMapping

description

@get:Nullable

open var description: @Nullable String

enabled

open var enabled: Boolean

group

@get:Nullable

open var group: @Nullable String

impliesSubProjects

open var impliesSubProjects: Boolean

rootSpec

@get:Internal

val rootSpec: CopySpecInternal

state

val state: TaskStateInternal

TASK_ACTION

val TASK_ACTION: String = "action"

TASK_CONSTRUCTOR_ARGS

val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"

Constructor arguments for the Task

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(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

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

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

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.

getPreserve

@Internal

open fun getPreserve(): PatternFilterable

Returns the filter that defines which files to preserve in the destination directory.

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>)

preserve

open fun preserve(action: Action<in PatternFilterable>): Sync

Configures the filter that defines which files to preserve in the destination directory.

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>)

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.

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.