java.lang.Comparable<Task>, ContentFilterable, CopyProcessingSpec, CopySourceSpec, CopySpec, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.file.copy.CopySpecSource, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, PatternFilterable, Configurable<Task>@DisableCachingByDefault(because="Not worth caching") public abstract class Sync extends AbstractCopyTask
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(Action) 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'
}
}
Task.NamerTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE| Constructor | Description |
|---|---|
Sync() |
| Modifier and Type | Method | Description |
|---|---|---|
protected org.gradle.api.internal.file.copy.CopyAction |
createCopyAction() |
|
protected org.gradle.api.internal.file.copy.CopySpecInternal |
createRootSpec() |
|
protected org.gradle.internal.file.Deleter |
getDeleter() |
|
java.io.File |
getDestinationDir() |
Returns the directory to copy files into.
|
PatternFilterable |
getPreserve() |
Returns the filter that defines which files to preserve in the destination directory.
|
org.gradle.api.internal.file.copy.DestinationRootCopySpec |
getRootSpec() |
|
Sync |
preserve(Action<? super PatternFilterable> action) |
Configures the filter that defines which files to preserve in the destination directory.
|
void |
setDestinationDir(java.io.File destinationDir) |
Sets the directory to copy files into.
|
copy, createCopyActionExecuter, dirPermissions, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, expand, filePermissions, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirectoryFileTreeFactory, getDirMode, getDirPermissions, getDocumentationRegistry, getDuplicatesStrategy, getExcludes, getFileLookup, getFileMode, getFilePermissions, getFileResolver, getFileSystem, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getInstantiator, getMainSpec, getObjectFactory, getSource, include, include, include, include, into, into, into, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setFilteringCharset, setIncludeEmptyDirs, setIncludes, withconventionMapping, conventionMapping, getConventionMappingcompareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesServiceacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdoNotTrackState, getConvention, notCompatibleWithConfigurationCacheprotected org.gradle.api.internal.file.copy.CopyAction createCopyAction()
createCopyAction in class AbstractCopyTaskprotected org.gradle.api.internal.file.copy.CopySpecInternal createRootSpec()
createRootSpec in class AbstractCopyTaskpublic org.gradle.api.internal.file.copy.DestinationRootCopySpec getRootSpec()
getRootSpec in interface org.gradle.api.internal.file.copy.CopySpecSourcegetRootSpec in class AbstractCopyTask@OutputDirectory public java.io.File getDestinationDir()
public void setDestinationDir(java.io.File destinationDir)
AbstractCopyTask.into(Object) on this task.destinationDir - The destination directory. Must not be null.@Internal public PatternFilterable getPreserve()
getDestinationDir()public Sync preserve(Action<? super PatternFilterable> action)
action - Action for configuring the preserve filtergetDestinationDir()@Inject protected org.gradle.internal.file.Deleter getDeleter()