Package org.gradle.api.file

Interface CopyProcessingSpec

All Superinterfaces:
ContentFilterable
All Known Subinterfaces:
CopySpec, SyncSpec
All Known Implementing Classes:
AbstractArchiveTask, AbstractCopyTask, Copy, Ear, Jar, Jar, ProcessResources, Sync, Tar, War, Zip
public interface CopyProcessingSpec extends ContentFilterable
Specifies the destination of a copy.

  • Method Details

    • into

      CopyProcessingSpec into(Object destPath)
      Specifies the destination directory for a copy. The destination is evaluated as per Project.file(Object).
      Parameters:
      destPath - Path to the destination directory for a Copy
      Returns:
      this

    • rename

      CopyProcessingSpec 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.
      Parameters:
      closure - rename closure
      Returns:
      this

    • rename

      CopyProcessingSpec rename(Transformer<@Nullable 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.
      Parameters:
      renamer - rename function
      Returns:
      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'
      Parameters:
      sourceRegEx - Source regular expression
      replaceWith - Replacement string (use $ syntax for capture groups)
      Returns:
      this

    • rename

      CopyProcessingSpec rename(Pattern sourceRegEx, String replaceWith)
      Renames files based on a regular expression. See rename(String, String).
      Parameters:
      sourceRegEx - Source regular expression
      replaceWith - Replacement string (use $ syntax for capture groups)
      Returns:
      this

    • getFileMode

      @Nullable @Deprecated Integer getFileMode()
      Deprecated.
      Use getFilePermissions() instead. This method is scheduled for removal in Gradle 9.0.
      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

      @Deprecated CopyProcessingSpec setFileMode(@Nullable Integer mode)
      Deprecated.
      Use filePermissions(Action) instead. This method is scheduled for removal in Gradle 9.0.
      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

      @Nullable @Deprecated Integer getDirMode()
      Deprecated.
      Use getDirPermissions() instead. This method is scheduled for removal in Gradle 9.0.
      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

      @Deprecated CopyProcessingSpec setDirMode(@Nullable Integer mode)
      Deprecated.
      Use dirPermissions(Action) instead. This method is scheduled for removal in Gradle 9.0.
      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

    • getFilePermissions

      Property<ConfigurableFilePermissions> getFilePermissions()
      Property for querying and configuring file access permissions. If the property has no value set, that means that existing permissions are preserved. It is dependent on the copy action implementation whether these permissions will actually be applied. For details see ConfigurableFilePermissions.
      Since:
      8.3

    • filePermissions

      CopyProcessingSpec filePermissions(Action<? super ConfigurableFilePermissions> configureAction)
      Configuration action for specifying file access permissions. For details see ConfigurableFilePermissions.
      Since:
      8.3

    • getDirPermissions

      Property<ConfigurableFilePermissions> getDirPermissions()
      Property for querying and configuring directory access permissions. If the property has no value set, that means that existing permissions are preserved. It is dependent on the copy action implementation whether these permissions will actually be applied. For details see ConfigurableFilePermissions.
      Since:
      8.3

    • dirPermissions

      CopyProcessingSpec dirPermissions(Action<? super ConfigurableFilePermissions> configureAction)
      Configuration action for specifying directory access permissions. For details see ConfigurableFilePermissions.
      Since:
      8.3

    • 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.
      Parameters:
      action - The action to execute.
      Returns:
      this

    • eachFile

      CopyProcessingSpec eachFile(@DelegatesTo(value=FileCopyDetails.class,strategy=1) 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.
      Parameters:
      closure - The action to execute.
      Returns:
      this