AbstractCodeQualityTask

目錄

屬性
方法
腳本區塊
屬性詳細資訊
方法詳細資訊
API 文件AbstractCodeQualityTask
已知子類型
Checkstyle
CodeNarc
Pmd

注意：此類別為孵化中 (incubating)，未來 Gradle 版本可能會變更。

程式碼品質 Task 的基礎類別。

屬性

屬性描述
excludes

排除模式的集合。

ignoreFailures
孵化中 (Incubating)

指定當此 Task 執行的驗證失敗時，建置是否應中斷。

includes

包含模式的集合。

javaLauncher
孵化中 (Incubating)

用於啟動 worker process 的 Java 啟動器

maxHeapSize
孵化中 (Incubating)

worker process 的最大堆積大小。若未指定，Gradle 將提供最大堆積大小。支援類似命令列選項 -Xmx 的單位，例如 "1g"。

minHeapSize
孵化中 (Incubating)

worker process 的最小堆積大小。若未指定，則不設定最小堆積大小。支援類似命令列選項 -Xms 的單位，例如 "1g"。

source

套用包含和排除模式後，此 Task 的來源。忽略不存在的來源檔案。

方法

方法描述
exclude(excludeSpec)

新增排除規格。此方法可多次呼叫以附加新的規格。給定的 Closure 會傳遞 FileTreeElement 作為其參數。Closure 應傳回 true 或 false。範例

exclude(excludes)

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

exclude(excludes)

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

exclude(excludeSpec)

新增排除規格。此方法可多次呼叫以附加新的規格。若未提供排除項，則不會排除任何檔案。若提供排除項，則檔案不得符合任何排除模式才能進行處理。

include(includeSpec)

新增包含規格。此方法可多次呼叫以附加新的規格。給定的 Closure 會傳遞 FileTreeElement 作為其參數。若未提供包含項，則將包含此容器中的所有檔案。若提供包含項，則檔案必須符合至少一個包含模式或規格才能包含在內。

include(includes)

新增 ANT 樣式的包含模式。此方法可多次呼叫以附加新的模式，並且可在單次呼叫中指定多個模式。若未提供包含項，則將包含此容器中的所有檔案。若提供包含項，則檔案必須符合至少一個包含模式才能進行處理。

include(includes)

新增 ANT 樣式的包含模式。此方法可多次呼叫以附加新的模式，並且可在單次呼叫中指定多個模式。若未提供包含項，則將包含此容器中的所有檔案。若提供包含項，則檔案必須符合至少一個包含模式才能進行處理。

include(includeSpec)

新增包含規格。此方法可多次呼叫以附加新的規格。若未提供包含項，則將包含此容器中的所有檔案。若提供包含項，則檔案必須符合至少一個包含模式或規格才能包含在內。

source(sources)

為此 Task 新增一些來源。給定的來源物件將根據 Project.files(java.lang.Object[]) 進行評估。

腳本區塊

無腳本區塊

屬性詳細資訊

Set<String> excludes

排除模式的集合。

boolean ignoreFailures

注意：此屬性為孵化中 (incubating)，未來 Gradle 版本可能會變更。

指定當此 Task 執行的驗證失敗時，建置是否應中斷。

預設值
false

Set<String> includes

包含模式的集合。

Property<JavaLauncher> javaLauncher

注意：此屬性為孵化中 (incubating)，未來 Gradle 版本可能會變更。

用於啟動 worker process 的 Java 啟動器

Property<String> maxHeapSize

注意：此屬性為孵化中 (incubating)，未來 Gradle 版本可能會變更。

worker process 的最大堆積大小。若未指定，Gradle 將提供最大堆積大小。支援類似命令列選項 -Xmx 的單位，例如 "1g"。

Property<String> minHeapSize

注意：此屬性為孵化中 (incubating)，未來 Gradle 版本可能會變更。

worker process 的最小堆積大小。若未指定，則不設定最小堆積大小。支援類似命令列選項 -Xms 的單位，例如 "1g"。

FileTree source

套用包含和排除模式後，此 Task 的來源。忽略不存在的來源檔案。

來源的 PathSensitivity 設定為 PathSensitivity.ABSOLUTE。若您的來源較不嚴格，請在您的子類別中覆寫此方法以相應地變更它。

方法詳細資訊

SourceTask exclude(Closure excludeSpec)

新增排除規格。此方法可多次呼叫以附加新的規格。給定的 Closure 會傳遞 FileTreeElement 作為其參數。Closure 應傳回 true 或 false。範例

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

若未提供排除項，則不會排除任何檔案。若提供排除項，則檔案不得符合任何排除模式才能進行處理。

SourceTask exclude(Iterable<String> excludes)

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

SourceTask exclude(String... excludes)

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

SourceTask exclude(Spec<FileTreeElement> excludeSpec)

新增排除規格。此方法可多次呼叫以附加新的規格。若未提供排除項，則不會排除任何檔案。若提供排除項，則檔案不得符合任何排除模式才能進行處理。

SourceTask include(Closure includeSpec)

新增包含規格。此方法可多次呼叫以附加新的規格。給定的 Closure 會傳遞 FileTreeElement 作為其參數。若未提供包含項，則將包含此容器中的所有檔案。若提供包含項，則檔案必須符合至少一個包含模式或規格才能包含在內。

SourceTask include(Iterable<String> includes)

新增 ANT 樣式的包含模式。此方法可多次呼叫以附加新的模式，並且可在單次呼叫中指定多個模式。若未提供包含項，則將包含此容器中的所有檔案。若提供包含項，則檔案必須符合至少一個包含模式才能進行處理。

SourceTask include(String... includes)

新增 ANT 樣式的包含模式。此方法可多次呼叫以附加新的模式，並且可在單次呼叫中指定多個模式。若未提供包含項，則將包含此容器中的所有檔案。若提供包含項，則檔案必須符合至少一個包含模式才能進行處理。

SourceTask include(Spec<FileTreeElement> includeSpec)

新增包含規格。此方法可多次呼叫以附加新的規格。若未提供包含項，則將包含此容器中的所有檔案。若提供包含項，則檔案必須符合至少一個包含模式或規格才能包含在內。

SourceTask source(Object... sources)

為此 Task 新增一些來源。給定的來源物件將根據 Project.files(java.lang.Object[]) 進行評估。