java_common

問題を報告するopen_in_new ソースを表示open_in_new

Starlark における Java コンパイル サポート用のユーティリティ。

メンバー

• BootClassPathInfo
• compile
• JavaRuntimeInfo
• JavaToolchainInfo
• merge
• 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 ソースファイル/JAR をコンパイルし、コンパイルの結果を表すプロバイダを返します。このプロバイダは、このルールによって出力されるプロバイダのセットに追加できます。

パラメータ

パラメータ	説明
ctx	required ルール コンテキスト。
source_jars	File のシーケンス。デフォルトは []。 コンパイルされる JAR のリスト。source_jars または source_files を少なくとも 1 つ指定する必要があります。
source_files	File のシーケンス（デフォルトは []）。 コンパイルされる Java ソースファイルのリスト。source_jars または source_files を少なくとも 1 つ指定する必要があります。
output	必須
output_source_jar	File、または None。デフォルトは None。 出力ソースの JAR。（省略可）設定しない場合のデフォルトは、{output_jar}-src.jar です。
javac_opts	string のシーケンス（デフォルトは []）。 必要な javac オプションのリスト。省略可。
deps	構造体のシーケンス（デフォルトは []）。 依存関係のリスト。省略可。
runtime_deps	構造体のシーケンス（デフォルトは []）。 ランタイム依存関係のリスト。省略可。
exports	構造体のシーケンス（デフォルトは []）。 エクスポートのリスト。省略可。
plugins	struct のシーケンス、または struct のシーケンス。デフォルトは [] です。 プラグインのリスト。省略可。
exported_plugins	struct のシーケンス、または struct のシーケンス。デフォルトは [] です。 エクスポートされたプラグインのリスト。省略可。
native_libraries	CcInfo のシーケンス。デフォルトは [] です。 このライブラリに必要な CC ネイティブ ライブラリ依存関係。
annotation_processor_additional_inputs	File のシーケンス。デフォルトは []。 アノテーション処理用の Java ソースに加えて、Java コンパイル アクションが行う入力のリスト。
annotation_processor_additional_outputs	File のシーケンス。デフォルトは []。 アノテーション処理のクラス JAR に加えて、Java コンパイル アクションが出力する出力のリスト。
strict_deps	デフォルトは 'ERROR' です。 厳格な依存関係の処理方法を指定する文字列。有効な値は「OFF」、「ERROR」、「WARN」、「DEFAULT」です。詳しくは、/docs/user-manual#flag--strict_java_deps をご覧ください。デフォルトは「ERROR」です。
java_toolchain	必須 このコンパイルに使用される JavaToolchainInfo。必須。
bootclasspath	デフォルトは None です。 このコンパイルに使用される BootClassPathInfo。存在する場合、指定された java_ツールチェーン に関連付けられている bootclasspath をオーバーライドします。省略可。
host_javabase	デフォルトは None です。 非推奨。このパラメータは非推奨で、まもなく削除されます。頼りにしないでください。これは --+incompatible_java_common_parameters で無効になります。このフラグを使用して、近く予定されている削除との互換性があることを確認します。 非推奨: このパラメータは削除できます（host_javabase は java_ツールチェーンに付属しています）
sourcepath	File のシーケンス。デフォルトは [] です。
resources	File のシーケンス。デフォルトは [] です。
resource_jars	File のシーケンス。デフォルトは [] です。
classpath_resources	File のシーケンス。デフォルトは [] です。
neverlink	デフォルトは False です。
enable_annotation_processing	デフォルトは True です。 このコンパイルでアノテーション処理を無効にします。これにより、プラグインまたは deps の export_plugins で指定されたアノテーション プロセッサは無視されます。
enable_compile_jar_action	デフォルトは True です。 ヘッダー コンパイルまたは ijar 作成を有効にします。False に設定すると、すべての依存先のコンパイル クラスパスで完全なクラス JAR が使用されます。これは、依存関係のないバイナリなど、ライブラリ以外のターゲットで使用されるためです。
add_exports	文字列のシーケンス。デフォルトは []。 このライブラリが指定の /にアクセスできるようにします。省略可。
add_opens	文字列のシーケンス。デフォルトは []。 このライブラリが指定の /にリフレクティブにアクセスできるようにします。省略可。

JavaRuntimeInfo

Provider java_common.JavaRuntimeInfo

使用されている Java ランタイムに関する情報を含むプロバイダを取得するために使用されるキー。

JavaToolchainInfo

Provider java_common.JavaToolchainInfo

使用されている Java ツールチェーンに関する情報を含むプロバイダを取得するために使用されるキー。

merge

struct java_common.merge(providers)

指定されたプロバイダを 1 つの JavaInfo に結合します。

パラメータ

パラメータ	説明
providers	構造体のシーケンス。 必須 マージするプロバイダのリスト。

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 のうち少なくとも 1 つのパラメータが必要です。

パラメータ

パラメータ	説明
actions	必須 resourcemanager.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 のシーケンス（デフォルトは []）。 ソース JAR にパックされる Java ソースファイルのリスト。
source_jars	File のシーケンス（デフォルトは []）。 ソース JAR にパックされるソース JAR のリスト。
java_toolchain	必須 ijar ツールを見つけるために使用される JavaToolchainInfo。
host_javabase	デフォルトは None です。 非推奨。このパラメータは非推奨で、まもなく削除されます。頼りにしないでください。これは --+incompatible_java_common_parameters で無効になります。このフラグを使用して、近く予定されている削除との互換性があることを確認します。 非推奨: このパラメータは削除できます（host_javabase は java_ツールチェーンに付属しています）

run_ijar

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

jar で ijar を実行し、メソッド本体を削除します。これにより、メソッドの実装の単純な変更のみで構成される再コンパイル時に、依存する JAR の再構築を削減できます。通常、戻り値は JavaInfo#compile_jar に渡されます。

パラメータ

パラメータ	説明
actions	必須 resourcemanager.actions
jar	必須 ijar を実行する JAR。
target_label	ラベル。または None。デフォルトは None。 jar にスタンプを付けるターゲット ラベル。add_dep のサポートに使用されます。通常は、ctx.label を渡して、現在のルールのラベルで JAR にスタンプを設定します。
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	必須 resourcemanager.actions
jar	必須 stamp_jar を実行する jar。
target_label	必須 JAR にスタンプするためのターゲット ラベル。add_dep のサポートに使用されます。通常は、ctx.label を渡して、現在のルールのラベルで JAR にスタンプを設定します。
java_toolchain	必須 stamp_jar ツールを見つけるために使用される JavaToolchainInfo。