Movatterモバイル変換


[0]ホーム

URL:


Sync

API Documentation:Sync

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

Properties

PropertyDescription
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.null means that existingpermissions are preserved. It is dependent on the copy action implementation whether these permissionswill actually be applied.

excludes

The set of exclude patterns.

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.

includeEmptyDirs

Tells if empty target directories will be included in the copy.

includes

The set of include patterns.

source

The source files for this task.

Property details

booleancaseSensitive

Specifies whether case-sensitive pattern matching should be used.

Default:
true

FiledestinationDir

The directory to copy files into.

Default:
null

IntegerdirMode

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.

Default:
null

Set<String>excludes

The set of exclude patterns.

Default:
[]

IntegerfileMode

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.

Default:
null

booleanincludeEmptyDirs

Tells if empty target directories will be included in the copy.

Default:
true

Set<String>includes

The set of include patterns.

Default:
[]

FileCollectionsource (read-only)

The source files for this task.

Default:
[]

Script blocks

No script blocks

Methods

MethodDescription
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 aFileCopyDetails as its parameter. Actions are executed in the orderadded, and are inherited from the parent spec.

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 aFileTreeElement as its parameter. The closure should return true or false. Example:

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'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(' ')}

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.

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 implementjava.io.FilterReader. Includeorg.apache.tools.ant.filters.* for access to all the standard Ant filters.

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 implementjava.io.FilterReader. Includeorg.apache.tools.ant.filters.* for access to all the standard Ant filters.

from(sourcePath, c)

Specifies the source files or directories for a copy and creates a childCopySourceSpec. The given sourcepath is evaluated as perProject.files() .

from(sourcePaths)

Specifies source files or directories for a copy. The given paths are evaluated as perProject.files().

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

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 perProject.file().

into(destPath, configureClosure)

Creates and configures a childCopySpec with the given destination path.The destination is evaluated as perProject.file().

rename(closure)

Renames a source file to a different relative location under the target directory. The closure will be calledwith 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. SeeCopyProcessingSpec.rename().

with(sourceSpecs)

Adds the given specs as a child of this spec.

Method details

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

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

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

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

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

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.

AbstractCopyTaskexpand(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(' ')}

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

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

AbstractCopyTaskfilter(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'])

AbstractCopyTaskfrom(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() .

AbstractCopyTaskfrom(Object... sourcePaths)

Specifies source files or directories for a copy. The given paths are evaluated as perProject.files().

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

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

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

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.

Specifies the destination directory for a copy. The destination is evaluated as perProject.file().

AbstractCopyTaskinto(Object destPath,Closure configureClosure)

Creates and configures a childCopySpec with the given destination path.The destination is evaluated as perProject.file().

AbstractCopyTaskrename(Closure closure)

Renames a source file to a different relative location under the target directory. The closure will be calledwith 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.

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

AbstractCopyTaskrename(Pattern sourceRegEx,String replaceWith)

Renames files based on a regular expression. SeeCopyProcessingSpec.rename().

CopySpecwith(CopySpec... sourceSpecs)

Adds the given specs as a child of this spec.


[8]ページ先頭

©2009-2025 Movatter.jp