复制

目录

属性
方法
Script 块
属性详情
方法详情
API文档： Copy
已知亚型：
ProcessResources

将文件复制到目标目录中。此任务还可以在复制时重命名和过滤文件。该任务实现 CopySpec 以指定要复制的内容。

示例：

public static void mkdirs​(java.io.File dir)

属性

Property 描述
caseSensitive

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

将文件复制到的目录。
dirMode

用于目标目录的 Unix 权限。 null 表示保留现有权限。是否实际应用这些权限取决于复制操作的实现。
duplicatesStrategy

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

排除模式集。
fileMode

用于目标文件的 Unix 权限。 null 表示保留现有权限。是否实际应用这些权限取决于复制操作的实现。
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)

添加要在复制期间使用的内容过滤器。多次调用过滤器，向过滤器链添加额外的过滤器。每个过滤器都应该实现 java.io.FilterReader 。包含 org.apache.tools.ant.filters.* 以访问所有标准 Ant 过滤器。
filter(properties, filterType)

添加要在复制期间使用的内容过滤器。多次调用过滤器，向过滤器链添加额外的过滤器。每个过滤器都应该实现 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

File destinationDir

将文件复制到的目录。

默认：
null

Integer dirMode

用于目标目录的 Unix 权限。 null 表示保留现有权限。是否实际应用这些权限取决于复制操作的实现。

默认：
null

DuplicatesStrategy duplicatesStrategy

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

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

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

默认：
DuplicatesStrategy.INHERIT

Set<String> excludes

排除模式集。

默认：
[]

Integer fileMode

用于目标文件的 Unix 权限。 null 表示保留现有权限。是否实际应用这些权限取决于复制操作的实现。

默认：
null

boolean includeEmptyDirs

告知空目标目录是否将包含在副本中。

默认：
true

Set<String> includes

包含模式集。

默认：
[]

FileCollection source（只读）

此任务的源文件。

默认：
[]

方法细节

AbstractCopyTask eachFile (Closure 闭包)

添加要应用于每个文件的操作，因为它即将被复制到其目的地。使用 FileCopyDetails 作为参数调用给定的闭包。动作按照添加的顺序执行，并从父规范继承。

AbstractCopyTask eachFile（Action<? super FileCopyDetails> 动作）

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

AbstractCopyTask exclude (Closure excludeSpec)

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

@Input
java.util.Set<java.lang.String> getExcludePatterns()

如果未提供排除项，则不会排除任何文件。如果提供排除项，则文件不得匹配任何要处理的排除模式。

AbstractCopyTask exclude (Iterable<String> 不包括)

添加 ANT 样式排除模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供排除项，则文件不得匹配任何要处理的排除模式。

AbstractCopyTask exclude (String... 不包括)

添加 ANT 样式排除模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供排除项，则文件不得匹配任何要处理的排除模式。

AbstractCopyTask exclude (Spec<FileTreeElement> excludeSpec)

添加排除规范。可以多次调用此方法以附加新规范。如果未提供排除项，则不会排除任何文件。如果提供排除项，则文件不得匹配任何要处理的排除模式。

AbstractCopyTask expand（Map<String, ?> 属性）

在复制每个文件时扩展属性引用。更具体地说，每个文件都使用 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, ?> 属性，Action<? super ExpandDetails> 动作）

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

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

public abstract class IvyPublishPlugin
extends java.lang.Object
implements Plugin<Project>

AbstractCopyTask filesMatching（Iterable<String> 模式，Action<? super FileCopyDetails> 动作）

为每个路径匹配任何指定的 Ant 样式模式的文件配置 FileCopyDetails。这相当于使用 eachFile() 并根据文件路径有选择地应用配置。

AbstractCopyTask filesMatching（String 模式，Action<? super FileCopyDetails> 动作）

为每个路径匹配指定 Ant 样式模式的文件配置 FileCopyDetails。这相当于使用 eachFile() 并根据文件路径有选择地应用配置。

AbstractCopyTask filesNotMatching（Iterable<String> 模式，Action<? super FileCopyDetails> 动作）

为路径不匹配任何指定 Ant 样式模式的每个文件配置 FileCopyDetails。这相当于使用 eachFile() 并根据文件路径有选择地应用配置。

AbstractCopyTask filesNotMatching（String 模式，Action<? super FileCopyDetails> 动作）

为路径与指定的 Ant 样式模式不匹配的每个文件配置 FileCopyDetails。这相当于使用 eachFile() 并根据文件路径有选择地应用配置。

AbstractCopyTask filter (Closure 闭包)

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

AbstractCopyTask filter (Class<? extends FilterReader> filterType)

添加要在复制期间使用的内容过滤器。多次调用过滤器，向过滤器链添加额外的过滤器。每个过滤器都应该实现 java.io.FilterReader 。包含 org.apache.tools.ant.filters.* 以访问所有标准 Ant 过滤器。

示例：

public java.io.File getContentRoot()

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

添加要在复制期间使用的内容过滤器。多次调用过滤器，向过滤器链添加额外的过滤器。每个过滤器都应该实现 java.io.FilterReader 。包含 org.apache.tools.ant.filters.* 以访问所有标准 Ant 过滤器。

可以使用 groovy 映射语法指定过滤器属性。

示例：

public void generatePluginDescriptors()

添加基于提供的转换器的内容过滤器。闭包将在每一行（去除行尾）时被调用，并且应该返回一个 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> 包括）

添加 ANT 样式包含模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要处理的包含模式之一。

AbstractCopyTask include（String... 包括）

添加 ANT 样式包含模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要处理的包含模式之一。

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 闭包)

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

AbstractCopyTask rename (String sourceRegEx, String replaceWith)

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

示例：

@Deprecated
@DisableCachingByDefault(because="Produces only non-cacheable console output")
public abstract class DependentComponentsReport
extends DefaultTask

会将文件“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> 重命名)

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

CopySpec with (CopySpec... sourceSpecs)

将给定的规格添加为该规格的子项。

public class UnsupportedFeatureException
extends java.lang.RuntimeException