AbstractCopyTask

属性
方法
脚本块
属性详情
方法详情

API 文档	`AbstractCopyTask`

已知子类型

Copy

AbstractArchiveTask

Sync

AbstractCopyTask 是所有复制任务的基类。

属性

属性	描述
`caseSensitive`	指定是否应该使用区分大小写的模式匹配。
`dirPermissions`	用于查询和配置目录访问权限的属性。如果此属性未设置任何值，则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详细信息请参阅 `ConfigurableFilePermissions`。
`duplicatesStrategy`	尝试将多个文件复制到同一目标位置时使用的策略。
`excludes`	排除模式的集合。
`filePermissions`	用于查询和配置文件访问权限的属性。如果此属性未设置任何值，则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详细信息请参阅 `ConfigurableFilePermissions`。
`includeEmptyDirs`	指示是否在复制中包含空目标目录。
`includes`	包含模式的集合。
`source`	此任务的源文件。

方法

方法	描述
`eachFile(closure)`	添加一个操作，该操作将在每个文件即将复制到其目标位置时应用。给定的闭包将以 `FileCopyDetails` 作为参数调用。操作按添加顺序执行，并继承自父规范。
`eachFile(action)`	添加一个操作，该操作将在每个文件即将复制到其目标位置时应用。该操作可以更改文件的目标路径、过滤文件内容或完全从结果中排除文件。操作按添加顺序执行，并继承自父规范。
`exclude(excludeSpec)`	添加一个排除规范。可以多次调用此方法以追加新的规范。给定的闭包将以 `FileTreeElement` 作为参数传递。闭包应返回 true 或 false。示例
`exclude(excludes)`	添加 ANT 风格的排除模式。可以多次调用此方法以追加新的模式，也可以在一次调用中指定多个模式。如果未提供排除模式，则不会排除任何文件。如果提供了排除模式，则文件必须不匹配任何排除模式才会被处理。
`exclude(excludes)`	添加 ANT 风格的排除模式。可以多次调用此方法以追加新的模式，也可以在一次调用中指定多个模式。如果未提供排除模式，则不会排除任何文件。如果提供了排除模式，则文件必须不匹配任何排除模式才会被处理。
`exclude(excludeSpec)`	添加一个排除规范。可以多次调用此方法以追加新的规范。如果未提供排除模式，则不会排除任何文件。如果提供了排除模式，则文件必须不匹配任何排除模式才会被处理。
`expand(properties)`	在复制每个文件时，展开文件中的属性引用。更具体地说，每个文件都使用 Groovy 的 `SimpleTemplateEngine` 进行转换。这意味着您可以在文件中使用简单的属性引用，例如 `$property` 或 `${property}`。您还可以在文件中包含任意 Groovy 代码，例如 `${version ?: 'unknown'}` 或 `${classpath*.name.join(' ')}`。
`expand(properties, action)`	在复制每个文件时，展开文件中的属性引用。更具体地说，每个文件都使用 Groovy 的 `SimpleTemplateEngine` 进行转换。这意味着您可以在文件中使用简单的属性引用，例如 `$property` 或 `${property}`。您还可以在文件中包含任意 Groovy 代码，例如 `${version ?: 'unknown'}` 或 `${classpath*.name.join(' ')}`。模板引擎可以通过提供的操作进行配置。
`filesMatching(patterns, action)`	为路径匹配任何指定 Ant 风格模式的每个文件配置 `FileCopyDetails`。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。
`filesMatching(pattern, action)`	为路径匹配指定 Ant 风格模式的每个文件配置 `FileCopyDetails`。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。
`filesNotMatching(patterns, action)`	为路径不匹配任何指定 Ant 风格模式的每个文件配置 `FileCopyDetails`。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。
`filesNotMatching(pattern, action)`	为路径不匹配指定 Ant 风格模式的每个文件配置 `FileCopyDetails`。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。
`filter(closure)`	添加基于提供的闭包的内容过滤器。闭包将以每一行（去掉行尾符）作为参数调用，应返回一个 String 来替换该行或返回 `null` 来删除该行。如果删除了每一行，结果将是一个空文件，而不是不存在的文件。
`filter(filterType)`	添加一个在复制过程中使用的内容过滤器。多次调用 filter 会向过滤器链添加更多过滤器。每个过滤器都应实现 `java.io.FilterReader`。包含 `org.apache.tools.ant.filters.*` 可访问所有标准 Ant 过滤器。
`filter(properties, filterType)`	添加一个在复制过程中使用的内容过滤器。多次调用 filter 会向过滤器链添加更多过滤器。每个过滤器都应实现 `java.io.FilterReader`。包含 `org.apache.tools.ant.filters.*` 可访问所有标准 Ant 过滤器。
`filter(transformer)`	添加基于提供的转换器的内容过滤器。闭包将以每一行（去掉行尾符）作为参数调用，应返回一个 String 来替换该行或返回 `null` 来删除该行。如果删除了每一行，结果将是一个空文件，而不是不存在的文件。
`from(sourcePath, c)`	指定复制的源文件或目录，并创建一个子 `CopySourceSpec`。给定的源路径按照 `Project.files(java.lang.Object[])` 进行评估。
`from(sourcePath, configureAction)`	指定复制的源文件或目录，并创建一个子 `CopySpec`。给定的源路径按照 `Project.files(java.lang.Object[])` 进行评估。
`from(sourcePaths)`	指定复制的源文件或目录。给定的路径按照 `Project.files(java.lang.Object[])` 进行评估。
`include(includeSpec)`	添加一个包含规范。可以多次调用此方法以追加新的规范。给定的闭包将以 `FileTreeElement` 作为参数传递。如果未提供包含模式，则包含此容器中的所有文件。如果提供了包含模式，则文件必须匹配至少一个包含模式或规范才会被包含。
`include(includes)`	添加 ANT 风格的包含模式。可以多次调用此方法以追加新的模式，也可以在一次调用中指定多个模式。如果未提供包含模式，则包含此容器中的所有文件。如果提供了包含模式，则文件必须匹配至少一个包含模式才会被处理。
`include(includes)`	添加 ANT 风格的包含模式。可以多次调用此方法以追加新的模式，也可以在一次调用中指定多个模式。如果未提供包含模式，则包含此容器中的所有文件。如果提供了包含模式，则文件必须匹配至少一个包含模式才会被处理。
`include(includeSpec)`	添加一个包含规范。可以多次调用此方法以追加新的规范。如果未提供包含模式，则包含此容器中的所有文件。如果提供了包含模式，则文件必须匹配至少一个包含模式或规范才会被包含。
`into(destDir)`	指定复制的目标目录。目标位置按照 `Project.file(java.lang.Object)` 进行评估。
`into(destPath, configureClosure)`	使用给定的目标路径创建并配置一个子 `CopySpec`。目标位置按照 `Project.file(java.lang.Object)` 进行评估。
`into(destPath, copySpec)`	使用给定的目标路径创建并配置一个子 `CopySpec`。目标位置按照 `Project.file(java.lang.Object)` 进行评估。
`rename(closure)`	重命名源文件。闭包将以单个参数（文件名）调用。闭包应返回一个包含新目标名称的 String 对象。闭包可以返回 null，在这种情况下将使用原始名称。
`rename(sourceRegEx, replaceWith)`	根据正则表达式重命名文件。使用 java.util.regex 类型的正则表达式。请注意，替换字符串应使用 '$1' 语法引用源正则表达式中的捕获组。不匹配源正则表达式的文件将使用原始名称复制。
`rename(sourceRegEx, replaceWith)`	根据正则表达式重命名文件。请参阅 `CopyProcessingSpec.rename(java.lang.String, java.lang.String)`。
`rename(renamer)`	重命名源文件。该函数将以单个参数（文件名）调用。该函数应返回一个新的目标名称。该函数可以返回 null，在这种情况下将使用原始名称。
`with(sourceSpecs)`	将给定的规范添加为此规范的子规范。

脚本块

无脚本块

属性详情

`boolean` `caseSensitive`

指定是否应该使用区分大小写的模式匹配。

默认值: true

`Property<ConfigurableFilePermissions>` `dirPermissions`

用于查询和配置目录访问权限的属性。如果此属性未设置任何值，则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详细信息请参阅 ConfigurableFilePermissions。

默认值: null

`DuplicatesStrategy` `duplicatesStrategy`

尝试将多个文件复制到同一目标位置时使用的策略。

该值可以使用枚举值的字符串（不区分大小写）来设置（例如，对于 DuplicatesStrategy.EXCLUDE 使用 'exclude'）。

可以使用 CopySpec.eachFile(org.gradle.api.Action) 或 CopySpec.filesMatching(java.lang.String, org.gradle.api.Action) 为单个文件覆盖此策略。

默认值: DuplicatesStrategy.INHERIT

`Property<ConfigurableFilePermissions>` `filePermissions`

用于查询和配置文件访问权限的属性。如果此属性未设置任何值，则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。详细信息请参阅 ConfigurableFilePermissions。

默认值: null

`boolean` `includeEmptyDirs`

指示是否在复制中包含空目标目录。

默认值: true

`FileCollection` `source` (只读)

此任务的源文件。

默认值: []

方法详情

`AbstractCopyTask` `eachFile`(`Closure` closure)

添加一个操作，该操作将在每个文件即将复制到其目标位置时应用。给定的闭包将以 FileCopyDetails 作为参数调用。操作按添加顺序执行，并继承自父规范。

`AbstractCopyTask` `eachFile`(`Action<? super FileCopyDetails>` action)

添加一个操作，该操作将在每个文件即将复制到其目标位置时应用。该操作可以更改文件的目标路径、过滤文件内容或完全从结果中排除文件。操作按添加顺序执行，并继承自父规范。

`AbstractCopyTask` `exclude`(`Closure` excludeSpec)

添加一个排除规范。可以多次调用此方法以追加新的规范。给定的闭包将以 FileTreeElement 作为参数传递。闭包应返回 true 或 false。示例

copySpec {
  from 'source'
  into 'destination'
  //an example of excluding files from certain configuration:
  exclude { it.file in configurations.someConf.files }
}

如果未提供排除模式，则不会排除任何文件。如果提供了排除模式，则文件必须不匹配任何排除模式才会被处理。

`AbstractCopyTask` `exclude`(`Iterable<String>` excludes)

添加 ANT 风格的排除模式。可以多次调用此方法以追加新的模式，也可以在一次调用中指定多个模式。如果未提供排除模式，则不会排除任何文件。如果提供了排除模式，则文件必须不匹配任何排除模式才会被处理。

`AbstractCopyTask` `exclude`(`String...` excludes)

`AbstractCopyTask` `exclude`(`Spec<FileTreeElement>` excludeSpec)

添加一个排除规范。可以多次调用此方法以追加新的规范。如果未提供排除模式，则不会排除任何文件。如果提供了排除模式，则文件必须不匹配任何排除模式才会被处理。

`AbstractCopyTask` `expand`(`Map<String, ?>` properties)

在复制每个文件时，展开文件中的属性引用。更具体地说，每个文件都使用 Groovy 的 SimpleTemplateEngine 进行转换。这意味着您可以在文件中使用简单的属性引用，例如 $property 或 ${property}。您还可以在文件中包含任意 Groovy 代码，例如 ${version ?: 'unknown'} 或 ${classpath*.name.join(' ')}。

请注意，所有转义序列（\n、\t、\\ 等）都会被转换为它们所代表的符号，例如，\n 会变成换行符。如果这是不希望的行为，应使用 ContentFilterable.expand(java.util.Map, org.gradle.api.Action) 来禁用此行为。

`AbstractCopyTask` `expand`(`Map<String, ?>` properties, `Action<? super ExpandDetails>` action)

请注意，默认情况下，所有转义序列（\n、\t、\\ 等）都会被转换为它们所代表的符号，例如，\n 会变成换行符。此行为由 ExpandDetails.getEscapeBackslash() 属性控制。应将其设置为 true 以禁用转义序列转换。

 expand(one: '1', two: 2) {
     escapeBackslash = true
 }

`AbstractCopyTask` `filesMatching`(`Iterable<String>` patterns, `Action<? super FileCopyDetails>` action)

为路径匹配任何指定 Ant 风格模式的每个文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。

`AbstractCopyTask` `filesMatching`(`String` pattern, `Action<? super FileCopyDetails>` action)

为路径匹配指定 Ant 风格模式的每个文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。

`AbstractCopyTask` `filesNotMatching`(`Iterable<String>` patterns, `Action<? super FileCopyDetails>` action)

为路径不匹配任何指定 Ant 风格模式的每个文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。

`AbstractCopyTask` `filesNotMatching`(`String` pattern, `Action<? super FileCopyDetails>` action)

为路径不匹配指定 Ant 风格模式的每个文件配置 FileCopyDetails。这等同于使用 eachFile() 并根据文件路径选择性地应用配置。

`AbstractCopyTask` `filter`(`Closure` closure)

添加基于提供的闭包的内容过滤器。闭包将以每一行（去掉行尾符）作为参数调用，应返回一个 String 来替换该行或返回 null 来删除该行。如果删除了每一行，结果将是一个空文件，而不是不存在的文件。

`AbstractCopyTask` `filter`(`Class<? extends FilterReader>` filterType)

添加一个在复制过程中使用的内容过滤器。多次调用 filter 会向过滤器链添加更多过滤器。每个过滤器都应实现 java.io.FilterReader。包含 org.apache.tools.ant.filters.* 可访问所有标准 Ant 过滤器。

示例

   filter(StripJavaComments)
   filter(com.mycompany.project.CustomFilter)

`AbstractCopyTask` `filter`(`Map<String, ?>` properties, `Class<? extends FilterReader>` filterType)

可以使用 Groovy Map 语法指定过滤器属性。

示例

   filter(HeadFilter, lines:25, skip:2)
   filter(ReplaceTokens, tokens:[copyright:'2009', version:'2.3.1'])

`AbstractCopyTask` `filter`(`Transformer<String, String>` transformer)

添加基于提供的转换器的内容过滤器。闭包将以每一行（去掉行尾符）作为参数调用，应返回一个 String 来替换该行或返回 null 来删除该行。如果删除了每一行，结果将是一个空文件，而不是不存在的文件。

`AbstractCopyTask` `from`(`Object` sourcePath, `Closure` c)

指定复制的源文件或目录，并创建一个子 CopySourceSpec。给定的源路径按照 Project.files(java.lang.Object[]) 进行评估。

`AbstractCopyTask` `from`(`Object` sourcePath, `Action<? super CopySpec>` configureAction)

指定复制的源文件或目录，并创建一个子 CopySpec。给定的源路径按照 Project.files(java.lang.Object[]) 进行评估。

`AbstractCopyTask` `from`(`Object...` sourcePaths)

指定复制的源文件或目录。给定的路径按照 Project.files(java.lang.Object[]) 进行评估。

`AbstractCopyTask` `include`(`Closure` includeSpec)

添加一个包含规范。可以多次调用此方法以追加新的规范。给定的闭包将以 FileTreeElement 作为参数传递。如果未提供包含模式，则包含此容器中的所有文件。如果提供了包含模式，则文件必须匹配至少一个包含模式或规范才会被包含。

`AbstractCopyTask` `include`(`Iterable<String>` includes)

添加 ANT 风格的包含模式。可以多次调用此方法以追加新的模式，也可以在一次调用中指定多个模式。如果未提供包含模式，则包含此容器中的所有文件。如果提供了包含模式，则文件必须匹配至少一个包含模式才会被处理。

`AbstractCopyTask` `include`(`String...` includes)

`AbstractCopyTask` `include`(`Spec<FileTreeElement>` includeSpec)

添加一个包含规范。可以多次调用此方法以追加新的规范。如果未提供包含模式，则包含此容器中的所有文件。如果提供了包含模式，则文件必须匹配至少一个包含模式或规范才会被包含。

`AbstractCopyTask` `into`(`Object` destDir)

指定复制的目标目录。目标位置按照 Project.file(java.lang.Object) 进行评估。

`AbstractCopyTask` `into`(`Object` destPath, `Closure` configureClosure)

使用给定的目标路径创建并配置一个子 CopySpec。目标位置按照 Project.file(java.lang.Object) 进行评估。

`CopySpec` `into`(`Object` destPath, `Action<? super CopySpec>` copySpec)

使用给定的目标路径创建并配置一个子 CopySpec。目标位置按照 Project.file(java.lang.Object) 进行评估。

`AbstractCopyTask` `rename`(`Closure` closure)

重命名源文件。闭包将以单个参数（文件名）调用。闭包应返回一个包含新目标名称的 String 对象。闭包可以返回 null，在这种情况下将使用原始名称。

`AbstractCopyTask` `rename`(`String` sourceRegEx, `String` replaceWith)

根据正则表达式重命名文件。使用 java.util.regex 类型的正则表达式。请注意，替换字符串应使用 '$1' 语法引用源正则表达式中的捕获组。不匹配源正则表达式的文件将使用原始名称复制。

示例

rename '(.*)_OEM_BLUE_(.*)', '$1$2'

将文件 'style_OEM_BLUE_.css' 映射到 'style.css'

`AbstractCopyTask` `rename`(`Pattern` sourceRegEx, `String` replaceWith)

根据正则表达式重命名文件。请参阅 CopyProcessingSpec.rename(java.lang.String, java.lang.String)。

`AbstractCopyTask` `rename`(`Transformer<String, String>` renamer)

重命名源文件。该函数将以单个参数（文件名）调用。该函数应返回一个新的目标名称。该函数可以返回 null，在这种情况下将使用原始名称。

`CopySpec` `with`(`CopySpec...` sourceSpecs)

将给定的规范添加为此规范的子规范。

def contentSpec = copySpec {
  from("content") {
    include "**/*.txt"
  }
}

task copy(type: Copy) {
  into "$buildDir/copy"
  with contentSpec
}

AbstractCopyTask

属性

方法

脚本块

属性详情

boolean caseSensitive

Property<ConfigurableFilePermissions> dirPermissions

DuplicatesStrategy duplicatesStrategy

Set<String> excludes

Property<ConfigurableFilePermissions> filePermissions

boolean includeEmptyDirs

Set<String> includes

FileCollection source (只读)

方法详情

AbstractCopyTask eachFile(Closure closure)

AbstractCopyTask eachFile(Action<? super FileCopyDetails> action)

AbstractCopyTask exclude(Closure excludeSpec)

AbstractCopyTask exclude(Iterable<String> excludes)

AbstractCopyTask exclude(String... excludes)

AbstractCopyTask exclude(Spec<FileTreeElement> excludeSpec)

AbstractCopyTask expand(Map<String, ?> properties)

AbstractCopyTask expand(Map<String, ?> properties, Action<? super ExpandDetails> action)

AbstractCopyTask filesMatching(Iterable<String> patterns, Action<? super FileCopyDetails> action)

AbstractCopyTask filesMatching(String pattern, Action<? super FileCopyDetails> action)

AbstractCopyTask filesNotMatching(Iterable<String> patterns, Action<? super FileCopyDetails> action)

AbstractCopyTask filesNotMatching(String pattern, Action<? super FileCopyDetails> action)

AbstractCopyTask filter(Closure closure)

AbstractCopyTask filter(Class<? extends FilterReader> filterType)

AbstractCopyTask filter(Map<String, ?> properties, Class<? extends FilterReader> filterType)

AbstractCopyTask filter(Transformer<String, String> transformer)

AbstractCopyTask from(Object sourcePath, Closure c)

AbstractCopyTask from(Object sourcePath, Action<? super CopySpec> configureAction)

AbstractCopyTask from(Object... sourcePaths)

AbstractCopyTask include(Closure includeSpec)

AbstractCopyTask include(Iterable<String> includes)

AbstractCopyTask include(String... includes)

AbstractCopyTask include(Spec<FileTreeElement> includeSpec)

AbstractCopyTask into(Object destDir)

AbstractCopyTask into(Object destPath, Closure configureClosure)

CopySpec into(Object destPath, Action<? super CopySpec> copySpec)

AbstractCopyTask rename(Closure closure)

AbstractCopyTask rename(String sourceRegEx, String replaceWith)

AbstractCopyTask rename(Pattern sourceRegEx, String replaceWith)

AbstractCopyTask rename(Transformer<String, String> renamer)

CopySpec with(CopySpec... sourceSpecs)