java_common_

回報問題 查看來源 Nightly

Starlark 中 Java 編譯支援的公用程式。

成員

• BootClassPathInfo
• compile
• JavaRuntimeInfo
• JavaToolchainInfo
• 合併
• pack_sources
• run_ijar
• stamp_jar

BootClassPathInfo

Provider java_common.BootClassPathInfo

用於提供 bootclasspath 資訊的供應商

compile

struct java_common.compile(ctx, *, source_jars=[], source_files=[], output, output_source_jar=None, javac_opts=[], deps=[], runtime_deps=[], exports=[], plugins=[], exported_plugins=[], native_libraries=[], annotation_processor_additional_inputs=[], annotation_processor_additional_outputs=[], strict_deps='ERROR', java_toolchain, bootclasspath=None, host_javabase=None, sourcepath=[], resources=[], resource_jars=[], classpath_resources=[], neverlink=False, enable_annotation_processing=True, enable_compile_jar_action=True, add_exports=[], add_opens=[])

從 Starlark 規則實作中編譯 Java 來源檔案/jars 檔案，並傳回代表編譯結果的提供者，可新增至這項規則所發出的提供者組合。

參數

參數	說明
ctx	ctx；必要 規則內容。
source_jars	File 的 sequence；預設為 [] 這是要編譯的 jar 清單。至少須指定 source_jars 或 source_files 其中之一。
source_files	File 的 sequence；預設為 [] 這是要編譯的 Java 來源檔案清單。至少須指定 source_jars 或 source_files 其中之一。
output	檔案；必要
output_source_jar	File；或 None；預設為 None 輸出來源 jar。如果不設定，預設值為 `{output_jar}-src.jar`。
javac_opts	「string」的 sequence；預設值為 [] 所需的 javac 選項清單。
deps	struct 的 sequence；預設值為 [] 。依附元件清單。
runtime_deps	結構的 sequence；預設為 [] 執行階段依附元件的清單。
exports	struct 的 sequence；預設為 [] 匯出項目清單。
plugins	結構體的「序列」；或「序列」的序列；預設值為 [] 外掛程式清單。
exported_plugins	結構體的「序列」；結構的「序列」；預設為 [] 匯出的外掛程式清單。
native_libraries	CcInfo 的序列；預設值為 [] CC 這個程式庫所需的原生程式庫依附元件。
annotation_processor_additional_inputs	File 的 sequence；預設為 [] Java 編譯動作除了用於註解處理的 Java 來源外，還會進行輸入。
annotation_processor_additional_outputs	File 的 sequence；預設為 [] Java 編譯動作除了透過註解處理的類別 jar 以外，還會輸出輸出內容清單。
strict_deps	string；預設值為 'ERROR' ，這是一個字串，用來指定嚴格 deps 的處理方式。可能的值：「OFF」、「ERROR」、「WARN」和「DEFAULT」。詳情請參閱 --strict_java_deps flag. By default 'ERROR'.
java_toolchain	資訊；必要 這項編譯作業要使用的 JavaToolchainInfo。必要。
bootclasspath	預設值為 None 要用於這項編譯的 BootClassPathInfo。 如果存在，則會覆寫與所提供 java_toolchain 相關聯的 bootclasspath。
host_javabase	預設值為 None 已淘汰。此參數已淘汰，並將在近期內移除。請勿仰賴這項功能。這項功能已停用 --incompatible_java_common_parameters。請使用這個標記確認您的程式碼是否與即將移除的程式碼相容。 已淘汰：您可以捨棄這個參數 (host_javabase 隨附 java_toolchain)
sourcepath	「File」的 sequence；預設為 []
resources	「File」的 sequence；預設為 []
resource_jars	「File」的 sequence；預設為 []
classpath_resources	「File」的 sequence；預設為 []
neverlink	bool；預設值為 False
enable_annotation_processing	bool；預設值為 True 。這會停用這項編譯中的註解處理功能，導致外掛程式或 Export_plugins 中提供的所有註解處理工具遭到忽略。
enable_compile_jar_action	bool；預設值為 True 啟用標頭編譯或 ijar 建立功能。如果設為 False，系統就會強制在任何依附元件的編譯類別路徑中使用完整的類別 jar。此操作適用於非程式庫目標 (例如沒有依附元件的二進位檔)。
add_exports	字串的 sequence；預設值為 [] ，允許這個程式庫存取指定的 /。
add_opens	字串的 sequence；預設值為 [] ，允許這個程式庫以反射方式存取指定的 /。

JavaRuntimeInfo

Provider java_common.JavaRuntimeInfo

這個金鑰用於擷取提供者，其中包含目前使用的 Java 執行階段相關資訊。

JavaToolchainInfo

Provider java_common.JavaToolchainInfo

此金鑰用於擷取提供者，其中包含目前使用的 Java 工具鍊相關資訊。

合併

struct java_common.merge(providers)

將指定的提供者合併為單一 JavaInfo。

參數

參數	說明
providers	結構體的 sequence；必要 要合併的提供者清單。

pack_sources

File java_common.pack_sources(actions, *, output_jar=None, output_source_jar=None, sources=[], source_jars=[], java_toolchain, host_javabase=None)

將來源和來源 jar 封裝至單一來源 jar 檔案。通常會將傳回值傳遞至

JavaInfo#source_jar

.須至少提供一個 output_jar 或 output_source_jar 參數。

參數

參數	說明
actions	actions；必要 ctx.actions
output_jar	File；或 None；預設值為 None 已淘汰。此參數已淘汰，並將在近期內移除。請勿仰賴這項功能。這項功能已停用 --incompatible_java_common_parameters。請使用這個標記確認您的程式碼是否與即將移除的程式碼相容。 已淘汰：規則的輸出 jar。用來為產生的來源 jar 命名。參數會將 output_source_jar 參數設為「{output_jar}-src.jar」。請直接使用 output_source_jar 參數。
output_source_jar	File；或 None；預設為 None 輸出來源 jar。
sources	File 的 sequence；預設為 [] 要封裝至來源 jar 的 Java 來源檔案清單。
source_jars	File 的 sequence；預設為 [] 要封裝至來源 jar 的來源 jar 清單。
java_toolchain	資訊；必要 用於尋找 ijar 工具的 JavaToolchainInfo。
host_javabase	預設值為 None 已淘汰。此參數已淘汰，並將在近期內移除。請勿仰賴這項功能。這項功能已停用 --incompatible_java_common_parameters。請使用這個標記確認您的程式碼是否與即將移除的程式碼相容。 已淘汰：您可以捨棄這個參數 (host_javabase 隨附 java_toolchain)

run_ijar

File java_common.run_ijar(actions, *, jar, target_label=None, java_toolchain)

在罐子上執行 ijar，然後將其去除方法主體。這樣有助於減少僅針對方法實作進行簡單變更的任何重新編譯期間的相依 jar 檔案。傳回值通常會傳遞至 JavaInfo#compile_jar。

參數

參數	說明
actions	actions；必要 ctx.actions
jar	File；必要 用於執行 ijar 的 jar 檔案。
target_label	Label (標籤) 或 None；預設值為 None 要用來蓋印 jar 檔案的目標標籤。用於 add_dep 支援服務。一般而言，您想傳送 ctx.label 來使用目前規則的標籤蓋章。
java_toolchain	資訊；必要 用於尋找 ijar 工具的 JavaToolchainInfo。

stamp_jar

File java_common.stamp_jar(actions, *, jar, target_label, java_toolchain)

設定具有 add_dep 支援目標標籤的 jar 檔案。傳回值通常會傳遞至 JavaInfo#compile_jar。盡可能使用 run_ijar。

參數

參數	說明
actions	actions；必要 ctx.actions
jar	檔案；必要 要執行戳記_jar 的 jar 檔案。
target_label	標籤；必要 要用來蓋印 jar 檔案的目標標籤。用於 add_dep 支援服務。一般而言，您想傳送 ctx.label 來使用目前規則的標籤蓋章。
java_toolchain	資訊；必要 用來找到戳記_jar 工具的 JavaToolchainInfo。