java_common

. Starlark'ta Java derleme desteği için yardımcı programlar.

Üyeler

BootClassPathInfo

Provider java_common.BootClassPathInfo

bootclasspath bilgilerini sağlamak için kullanılan sağlayıcı

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=[])

Bir Starlark kuralının uygulanmasından Java kaynak dosyaları/jar'ları derler, derlemenin sonuçlarını temsil eden ve bu kuralın yayınladığı sağlayıcı grubuna eklenebilecek bir sağlayıcı döndürür.

Parametreler

Parametre Açıklama
ctx zorunlu
Kural bağlamı.
source_jars sequence of Files; varsayılan = []
Derlenecek jar'ların listesi. source_jars veya source_files özelliklerinden en az biri belirtilmelidir.
source_files sequence of Files; varsayılan = []
Derlenecek Java kaynak dosyalarının listesi. source_jars veya source_files özelliklerinden en az biri belirtilmelidir.
output zorunlu
output_source_jar File; or None; varsayılan = Yok
Çıkış kaynağı jar. İsteğe bağlı. Ayarlanmadan bırakılırsa varsayılan olarak "{çıkış_jar}-src.jar" değeri kullanılır.
javac_opts sequence of strings; varsayılan = []
İstenen Javac seçeneklerinin listesi. İsteğe bağlı.
deps sequence of JavaInfos; varsayılan = []
Bağımlılıkların listesi. İsteğe bağlı.
runtime_deps sequence of JavaInfos; varsayılan = []
Çalışma zamanı bağımlılıklarının listesi. İsteğe bağlı.
exports sequence of JavaInfos; varsayılan = []
Dışa aktarmaların listesi. İsteğe bağlı.
plugins sequence of JavaPluginInfos; or sequence of JavaInfos; varsayılan = []
Eklenti listesi. İsteğe bağlı.
exported_plugins sequence of JavaPluginInfos; or sequence of JavaInfos; varsayılan = []
Dışa aktarılan eklentilerin listesi. İsteğe bağlı.
native_libraries sequence of CcInfos; varsayılan = []
Bu kitaplık için gereken yerel kitaplık bağımlılıklarını CC alanına ekleyin.
annotation_processor_additional_inputs sequence of Files; varsayılan = []
Ek açıklama işleme için Java kaynaklarına ek olarak Java derleme işleminin yapacağı girişlerin listesi.
annotation_processor_additional_outputs sequence of Files; varsayılan = []
Ek açıklama işlemede sınıf jar dosyasına ek olarak Java derleme işleminin çıkaracağı çıkışların listesi.
strict_deps varsayılan = 'HATA'
Katı kısıtlamaların nasıl işleneceğini belirten bir dize. Olası değerler: 'OFF', 'ERROR', 'WARN' ve "VARSAYILAN" yer alır. Daha fazla bilgi için /docs/user-manual#flag--strict_java_deps sayfasına göz atın. Varsayılan olarak 'ERROR'.
java_toolchain zorunlu
Bu derleme için kullanılacak JavaToolchainInfo. Zorunludur.
host_javabase varsayılan = Yok
Kullanımdan kaldırıldı. Bu parametrenin desteği sonlandırılmıştır ve yakında kaldırılacaktır. Lütfen bu metrikten yararlanmayın. --+incompatible_java_common_parameters ile devre dışı bırakıldı. Kodunuzun, kaldırılma olasılığı yüksek olan içerikle uyumlu olduğunu doğrulamak için bu işareti kullanın.
Kullanımdan kaldırıldı: Bu parametreyi bırakabilirsiniz (host_javabase, java_toolchain ile sağlanır)
sourcepath sequence of Files; varsayılan = []
resources sequence of Files; varsayılan = []
resource_jars sequence of Files; varsayılan = []
classpath_resources sequence of Files; varsayılan = []
varsayılan = Yanlış
enable_annotation_processing varsayılan = Doğru
Bu derlemede ek açıklama işlemeyi devre dışı bırakarak eklentilerde veya dep'lerdeki dışa aktarılmış_eklentilerde sağlanan ek açıklama işlemcilerinin yoksayılmasına neden olur.
enable_compile_jar_action varsayılan = Doğru
Üstbilgi derlemeyi veya ijar oluşturmayı etkinleştirir. Yanlış değerine ayarlanırsa bağımlıların derleme sınıf yollarında tam sınıf jar'ın kullanımını zorlar. Bu, bağımlı olmayan ikili programlar gibi kitaplık dışı hedefler tarafından kullanılmak üzere tasarlanmıştır.
add_exports sequence of strings; varsayılan = []
Bu kitaplığın belirtilen /öğesine erişmesine izin ver. İsteğe bağlıdır.
add_opens sequence of strings; varsayılan = []
Bu kitaplığın, belirtilen /öğesine yansıtıcı şekilde erişmesine izin ver. İsteğe bağlıdır.

JavaPluginInfo

Provider java_common.JavaPluginInfo

Java eklentileri hakkında bilgi içeren sağlayıcıyı almak için kullanılan anahtar. JavaPluginInfo ile aynı değere erişilebilir.
Yeni kodda JavaPluginInfo kullanmayı tercih edin.

JavaRuntimeInfo

Provider java_common.JavaRuntimeInfo

Sağlayıcıyı almak için kullanılan ve kullanılan Java çalışma zamanı hakkında bilgi içeren anahtar.

JavaToolchainInfo

Provider java_common.JavaToolchainInfo

Kullanılan Java araç zinciri hakkında bilgi içeren sağlayıcıyı almak için kullanılan anahtar.

make_non_strict

JavaInfo java_common.make_non_strict(java_info)

Doğrudan jar bölümü bölümü, belirtilen Java sağlayıcının hem doğrudan hem de dolaylı jar'larının birleşimi olan yeni bir Java sağlayıcısı döndürür.

Parametreler

Parametre Açıklama
java_info zorunlu
Java bilgisi.

birleştirmek

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

Belirtilen sağlayıcıları tek bir JavaInfo'da birleştirir.

Parametreler

Parametre Açıklama
providers sequence of JavaInfos; gerekli
Birleştirilecek sağlayıcıların listesi.
merge_java_outputs varsayılan = Doğru
merge_source_jars varsayılan = Doğru

pack_sources

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

Kaynakları ve kaynak jar'ları tek bir kaynak jar dosyasında paketler. Döndürülen değer genellikle

JavaInfo#source_jar

Çıkış_jar veya çıkış_kaynak_jar parametrelerinden en az biri gereklidir.

Parametreler

Parametre Açıklama
actions zorunlu
ctx.actions
output_jar File; or None; varsayılan = Yok
Kullanımdan kaldırıldı. Bu parametrenin desteği sonlandırılmıştır ve yakında kaldırılacaktır. Lütfen bu metrikten yararlanmayın. --+incompatible_java_common_parameters ile devre dışı bırakıldı. Kodunuzun, kaldırılma olasılığı yüksek olan içerikle uyumlu olduğunu doğrulamak için bu işareti kullanın.
Kullanımdan kaldırıldı: Kuralın çıkış jar'ı. Sonuçta ortaya çıkan kaynak jar'ı adlandırmak için kullanılır. Parametre, çıkış_source_jar parametresini "{çıkış_jar}-src.jar" olarak ayarlar.Bunun yerine, doğrudan exit_source_jar parametresini kullanın.
output_source_jar File; or None; varsayılan = Yok
Çıkış kaynağı jar.
sources sequence of Files; varsayılan = []
Kaynak jar'a paketlenecek Java kaynak dosyalarının listesi.
source_jars sequence of Files; varsayılan = []
Kaynak kavanoza paketlenecek kaynak jar'ların listesi.
java_toolchain zorunlu
ijar aracını bulmak için kullanılan bir JavaToolchainInfo.
host_javabase varsayılan = Yok
Kullanımdan kaldırıldı. Bu parametrenin desteği sonlandırılmıştır ve yakında kaldırılacaktır. Lütfen bu metrikten yararlanmayın. --+incompatible_java_common_parameters ile devre dışı bırakıldı. Kodunuzun, kaldırılma olasılığı yüksek olan içerikle uyumlu olduğunu doğrulamak için bu işareti kullanın.
Kullanımdan kaldırıldı: Bu parametreyi bırakabilirsiniz (host_javabase, java_toolchain ile sağlanır)
None sonucunu döndürebilir.

sağlayıcı

Provider java_common.provider

Java bildirilen sağlayıcıyı döndürür.
JavaInfo ile aynı değere erişilebilir.
Yeni kodda JavaInfo kullanmayı tercih edin.

run_ijar

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

Bir kavanozun üzerinde ijar'ı çalıştırarak yöntem gövdelerini çıkarır. Bu, yalnızca yöntem uygulamalarında basit değişikliklerden oluşan yeniden derleme işlemleri sırasında bağımlı jar'ların yeniden oluşturulmasının azaltılmasına yardımcı olur. Döndürülen değer genellikle JavaInfo#compile_jar işlevine iletilir.

Parametreler

Parametre Açıklama
actions zorunlu
ctx.actions
jar zorunlu
ijar dosyasının üzerinde çalıştırılacağı kavanoz.
target_label Label; or None; varsayılan = Yok
Kavanoza damgalanacak hedef etiket. add_dep desteği için kullanılır. Genellikle, kavanozu geçerli kuralın etiketiyle damgalamak için ctx.label değerini geçirirsiniz.
java_toolchain zorunlu
ijar aracını bulmak için kullanılan bir JavaToolchainInfo.

stamp_jar

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

add_dep desteği için bir kavanoza hedef etiketi ekler. Döndürülen değer genellikle JavaInfo#compile_jar işlevine iletilir. Mümkün olduğunda run_ijar kullanmayı tercih edin.

Parametreler

Parametre Açıklama
actions zorunlu
ctx.actions
jar zorunlu
stamp_jar öğesinin üzerinde çalıştırılacağı kavanoz.
target_label zorunlu
Kavanoza damgalanacak hedef etiket. add_dep desteği için kullanılır. Genellikle, kavanozu geçerli kuralın etiketiyle damgalamak için ctx.label değerini geçirirsiniz.
java_toolchain zorunlu
stamp_jar aracını bulmak için kullanılan bir JavaToolchainInfo.

to_java_binary_info

JavaInfo java_common.to_java_binary_info(java_info)

Belirtilen JavaInfo'nun, bir java_binary tarafından döndürülen minimum bilgiyle birlikte bir kopyasını döndürür .

Parametreler

Parametre Açıklama
java_info zorunlu
İyileştirilecek JavaInfo.