Package org.gradle.api.file
Interface CopyProcessingSpec
- All Superinterfaces:
ContentFilterable
- All Known Subinterfaces:
CopySpec
- All Known Implementing Classes:
AbstractArchiveTask
,AbstractCopyTask
,Copy
,Ear
,Jar
,Jar
,ProcessResources
,Sync
,Tar
,War
,Zip
Specifies the destination of a copy.
-
Method Summary
Modifier and TypeMethodDescriptionAdds an action to be applied to each file as it about to be copied into its destination.eachFile
(Action<? super FileCopyDetails> action) Adds an action to be applied to each file as it is about to be copied into its destination.Returns the Unix permissions to use for the target directories.Returns the Unix permissions to use for the target files.Specifies the destination directory for a copy.Renames a source file.Renames files based on a regular expression.Renames files based on a regular expression.rename
(Transformer<String, String> renamer) Renames a source file.setDirMode
(Integer mode) Sets the Unix permissions to use for the target directories.setFileMode
(Integer mode) Sets the Unix permissions to use for the target files.
-
Method Details
-
into
Specifies the destination directory for a copy. The destination is evaluated as perProject.file(Object)
.- Parameters:
destPath
- Path to the destination directory for a Copy- Returns:
- this
-
rename
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.- Parameters:
closure
- rename closure- Returns:
- this
-
rename
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.- Parameters:
renamer
- rename function- Returns:
- this
-
rename
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'- Parameters:
sourceRegEx
- Source regular expressionreplaceWith
- Replacement string (use $ syntax for capture groups)- Returns:
- this
-
rename
Renames files based on a regular expression. Seerename(String, String)
.- Parameters:
sourceRegEx
- Source regular expressionreplaceWith
- Replacement string (use $ syntax for capture groups)- Returns:
- this
-
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.- Returns:
- The file permissions, or
null
if existing permissions should be preserved.
-
setFileMode
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.- Parameters:
mode
- The file permissions.- Returns:
- this
-
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.- Returns:
- The directory permissions, or
null
if existing permissions should be preserved.
-
setDirMode
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.- Parameters:
mode
- The directory permissions.- Returns:
- this
-
eachFile
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.- Parameters:
action
- The action to execute.- Returns:
- this
-
eachFile
Adds an action to be applied to each file as it about to be copied into its destination. The given closure is called with aFileCopyDetails
as its parameter. Actions are executed in the order added, and are inherited from the parent spec.- Parameters:
closure
- The action to execute.- Returns:
- this
-