java_common

問題を報告する ソースを表示 ナイトリー · 8.0 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, 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	ctx; 必須 ルールのコンテキスト。
source_jars	File のシーケンス。デフォルトは [] 。コンパイルする JAR のリスト。source_jars または source_files の少なくとも 1 つを指定する必要があります。
source_files	ファイルのシーケンス。デフォルトは [] 。コンパイルする Java ソースファイルのリスト。source_jars または source_files の少なくとも 1 つを指定する必要があります。
output	ファイル。必須
output_source_jar	ファイル、または None。デフォルトは None。 出力ソース JAR。未設定の場合のデフォルトは「{output_jar}-src.jar」です。
javac_opts	文字列のシーケンス。デフォルトは [] 。必要な javac オプションのリスト。
deps	構造体のシーケンス。デフォルトは [] 。依存関係のリスト。
runtime_deps	構造体のシーケンス。デフォルトは [] 。実行時の依存関係のリスト。
exports	構造体のシーケンス。デフォルトは [] です。エクスポートのリスト。
plugins	構造体のシーケンス、または構造体のシーケンス。デフォルトは [] 。プラグインのリスト。
exported_plugins	構造体のシーケンス、または構造体のシーケンス。デフォルトは [] 。エクスポートされたプラグインのリスト。
native_libraries	CcInfo のシーケンス。デフォルトは [] 。このライブラリに必要な CC ネイティブ ライブラリの依存関係です。
annotation_processor_additional_inputs	ファイルのシーケンス。デフォルトは [] 。アノテーション処理用の Java ソースに加えて、Java コンパイル アクションが受け取る入力のリスト。
annotation_processor_additional_outputs	File のシーケンス。デフォルトは [] 。アノテーション処理のクラス jar に加えて、Java コンパイル アクションが出力する出力のリスト。
strict_deps	文字列。デフォルトは 'ERROR' です。 厳格な依存関係の処理方法を指定する文字列。有効な値は「OFF」、「ERROR」、「WARN」、「DEFAULT」です。詳しくは、--strict_java_deps flag. By default 'ERROR'. をご覧ください。
java_toolchain	Info; 必須 このコンパイルに使用する JavaToolchainInfo。必須。
bootclasspath	デフォルトは None です。このコンパイルに使用する BootClassPathInfo。指定されている場合、指定された java_toolchain に関連付けられたブートクラスパスをオーバーライドします。
sourcepath	ファイルのシーケンス。デフォルトは [] です。
resources	ファイルのシーケンス。デフォルトは [] です。
resource_jars	ファイルのシーケンス。デフォルトは [] です。
classpath_resources	ファイルのシーケンス。デフォルトは [] です。
neverlink	bool。デフォルトは False です。
enable_annotation_processing	bool; デフォルトは True このコンパイルでアノテーション処理を無効にします。これにより、plugins または依存関係の exported_plugins で指定されたアノテーション プロセッサは無視されます。
enable_compile_jar_action	bool; デフォルトは 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_source_jar=None, sources=[], source_jars=[], java_toolchain)

ソースとソース JAR を単一のソース JAR ファイルにパッケージ化します。通常、戻り値は

JavaInfo#source_jar

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

パラメータ

パラメータ	説明
actions	actions; 必須 ctx.actions
output_source_jar	ファイル、または None。デフォルトは None。 出力ソース JAR。
sources	ファイルのシーケンス。デフォルトは [] 。ソース JAR にパッケージ化される Java ソースファイルのリスト。
source_jars	ファイルのシーケンス。デフォルトは [] 。ソース JAR にパッケージ化されるソース JAR のリスト。
java_toolchain	Info（必須） ijar ツールの検索に使用される JavaToolchainInfo。

run_ijar

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

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

パラメータ

パラメータ	説明
actions	actions; 必須 ctx.actions
jar	ファイル。必須 jar を実行する jar。
target_label	ラベル、または None。デフォルトは None。 jar にスタンプを押すターゲット ラベル。add_dep のサポートに使用されます。通常は、ctx.label を渡して、現在のルールのラベルで jar にスタンプを押します。
java_toolchain	Info（必須） ijar ツールの検索に使用される JavaToolchainInfo。

stamp_jar

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

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

パラメータ

パラメータ	説明
actions	actions; 必須 ctx.actions
jar	ファイル。必須 stamp_jar を実行する jar。
target_label	ラベル。必須 jar にスタンプを押すターゲット ラベル。add_dep のサポートに使用されます。通常は、ctx.label を渡して、現在のルールのラベルで jar にスタンプを押します。
java_toolchain	Info; 必須 stamp_jar ツールの検索に使用される JavaToolchainInfo。