java_umum

Utilitas untuk dukungan kompilasi Java di Starlark.

Anggota

BootClassPathInfo

Provider java_common.BootClassPathInfo

Penyedia yang digunakan untuk menyediakan informasi bootclasspath

compile

JavaInfo 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, host_javabase=None, sourcepath=[], resources=[], resource_jars=[], classpath_resources=[], neverlink=False, enable_annotation_processing=True, enable_compile_jar_action=True, add_exports=[], add_opens=[])

Mengompilasi file sumber/jar Java dari implementasi aturan Starlark dan menampilkan penyedia yang mewakili hasil kompilasi dan dapat ditambahkan ke set penyedia yang dikeluarkan oleh aturan ini.

Parameter

Parameter Deskripsi
ctx wajib
Konteks aturan.
source_jars sequence of Files; default = []
Daftar stoples yang akan dikompilasi. Minimal satu source_jars atau source_file harus ditentukan.
source_files sequence of Files; default = []
Daftar file sumber Java yang akan dikompilasi. Minimal satu source_jars atau source_file harus ditentukan.
output wajib
output_source_jar File; or None; default = Tidak ada
Jar sumber output. Opsional. Nilai defaultnya adalah `{output_jar}-src.jar` jika tidak disetel.
javac_opts sequence of strings; default = []
Daftar opsi javac yang diinginkan. Opsional.
deps sequence of JavaInfos; default = []
Daftar dependensi. Opsional.
runtime_deps sequence of JavaInfos; default = []
Daftar dependensi runtime. Opsional.
exports sequence of JavaInfos; default = []
Daftar ekspor. Opsional.
plugins sequence of JavaPluginInfos; or sequence of JavaInfos; default = []
Daftar plugin. Opsional.
exported_plugins sequence of JavaPluginInfos; or sequence of JavaInfos; default = []
Daftar plugin yang diekspor. Opsional.
native_libraries sequence of CcInfos; default = []
Dependensi library native CC yang diperlukan untuk library ini.
annotation_processor_additional_inputs sequence of Files; default = []
Daftar input yang akan diambil tindakan kompilasi Java selain sumber Java untuk pemrosesan anotasi.
annotation_processor_additional_outputs sequence of Files; default = []
Daftar output yang akan dihasilkan oleh tindakan kompilasi Java, selain jar class dari pemrosesan anotasi.
strict_deps default = 'ERROR'
String yang menentukan cara menangani dependensi yang ketat. Nilai yang mungkin: 'OFF', 'ERROR', 'WARN' dan 'DEFAULT'. Untuk detail selengkapnya, lihat /docs/user-manual#flag--strict_java_deps. Secara default, 'ERROR'.
java_toolchain wajib
JavaToolchainInfo yang akan digunakan untuk kompilasi ini. Wajib.
host_javabase default = Tidak ada
Tidak digunakan lagi. Parameter ini tidak digunakan lagi dan akan segera dihapus. Harap tidak bergantung padanya. Layanan ini dinonaktifkan dengan --+incompatible_java_common_parameters. Gunakan tanda ini untuk memverifikasi bahwa kode Anda kompatibel dengan penghapusan yang akan segera terjadi.
Tidak digunakan lagi: Anda dapat menghapus parameter ini (host_javabase disediakan dengan java_toolchain)
sourcepath sequence of Files; default = []
resources sequence of Files; default = []
resource_jars sequence of Files; default = []
classpath_resources sequence of Files; default = []
default = Salah
enable_annotation_processing default = Benar
Menonaktifkan pemrosesan anotasi dalam kompilasi ini, sehingga menyebabkan prosesor anotasi yang disediakan dalam plugin atau Export_plugins dari dependensi akan diabaikan.
enable_compile_jar_action default = Benar
Mengaktifkan kompilasi header atau pembuatan ijar. Jika disetel ke Salah (False), kode ini akan memaksa penggunaan jar class lengkap dalam classpath kompilasi dependensi mana pun. Melakukan hal itu dimaksudkan untuk digunakan oleh target non-library seperti biner yang tidak memiliki dependensi.
add_exports sequence of strings; default = []
Mengizinkan library ini mengakses /yang diberikan. Opsional.
add_opens sequence of strings; default = []
Mengizinkan library ini untuk mengakses /yang diberikan secara reflektif. Opsional.

JavaPluginInfo

Provider java_common.JavaPluginInfo

Kunci yang digunakan untuk mengambil penyedia yang berisi informasi tentang plugin Java. Nilai yang sama dapat diakses sebagai JavaPluginInfo.
Lebih suka menggunakan JavaPluginInfo dalam kode baru.

JavaRuntimeInfo

Provider java_common.JavaRuntimeInfo

Kunci yang digunakan untuk mengambil penyedia yang berisi informasi tentang runtime Java yang digunakan.

JavaToolchainInfo

Provider java_common.JavaToolchainInfo

Kunci yang digunakan untuk mengambil penyedia yang berisi informasi tentang toolchain Java yang digunakan.

make_non_strict

JavaInfo java_common.make_non_strict(java_info)

Menampilkan penyedia Java baru yang bagian direct-jar-nya adalah gabungan dari jar langsung dan tidak langsung dari penyedia Java yang diberikan.

Parameter

Parameter Deskripsi
java_info wajib
Info Java.

gabungkan

JavaInfo java_common.merge(providers, *, merge_java_outputs=True, merge_source_jars=True)

Menggabungkan penyedia yang diberikan menjadi satu JavaInfo.

Parameter

Parameter Deskripsi
providers sequence of JavaInfos; wajib
Daftar penyedia yang akan digabungkan.
merge_java_outputs default = Benar
merge_source_jars default = Benar

pack_sources

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

Mengemas sumber dan jar sumber ke dalam satu file jar sumber. Nilai hasil biasanya diteruskan ke

JavaInfo#source_jar

.Setidaknya salah satu parameter output_jar atau output_source_jar wajib diisi.

Parameter

Parameter Deskripsi
actions wajib
ctx.actions
output_jar File; or None; default = Tidak ada
Tidak digunakan lagi. Parameter ini tidak digunakan lagi dan akan segera dihapus. Harap tidak bergantung padanya. Layanan ini dinonaktifkan dengan --+incompatible_java_common_parameters. Gunakan tanda ini untuk memverifikasi bahwa kode Anda kompatibel dengan penghapusan yang akan segera terjadi.
Tidak digunakan lagi: Jar output aturan. Digunakan untuk memberi nama jar sumber yang dihasilkan. Parameter ini menetapkan parameter output_source_jar ke `{output_jar}-src.jar`.Gunakan parameter output_source_jar secara langsung.
output_source_jar File; or None; default = Tidak ada
Jar sumber output.
sources sequence of Files; default = []
Daftar file sumber Java yang akan dikemas ke dalam jar sumber.
source_jars sequence of Files; default = []
Daftar stoples sumber yang akan dikemas ke dalam stoples sumber.
java_toolchain wajib
JavaToolchainInfo yang akan digunakan untuk menemukan alat ijar.
host_javabase default = Tidak ada
Tidak digunakan lagi. Parameter ini tidak digunakan lagi dan akan segera dihapus. Harap tidak bergantung padanya. Layanan ini dinonaktifkan dengan --+incompatible_java_common_parameters. Gunakan tanda ini untuk memverifikasi bahwa kode Anda kompatibel dengan penghapusan yang akan segera terjadi.
Tidak digunakan lagi: Anda dapat menghapus parameter ini (host_javabase disediakan dengan java_toolchain)
Mungkin menampilkan None.

provider

Provider java_common.provider

Menampilkan penyedia yang dideklarasikan Java.
Nilai yang sama dapat diakses sebagai JavaInfo.
Lebih suka menggunakan JavaInfo dalam kode baru.

run_ijar

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

Menjalankan ijar pada stoples, menghapus isi metodenya. Hal ini membantu mengurangi build ulang jar dependen selama kompilasi ulang yang hanya terdiri dari perubahan sederhana pada implementasi metode. Nilai yang ditampilkan biasanya diteruskan ke JavaInfo#compile_jar.

Parameter

Parameter Deskripsi
actions wajib
ctx.actions
jar wajib
Stoples untuk menjalankan ijar.
target_label Label; or None; default = Tidak ada
Label target untuk memberi stempel pada stoples. Digunakan untuk dukungan add_dep. Biasanya, Anda akan meneruskan ctx.label untuk memberi stempel pada stoples dengan label aturan saat ini.
java_toolchain wajib
JavaToolchainInfo yang akan digunakan untuk menemukan alat ijar.

stamp_jar

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

Memberi stempel pada stoples dengan label target untuk dukungan add_dep. Nilai yang ditampilkan biasanya diteruskan ke JavaInfo#compile_jar. Pilih untuk menggunakan run_ijar jika memungkinkan.

Parameter

Parameter Deskripsi
actions wajib
ctx.actions
jar wajib
Stoples untuk menjalankan stamp_jar.
target_label wajib
Label target untuk memberi stempel pada stoples. Digunakan untuk dukungan add_dep. Biasanya, Anda akan meneruskan ctx.label untuk memberi stempel pada stoples dengan label aturan saat ini.
java_toolchain wajib
JavaToolchainInfo yang digunakan untuk menemukan alat stamp_jar.

to_java_binary_info

JavaInfo java_common.to_java_binary_info(java_info)

Menampilkan salinan JavaInfo yang diberikan dengan info minimal yang ditampilkan oleh java_binary

Parameter

Parameter Deskripsi
java_info wajib
JavaInfo yang akan ditingkatkan.