ProcessResources

API 文件處理資源

將資源從來源複製到目標目錄,並可能進行處理。確保目標目錄中沒有過時的資源。

屬性

屬性描述
caseSensitive

指定是否應使用區分大小寫的模式比對。

destinationDir

要將檔案複製到的目錄。

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)

根據提供的閉包新增內容過濾器。將使用每一行(去除行尾符號)呼叫閉包,並且應傳回一個字串來取代該行,或傳回 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)

根據提供的轉換器新增內容過濾器。將使用每一行(去除行尾符號)呼叫閉包,並且應傳回一個字串來取代該行,或傳回 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)

重新命名來源檔案。將使用單一參數(檔案名稱)呼叫閉包。閉包應傳回一個字串物件,其中包含新的目標名稱。閉包可能會傳回 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

用於查詢和配置目錄存取權限的屬性。如果屬性未設定值,則表示保留現有權限。這些權限是否實際應用取決於複製動作的實作。詳細資訊請參閱 ConfigurableFilePermissions

預設
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

排除模式的集合。

預設
[]

用於查詢和配置檔案存取權限的屬性。如果屬性未設定值,則表示保留現有權限。這些權限是否實際應用取決於複製動作的實作。詳細資訊請參閱 ConfigurableFilePermissions

預設
null

boolean includeEmptyDirs

告知是否將空目標目錄包含在複製中。

預設
true

Set<String> includes

包含模式的集合。

預設
[]

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)

新增一個 ANT 樣式的排除模式。此方法可以多次呼叫以附加新的模式,並且可以在單次呼叫中指定多個模式。如果未提供排除模式,則不會排除任何檔案。如果提供了排除模式,則檔案不得符合任何排除模式才能進行處理。

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)

在複製每個檔案時,展開檔案中的屬性參考。更具體地說,每個檔案都會使用 Groovy 的 SimpleTemplateEngine 進行轉換。這表示您可以在檔案中使用簡單的屬性參考,例如 $property${property}。您也可以在檔案中包含任意 Groovy 程式碼,例如 ${version ?: 'unknown'}${classpath*.name.join(' ')}。範本引擎可以使用提供的動作進行配置。

請注意,預設情況下,所有跳脫序列(\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)

根據提供的閉包新增內容過濾器。將使用每一行(去除行尾符號)呼叫閉包,並且應傳回一個字串來取代該行,或傳回 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)

新增一個內容過濾器,用於複製期間。多次呼叫 filter 會將額外的過濾器新增到過濾器鏈中。每個過濾器都應實作 java.io.FilterReader。包含 org.apache.tools.ant.filters.* 以存取所有標準 Ant 過濾器。

過濾器屬性可以使用 Groovy map 語法指定。

範例

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

根據提供的轉換器新增內容過濾器。將使用每一行(去除行尾符號)呼叫閉包,並且應傳回一個字串來取代該行,或傳回 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)

新增一個 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 closure)

重新命名來源檔案。將使用單一參數(檔案名稱)呼叫閉包。閉包應傳回一個字串物件,其中包含新的目標名稱。閉包可能會傳回 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)

重新命名來源檔案。將使用單一參數(檔案名稱)呼叫函數。函數應傳回一個新的目標名稱。函數可能會傳回 null,在這種情況下,將使用原始名稱。

CopySpec with(CopySpec... sourceSpecs)

將給定的規範新增為此規範的子規範。

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

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