java_common

問題を報告する ソースを表示 ナイトリー · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Starlark での Java コンパイル サポート用のユーティリティ。

メンバー

• BootClassPathInfo
• コンパイル
• JavaRuntimeInfo
• JavaToolchainInfo
• 統合
• pack_sources
• run_ijar
• stamp_jar

BootClassPathInfo

Provider java_common.BootClassPathInfo

ブートクラスパス情報を提供するために使用されるプロバイダ

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	必須 ルールのコンテキスト。
source_jars	File のシーケンス。デフォルトは [] コンパイルする JAR のリスト。source_jars または source_files の少なくとも 1 つを指定する必要があります。
source_files	File のシーケンス。デフォルトは [] コンパイルする Java ソースファイルのリスト。source_jars または source_files の少なくとも 1 つを指定する必要があります。
output	必須
output_source_jar	ファイル、または None。デフォルトは None。 出力ソース JAR。省略可。設定しない場合のデフォルトは {output_jar}-src.jar です。
javac_opts	string のシーケンス。デフォルトは [] 目的の javac オプションのリスト。省略可。
deps	構造体のシーケンス。デフォルトは [] です。依存関係のリスト。省略可。
runtime_deps	structのシーケンス。デフォルトは [] 。実行時の依存関係のリスト。省略可。
exports	構造体のシーケンス。デフォルトは [] です。エクスポートのリスト。省略可。
plugins	structのシーケンス、またはstructのシーケンス。デフォルトは [] 。プラグインのリスト。省略可。
exported_plugins	structのシーケンス、またはstructのシーケンス。デフォルトは [] 。エクスポートされたプラグインのリスト。省略可。
native_libraries	CcInfo のシーケンス。デフォルトは [] このライブラリに必要な CC ネイティブ ライブラリ依存関係です。
annotation_processor_additional_inputs	ファイルのシーケンス。デフォルトは [] 。アノテーション処理用の Java ソースに加えて、Java コンパイル アクションが受け取る入力のリスト。
annotation_processor_additional_outputs	File のシーケンス。デフォルトは [] Java コンパイル アクションがアノテーション処理のクラス jar に加えて出力する出力のリスト。
strict_deps	デフォルトは 'ERROR' 厳格な依存関係の処理方法を指定する文字列。有効な値は「OFF」、「ERROR」、「WARN」、「DEFAULT」です。詳細については、/docs/user-manual#flag--strict_java_deps をご覧ください。デフォルトは「ERROR」です。
java_toolchain	必須 このコンパイルに使用する JavaToolchainInfo。必須。
bootclasspath	デフォルトは None です。このコンパイルに使用する BootClassPathInfo。指定されている場合、指定された java_toolchain に関連付けられているブートクラスパスをオーバーライドします。省略可。
host_javabase	デフォルトは None です。非推奨。このパラメータは非推奨となり、まもなく削除されます。これに依存しないでください。--+incompatible_java_common_parameters では無効になっています。このフラグを使用すると、コードがまもなく削除される機能と互換性があることを確認できます。 非推奨: このパラメータを削除できます（host_javabase は java_toolchain で提供されます）。
sourcepath	ファイルのシーケンス。デフォルトは [] です。
resources	ファイルのシーケンス。デフォルトは [] です。
resource_jars	ファイルのシーケンス。デフォルトは [] です。
classpath_resources	ファイルのシーケンス。デフォルトは [] です。
neverlink	デフォルトは False
enable_annotation_processing	デフォルトは True このコンパイルでアノテーション処理を無効にします。これにより、plugins または依存関係の exported_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	structのシーケンス。必須 統合するプロバイダのリスト。

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	必須 ctx.actions
output_jar	ファイル、または None。デフォルトは None。 非推奨。このパラメータは非推奨となり、まもなく削除されます。これに依存しないでください。--+incompatible_java_common_parameters では無効になっています。このフラグを使用すると、コードがまもなく削除される機能と互換性があることを確認できます。 非推奨: ルールの出力 JAR。生成されたソース JAR の名前に使用されます。このパラメータは、output_source_jar パラメータを {output_jar}-src.jar に設定します。代わりに、output_source_jar パラメータを直接使用してください。
output_source_jar	ファイル、または None。デフォルトは None。 出力ソース JAR。
sources	ファイルのシーケンス。デフォルトは [] 。ソース JAR にパッケージ化される Java ソースファイルのリスト。
source_jars	ファイルのシーケンス。デフォルトは [] 。ソース JAR にパッケージ化されるソース JAR のリスト。
java_toolchain	required 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)

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

パラメータ

パラメータ	説明
actions	必須 ctx.actions
jar	必須 ijar を実行する JAR。
target_label	ラベル、または None。デフォルトは None。 jar にスタンプを押すターゲット ラベル。add_dep のサポートに使用されます。通常は、ctx.label を渡して現在のルールのラベルを jar にスタンプします。
java_toolchain	required ijar ツールを見つけるために使用する JavaToolchainInfo。

stamp_jar

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

add_dep サポート用のターゲット ラベルで jar にスタンプを押します。通常、戻り値は JavaInfo#compile_jar に渡されます。可能であれば run_ijar を使用することをおすすめします。

パラメータ

パラメータ	説明
actions	必須 ctx.actions
jar	必須 stamp_jar を実行する jar。
target_label	required jar に印を付けるターゲット ラベル。add_dep のサポートに使用されます。通常は、ctx.label を渡して現在のルールのラベルを jar にスタンプします。
java_toolchain	required stamp_jar ツールを見つけるために使用する JavaToolchainInfo。