Package org.gradle.api.tasks
Class Sync
java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.AbstractCopyTask
org.gradle.api.tasks.Sync
- All Implemented Interfaces:
- 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,- Named,- ExtensionAware,- Task,- PatternFilterable,- Configurable<Task>
@DisableCachingByDefault(because="Not worth caching")
public abstract class Sync
extends AbstractCopyTask
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(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'
     }
 }
 - 
Nested Class SummaryNested classes/interfaces inherited from interface org.gradle.api.TaskTask.Namer
- 
Field SummaryFields inherited from interface org.gradle.api.TaskTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected org.gradle.api.internal.file.copy.CopyActionprotected org.gradle.api.internal.file.copy.CopySpecInternalprotected org.gradle.internal.file.DeleterReturns the directory to copy files into.Returns the filter that defines which files to preserve in the destination directory.org.gradle.api.internal.file.copy.DestinationRootCopySpecpreserve(Action<? super PatternFilterable> action) Configures the filter that defines which files to preserve in the destination directory.voidsetDestinationDir(File destinationDir) Sets the directory to copy files into.Methods inherited from class org.gradle.api.tasks.AbstractCopyTaskcopy, 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, getPropertyFactory, getSource, include, include, include, include, into, into, into, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setFilteringCharset, setIncludeEmptyDirs, setIncludes, withMethods inherited from class org.gradle.api.internal.ConventionTaskconventionMapping, conventionMapping, getConventionMappingMethods inherited from class org.gradle.api.DefaultTaskcompareTo, 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, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTaskacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.TaskdoNotTrackState, getConvention, notCompatibleWithConfigurationCache
- 
Constructor Details- 
Syncpublic Sync()
 
- 
- 
Method Details- 
createCopyActionprotected org.gradle.api.internal.file.copy.CopyAction createCopyAction()- Specified by:
- createCopyActionin class- AbstractCopyTask
 
- 
createRootSpecprotected org.gradle.api.internal.file.copy.CopySpecInternal createRootSpec()- Overrides:
- createRootSpecin class- AbstractCopyTask
 
- 
getRootSpecpublic org.gradle.api.internal.file.copy.DestinationRootCopySpec getRootSpec()- Specified by:
- getRootSpecin interface- org.gradle.api.internal.file.copy.CopySpecSource
- Overrides:
- getRootSpecin class- AbstractCopyTask
 
- 
getDestinationDirReturns the directory to copy files into.- Returns:
- The destination dir.
 
- 
setDestinationDirSets the directory to copy files into. This is the same as callingAbstractCopyTask.into(Object)on this task.- Parameters:
- destinationDir- The destination directory. Must not be null.
 
- 
getPreserveReturns the filter that defines which files to preserve in the destination directory.- Returns:
- the filter defining the files to preserve
- See Also:
 
- 
preserveConfigures the filter that defines which files to preserve in the destination directory.- Parameters:
- action- Action for configuring the preserve filter
- Returns:
- this
- See Also:
 
- 
getDeleter@Inject protected org.gradle.internal.file.Deleter getDeleter()
 
-