java_common

Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.7
Starlark での Java コンパイル サポートのユーティリティ。

メンバー

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 必須
ルールのコンテキスト。
source_jars File のシーケンス。デフォルトは []
です。コンパイルする jar のリスト。source_jars または source_files の少なくとも 1 つを指定する必要があります。
source_files File の sequence。デフォルトは []
です。 コンパイルする Java ソースファイルのリスト。source_jars または source_files の少なくとも 1 つを指定する必要があります。
output 必須
output_source_jar File。または None。デフォルトは None
です。出力ソース jar。省略可。設定しない場合、デフォルトは `{output_jar}-src.jar` です。
javac_opts 文字列のシーケンス。デフォルトは []
です。 目的の javac オプションのリスト。省略可。
deps struct のシーケンス。デフォルトは []
です。依存関係のリスト。省略可。
runtime_deps struct の sequence。デフォルトは []
です。 実行時の依存関係のリスト。省略可。
exports struct の sequence。デフォルトは []
。エクスポートのリスト。省略可。
plugins struct の シーケンス、または struct の シーケンス。デフォルトは []
です。 プラグインのリスト。省略可。
exported_plugins struct の シーケンス、または struct の シーケンス。デフォルトは []
です。 エクスポートされたプラグインのリスト。省略可。
native_libraries CcInfo のシーケンス。デフォルトは []
です。 このライブラリに必要な CC ネイティブ ライブラリの依存関係。
annotation_processor_additional_inputs File のシーケンス。デフォルトは []
です。 Java コンパイル アクションがアノテーション処理用の Java ソースに加えて取得する入力のリスト。
annotation_processor_additional_outputs File の sequence。デフォルトは []
です。 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 に関連付けられた bootclasspath をオーバーライドします。省略可。
host_javabase デフォルトは None
です。非推奨。このパラメータは非推奨となり、まもなく削除されます。これに依存しないでください。--+incompatible_java_common_parameters で無効になっています。このフラグを使用して、コードが削除予定の API と互換性があることを確認します。
非推奨: このパラメータは削除できます（host_javabase は java_toolchain で提供されます）
sourcepath File の sequence。デフォルトは []
です。
resources File の sequence。デフォルトは []
です。
resource_jars File の sequence。デフォルトは []
です。
classpath_resources File の sequence。デフォルトは []
です。
デフォルトは False
です。
enable_annotation_processing デフォルトは True
です。 このコンパイルでのアノテーション処理を無効にします。これにより、プラグインまたは deps の exported_plugins で提供されるアノテーション プロセッサは無視されます。
enable_compile_jar_action デフォルトは True
です。ヘッダーのコンパイルまたは ijar の作成を有効にします。False に設定すると、依存関係のあるコンパイル クラスパスでフルクラス jar の使用が強制されます。これは、依存関係のないバイナリなどのライブラリ以外のターゲットで使用することを目的としています。
add_exports string のシーケンス。デフォルトは []
このライブラリが指定された /にアクセスできるようにします。省略可。
add_opens string の sequence。デフォルトは []
です。 このライブラリが指定された /にリフレクションでアクセスできるようにします。省略可。

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 を 1 つのソース jar ファイルにパックします。通常、戻り値は

JavaInfo#source_jar

パラメータ output_jar または output_source_jar の少なくとも 1 つが必要です。

パラメータ

パラメータ 説明
actions required
ctx.actions
output_jar File。または None。デフォルトは None
です。 非推奨。このパラメータは非推奨となり、まもなく削除されます。これに依存しないでください。--+incompatible_java_common_parameters で無効になっています。このフラグを使用して、コードが削除予定の API と互換性があることを確認します。
非推奨: ルールの出力 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 のシーケンス。デフォルトは []
です。 ソース jar にパックされるソース jar のリスト。
java_toolchain 必須
ijar ツールを見つけるために使用される JavaToolchainInfo。
host_javabase デフォルトは None
です。非推奨。このパラメータは非推奨となり、まもなく削除されます。これに依存しないでください。--+incompatible_java_common_parameters で無効になっています。このフラグを使用して、コードが削除予定の API と互換性があることを確認します。
非推奨: このパラメータは削除できます（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 required
ctx.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 required
ctx.actions
jar 必須
stamp_jar を実行する jar。
target_label 必須
jar にスタンプするターゲット ラベル。add_dep のサポートに使用されます。通常は、ctx.label を渡して、現在のルールのラベルで jar をスタンプします。
java_toolchain 必須
stamp_jar ツールを見つけるために使用される JavaToolchainInfo。