org.gradle.api.file

インタフェース CopyProcessingSpec

すべてのスーパーインタフェース:

ContentFilterable

既知のサブインタフェースのリスト:

CopySpec

既知の実装クラスのリスト:

AbstractArchiveTask, AbstractCopyTask, Copy, Jar, ProcessResources, Sync, Tar, Zip

public interface CopyProcessingSpec
extends ContentFilterable

Specifies the destination of a copy.

メソッドの概要

修飾子とタイプ	メソッドと説明
CopyProcessingSpec	eachFile(Action<? super FileCopyDetails> action) Adds an action to be applied to each file as it is about to be copied into its destination.
CopyProcessingSpec	eachFile(Closure closure) Adds an action to be applied to each file as it about to be copied into its destination.
Integer	getDirMode() Returns the Unix permissions to use for the target directories.
Integer	getFileMode() Returns the Unix permissions to use for the target files.
CopyProcessingSpec	into(Object destPath) Specifies the destination directory for a copy.
CopyProcessingSpec	rename(Closure closure) Renames a source file to a different relative location under the target directory.
CopyProcessingSpec	rename(Pattern sourceRegEx, String replaceWith) Renames files based on a regular expression.
CopyProcessingSpec	rename(String sourceRegEx, String replaceWith) Renames files based on a regular expression.
CopyProcessingSpec	setDirMode(Integer mode) Sets the Unix permissions to use for the target directories.
CopyProcessingSpec	setFileMode(Integer mode) Sets the Unix permissions to use for the target files.

インタフェースから継承されたメソッド org.gradle.api.file.ContentFilterable

expand, filter, filter, filter

メソッドの詳細

into

CopyProcessingSpec into(Object destPath)

Specifies the destination directory for a copy. The destination is evaluated as per Project.file(Object).

パラメータ:

destPath - Path to the destination directory for a Copy

戻り値:

this

rename

CopyProcessingSpec rename(Closure closure)

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

パラメータ:

closure - rename closure

戻り値:

this

rename

CopyProcessingSpec rename(String sourceRegEx,
                          String replaceWith)

Renames files based on a regular expression. Uses java.util.regex type of regular expressions. Note that the replace string should use the '$1' syntax to refer to capture groups in the source regular expression. Files that 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'

パラメータ:

sourceRegEx - Source regular expression

replaceWith - Replacement string (use $ syntax for capture groups)

戻り値:

this

rename

CopyProcessingSpec rename(Pattern sourceRegEx,
                          String replaceWith)

Renames files based on a regular expression. See rename(String, String).

パラメータ:

sourceRegEx - Source regular expression

replaceWith - Replacement string (use $ syntax for capture groups)

戻り値:

this

getFileMode

Integer getFileMode()

Returns the Unix permissions to use for the target files. null means that existing permissions are preserved. It is dependent on the copy action implementation whether these permissions will actually be applied.

戻り値:

The file permissions, or null if existing permissions should be preserved.

setFileMode

CopyProcessingSpec setFileMode(Integer mode)

Sets the Unix permissions to use for the target files. null means that existing permissions are preserved. It is dependent on the copy action implementation whether these permissions will actually be applied.

パラメータ:

mode - The file permissions.

戻り値:

this

getDirMode

Integer getDirMode()

Returns the Unix permissions to use for the target directories. null means that existing permissions are preserved. It is dependent on the copy action implementation whether these permissions will actually be applied.

戻り値:

The directory permissions, or null if existing permissions should be preserved.

setDirMode

CopyProcessingSpec setDirMode(Integer mode)

Sets the Unix permissions to use for the target directories. null means that existing permissions are preserved. It is dependent on the copy action implementation whether these permissions will actually be applied.

パラメータ:

mode - The directory permissions.

戻り値:

this

eachFile

CopyProcessingSpec eachFile(Action<? super FileCopyDetails> action)

Adds an action to be applied to each file as it is about to be copied into its destination. The action can change the 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.

パラメータ:

action - The action to execute.

戻り値:

this

eachFile

CopyProcessingSpec eachFile(Closure closure)

Adds an action to be applied to each file as it about to be copied into its destination. The given closure is called with a FileCopyDetails as its parameter. Actions are executed in the order added, and are inherited from the parent spec.

パラメータ:

closure - The action to execute.

戻り値:

this