allprojects { }
artifacts { }
buildscript { }
configurations { }
dependencies { }
repositories { }
sourceSets { }
subprojects { }
publishing { }
Project
Task
Gradle
Settings
IncludedBuild
Script
JavaToolChain
SourceSet
SourceSetOutput
IncrementalTaskInputs
Configuration
ResolutionStrategy
ArtifactResolutionQuery
ComponentSelection
ComponentSelectionRules
ConventionProperty
GradlePluginPortal
ExtensionAware
ExtraPropertiesExtension
PublishingExtension
IvyPublication
IvyArtifact
IvyArtifactSet
IvyModuleDescriptorSpec
IvyPluginRepository
MavenPublication
MavenArtifact
MavenArtifactSet
MavenPom
MavenPluginRepository
PluginDependenciesSpec
PluginDependencySpec
PluginRepositoriesSpec
PluginRepository
ResourceHandler
TextResourceFactory
ConfigurationContainer
RepositoryHandler
DependencyHandler
ArtifactHandler
TaskReportTask
ProjectReportTask
DependencyReportTask
DependencyInsightReportTask
PropertyReportTask
ComponentReport
DependentComponentsReport
ModelReport
AntlrTask
BuildEnvironmentReportTask
Checkstyle
CodeNarc
CompareGradleBuilds
Copy
CreateStartScripts
Delete
Ear
Exec
FindBugs
GenerateIvyDescriptor
GenerateMavenPom
GenerateBuildDashboard
GradleBuild
GroovyCompile
Groovydoc
HtmlDependencyReportTask
JacocoReport
JacocoMerge
Jar
JavaCompile
Javadoc
JavaExec
JDepend
JettyRun
JettyRunWar
JettyStop
Pmd
PublishToIvyRepository
PublishToMavenRepository
ScalaCompile
ScalaDoc
InitBuild
Sign
Sync
Tar
Test
TestReport
Upload
War
Wrapper
Zip
CustomizableHtmlReport
SingleFileReport
DirectoryReport
FindBugsXmlReport
Report
Reporting
ReportContainer
ReportingExtension
EclipseModel
EclipseProject
EclipseClasspath
EclipseJdt
EclipseWtp
EclipseWtpComponent
EclipseWtpFacet
IdeaModel
IdeaProject
IdeaModule
IdeaWorkspace
XmlFileContentMerger
FileContentMerger
GenerateEclipseProject
GenerateEclipseClasspath
GenerateEclipseJdt
GenerateEclipseWtpComponent
GenerateEclipseWtpFacet
GenerateIdeaModule
GenerateIdeaProject
GenerateIdeaWorkspace
PrebuiltLibrary
PrebuiltSharedLibraryBinary
PrebuiltStaticLibraryBinary
NativeComponentSpec
NativeExecutableSpec
NativeLibrarySpec
NativeTestSuiteSpec
CUnitTestSuiteSpec
GoogleTestTestSuiteSpec
NativeBinarySpec
NativeExecutableBinarySpec
NativeLibraryBinarySpec
SharedLibraryBinarySpec
StaticLibraryBinarySpec
NativeTestSuiteBinarySpec
CUnitTestSuiteBinarySpec
GoogleTestTestSuiteBinarySpec
NativePlatform
BuildType
Flavor
Gcc
Clang
VisualCpp
AssemblerSourceSet
CSourceSet
CppSourceSet
ObjectiveCSourceSet
ObjectiveCppSourceSet
WindowsResourceSet
VisualStudioProject
VisualStudioSolution
NativeExecutable
NativeLibrary
NativeBinary
NativeExecutableBinary
SharedLibraryBinary
StaticLibraryBinary
CppCompile
CCompile
Assemble
ObjectiveCCompile
ObjectiveCppCompile
WindowsResourceCompile
LinkExecutable
LinkSharedLibrary
CreateStaticLibrary
InstallExecutable
RunTestExecutable
API Documentation: | Sync |
---|
Synchronizes the contents of a destination directory with some source directories and files.
This task is like theCopy
task, except the destination directory will only contain the filescopied. All files that exist in the destination directory will be deleted before copying files, unlessaSync.preserve(org.gradle.api.Action)
is specified.
Examples:
// Sync can be used like a Copy task// See the Copy documentation for more examplestask 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' }}
Property | Description |
caseSensitive | Specifies whether case-sensitive pattern matching should be used. |
destinationDir | The directory to copy files into. |
dirMode | The Unix permissions to use for the target directories. |
duplicatesStrategy | The strategy to use when trying to copy more than one file to the same destination. |
excludes | The set of exclude patterns. |
fileMode | The Unix permissions to use for the target files. |
includeEmptyDirs | Tells if empty target directories will be included in the copy. |
includes | The set of include patterns. |
preserve | Incubating The filter that defines which files to preserve in the destination directory. |
source | The source files for this task. |
Method | Description |
eachFile(closure) | Adds an action to be applied to each file as it about to be copied into its destination. The given closure iscalled with a |
eachFile(action) | Adds an action to be applied to each file as it is about to be copied into its destination. The action can changethe destination path of the file, filter the contents of the file, or exclude the file from the result entirely.Actions are executed in the order added, and are inherited from the parent spec. |
exclude(excludeSpec) | Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a |
exclude(excludes) | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed. |
exclude(excludes) | Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed. |
exclude(excludeSpec) | Adds an exclude spec. This method may be called multiple times to append new specs.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed. |
expand(properties) | Expands property references in each file as it is copied. More specifically, each file is transformed usingGroovy's |
filesMatching(patterns, action) | Configure the |
filesMatching(pattern, action) | Configure the |
filesNotMatching(patterns, action) | Configure the |
filesNotMatching(pattern, action) | Configure the |
filter(closure) | Adds a content filter based on the provided closure. The Closure will be called with each line (stripped of lineendings) and should return a String to replace the line or |
filter(filterType) | Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to thefilter chain. Each filter should implement |
filter(properties, filterType) | Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to thefilter chain. Each filter should implement |
filter(transformer) | Adds a content filter based on the provided transformer. The Closure will be called with each line (stripped of lineendings) and should return a String to replace the line or |
from(sourcePath, c) | Specifies the source files or directories for a copy and creates a child |
from(sourcePath, configureAction) | Specifies the source files or directories for a copy and creates a child |
from(sourcePaths) | Specifies source files or directories for a copy. The given paths are evaluated as per |
include(includeSpec) | Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a |
include(includes) | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed. |
include(includes) | Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed. |
include(includeSpec) | Adds an include spec. This method may be called multiple times to append new specs.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns or specs to be included. |
into(destDir) | Specifies the destination directory for a copy. The destination is evaluated as per |
into(destPath, configureClosure) | Creates and configures a child |
into(destPath, copySpec) | Creates and configures a child |
preserve(action) | Incubating Configures the filter that defines which files to preserve in the destination directory. |
rename(closure) | Renames a source file. The closure will be called with a single parameter, the name of the file.The closure should return a String object with a new target name. The closure may return null,in which case the original name will be used. |
rename(sourceRegEx, replaceWith) | Renames files based on a regular expression. Uses java.util.regex type of regular expressions. Note that thereplace string should use the '$1' syntax to refer to capture groups in the source regular expression. Filesthat do not match the source regular expression will be copied with the original name. |
rename(sourceRegEx, replaceWith) | Renames files based on a regular expression. See |
rename(renamer) | Renames a source file. The function will be called with a single parameter, the name of the file.The function should return a new target name. The function may return null,in which case the original name will be used. |
with(sourceSpecs) | Adds the given specs as a child of this spec. |
Integer
dirMode
The Unix permissions to use for the target directories.null
means that existingpermissions are preserved. It is dependent on the copy action implementation whether these permissionswill actually be applied.
null
DuplicatesStrategy
duplicatesStrategy
The strategy to use when trying to copy more than one file to the same destination.
The value can be set with a case insensitive string of the enum value (e.g.'exclude'
forDuplicatesStrategy.EXCLUDE
).
This strategy can be overridden for individual files by usingCopySpec.eachFile(org.gradle.api.Action)
orCopySpec.filesMatching(java.lang.String, org.gradle.api.Action)
.
null
Integer
fileMode
The Unix permissions to use for the target files.null
means that existingpermissions are preserved. It is dependent on the copy action implementation whether these permissionswill actually be applied.
null
PatternFilterable
preserve
(read-only)Note: This property isincubating and may change in a future version of Gradle.
The filter that defines which files to preserve in the destination directory.
empty
AbstractCopyTask
eachFile
(Closure
closure)Adds an action to be applied to each file as it about to be copied into its destination. The given closure iscalled with aFileCopyDetails
as its parameter. Actions are executed in the orderadded, and are inherited from the parent spec.
AbstractCopyTask
eachFile
(Action
<? superFileCopyDetails
>
action)Adds an action to be applied to each file as it is about to be copied into its destination. The action can changethe destination path of the file, filter the contents of the file, or exclude the file from the result entirely.Actions are executed in the order added, and are inherited from the parent spec.
AbstractCopyTask
exclude
(Closure
excludeSpec)Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed aFileTreeElement
as its parameter. The closure should return true or false. Example:
copySpec { from'source' into'destination'//an example of excluding files from certain configuration: exclude { it.file in configurations.someConf.files }}
If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.
AbstractCopyTask
exclude
(Iterable
<String
>
excludes)Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.
AbstractCopyTask
exclude
(String
...
excludes)Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.
AbstractCopyTask
exclude
(Spec
<FileTreeElement
>
excludeSpec)Adds an exclude spec. This method may be called multiple times to append new specs.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.
AbstractCopyTask
expand
(Map
<String
, ?>
properties)Expands property references in each file as it is copied. More specifically, each file is transformed usingGroovy'sSimpleTemplateEngine
. This means you can use simple property references, such as$property
or${property}
in the file. You can also include arbitrary Groovy code in thefile, such as${version ?: 'unknown'}
or${classpath*.name.join(' ')}
AbstractCopyTask
filesMatching
(Iterable
<String
>
patterns,Action
<? superFileCopyDetails
>
action)Configure theFileCopyDetails
for each file whose path matches any of the specified Ant-style patterns.This is equivalent to using eachFile() and selectively applying a configuration based on the file's path.
AbstractCopyTask
filesMatching
(String
pattern,Action
<? superFileCopyDetails
>
action)Configure theFileCopyDetails
for each file whose path matches the specified Ant-style pattern.This is equivalent to using eachFile() and selectively applying a configuration based on the file's path.
AbstractCopyTask
filesNotMatching
(Iterable
<String
>
patterns,Action
<? superFileCopyDetails
>
action)Configure theFileCopyDetails
for each file whose path does not match any of the specifiedAnt-style patterns. This is equivalent to using eachFile() and selectively applying a configuration based on thefile's path.
AbstractCopyTask
filesNotMatching
(String
pattern,Action
<? superFileCopyDetails
>
action)Configure theFileCopyDetails
for each file whose path does not match the specifiedAnt-style pattern. This is equivalent to using eachFile() and selectively applying a configuration based on thefile's path.
AbstractCopyTask
filter
(Closure
closure)Adds a content filter based on the provided closure. The Closure will be called with each line (stripped of lineendings) and should return a String to replace the line ornull
to remove the line. If every line isremoved, the result will be an empty file, not an absent one.
AbstractCopyTask
filter
(Class
<? extendsFilterReader
>
filterType)Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to thefilter chain. Each filter should implementjava.io.FilterReader
. Includeorg.apache.tools.ant.filters.*
for access to all the standard Ant filters.
Examples:
filter(StripJavaComments)filter(com.mycompany.project.CustomFilter)
AbstractCopyTask
filter
(Map
<String
, ?>
properties,Class
<? extendsFilterReader
>
filterType)Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to thefilter chain. Each filter should implementjava.io.FilterReader
. Includeorg.apache.tools.ant.filters.*
for access to all the standard Ant filters.
Filter properties may be specified using groovy map syntax.
Examples:
filter(HeadFilter, lines:25, skip:2)filter(ReplaceTokens, tokens:[copyright:'2009', version:'2.3.1'])
AbstractCopyTask
filter
(Transformer
<String
,String
>
transformer)Adds a content filter based on the provided transformer. The Closure will be called with each line (stripped of lineendings) and should return a String to replace the line ornull
to remove the line. If every line isremoved, the result will be an empty file, not an absent one.
AbstractCopyTask
from
(Object
sourcePath,Closure
c)Specifies the source files or directories for a copy and creates a childCopySourceSpec
. The given sourcepath is evaluated as perProject.files(java.lang.Object[])
.
AbstractCopyTask
from
(Object
sourcePath,Action
<? superCopySpec
>
configureAction)Specifies the source files or directories for a copy and creates a childCopySpec
. The given sourcepath is evaluated as perProject.files(java.lang.Object[])
.
AbstractCopyTask
from
(Object
...
sourcePaths)Specifies source files or directories for a copy. The given paths are evaluated as perProject.files(java.lang.Object[])
.
AbstractCopyTask
include
(Closure
includeSpec)Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed aFileTreeElement
as its parameter.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns or specs to be included.
AbstractCopyTask
include
(Iterable
<String
>
includes)Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed.
AbstractCopyTask
include
(String
...
includes)Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed.
AbstractCopyTask
include
(Spec
<FileTreeElement
>
includeSpec)Adds an include spec. This method may be called multiple times to append new specs.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns or specs to be included.
AbstractCopyTask
into
(Object
destDir)Specifies the destination directory for a copy. The destination is evaluated as perProject.file(java.lang.Object)
.
AbstractCopyTask
into
(Object
destPath,Closure
configureClosure)Creates and configures a childCopySpec
with the given destination path.The destination is evaluated as perProject.file(java.lang.Object)
.
Creates and configures a childCopySpec
with the given destination path.The destination is evaluated as perProject.file(java.lang.Object)
.
Sync
preserve
(Action
<? superPatternFilterable
>
action)Note: This method isincubating and may change in a future version of Gradle.
Configures the filter that defines which files to preserve in the destination directory.
AbstractCopyTask
rename
(Closure
closure)Renames a source file. The closure will be called with a single parameter, the name of the file.The closure should return a String object with a new target name. The closure may return null,in which case the original name will be used.
AbstractCopyTask
rename
(String
sourceRegEx,String
replaceWith)Renames files based on a regular expression. Uses java.util.regex type of regular expressions. Note that thereplace string should use the '$1' syntax to refer to capture groups in the source regular expression. Filesthat do not match the source regular expression will be copied with the original name.
Example:
rename'(.*)_OEM_BLUE_(.*)','$1$2'
would map the file 'style_OEM_BLUE_.css' to 'style.css'
AbstractCopyTask
rename
(Pattern
sourceRegEx,String
replaceWith)Renames files based on a regular expression. SeeCopyProcessingSpec.rename(java.lang.String, java.lang.String)
.
AbstractCopyTask
rename
(Transformer
<String
,String
>
renamer)Renames a source file. The function will be called with a single parameter, the name of the file.The function should return a new target name. The function may return null,in which case the original name will be used.