JavaPluginInfo

Java プラグインに関する情報をカプセル化するプロバイダ。

現時点でサポートされているプラグインの種類は、アノテーション プロセッサのみです。

メンバー

JavaPluginInfo

JavaPluginInfo JavaPluginInfo(runtime_deps, *, processor_class, data=[], generates_api=False)

JavaPluginInfo コンストラクタ。

パラメータ

パラメータ 説明
runtime_deps sequence of JavaInfos; 必須
アノテーション プロセッサを含むライブラリ。
processor_class string; or None; 必須
Java コンパイラがアノテーション プロセッサへのエントリ ポイントとして使用する完全修飾クラス名。
data sequence of Files; or depset of Files; default = []
このアノテーション プロセッサが実行時に必要とするファイル。
generates_api default = False
このアノテーション プロセッサが API コードを生成する場合は true に設定します。

このようなアノテーション プロセッサは、ヘッダー JAR(メソッド シグネチャを含む)を生成する前に Java ターゲットに適用されます。API プラグインが存在しない場合、ヘッダー JAR がソースから生成されるため、クリティカル パスが削減されます。

警告: このパラメータはビルドのパフォーマンスに影響するため、必要な場合にのみ使用してください。

api_generating_plugins

JavaPluginData JavaPluginInfo.api_generating_plugins

このターゲットによって定義またはエクスポートされた API を生成するプラグインに関するデータを返します。

これらのアノテーション プロセッサは、(メソッド シグネチャを含む)ヘッダー JAR を生成する前に Java ターゲットに適用されます。API プラグインが存在しない場合、ヘッダー JAR がソースから生成されるため、クリティカル パスが削減されます。

api_generating_pluginsplugins のサブセットです。

java_outputs

list JavaPluginInfo.java_outputs

この Java/Java に似たターゲットの出力に関する情報を返します。

プラグイン

JavaPluginData JavaPluginInfo.plugins

消費ターゲットが適用する必要があるすべてのプラグインに関するデータを返します。

これは通常、java_plugin 自体か、1 つ以上のプラグインをエクスポートする java_library です。

java_library はアノテーション処理を実行し、このフィールドのすべてのプラグインを deps 属性と plugins 属性で指定します。

to_json

string JavaPluginInfo.to_json()

この権限のサポートは終了しており、この API は非推奨で、まもなく削除されます。頼りにしないでください。これは ---incompatible_struct_has_no_methods無効になります。このフラグを使用して、近く予定されている削除との互換性があることを確認します。
構造体パラメータから JSON 文字列を作成します。このメソッドは、すべての構造体要素が(再帰的に)文字列、整数、ブール値、その他の構造体、これらの型のリスト、またはこれらの型の文字列キーと値を含む辞書である場合にのみ機能します。文字列内の引用符や改行はエスケープされます。例:
struct(key=123).to_json()
# {"key":123}

struct(key=True).to_json()
# {"key":true}

struct(key=[1, 2, 3]).to_json()
# {"key":[1,2,3]}

struct(key='text').to_json()
# {"key":"text"}

struct(key=struct(inner_key='text')).to_json()
# {"key":{"inner_key":"text"}}

struct(key=[struct(inner_key=1), struct(inner_key=2)]).to_json()
# {"key":[{"inner_key":1},{"inner_key":2}]}

struct(key=struct(inner_key=struct(inner_inner_key='text'))).to_json()
# {"key":{"inner_key":{"inner_inner_key":"text"}}}

非推奨: 代わりに json.encode(x) または json.encode_indent(x) を使用してください。これらは構造体以外の値に対して機能し、構造体フィールドの名前空間を汚染しません。

to_proto

string JavaPluginInfo.to_proto()

この権限のサポートは終了しており、この API は非推奨で、まもなく削除されます。頼りにしないでください。これは ---incompatible_struct_has_no_methods無効になります。このフラグを使用して、近く予定されている削除との互換性があることを確認します。
構造体パラメータからテキスト メッセージを作成します。このメソッドは、すべての構造体要素が(再帰的に)なり、文字列、整数、ブール値、その他の構造体、辞書、またはこれらの型のリストである場合にのみ機能します。文字列内の引用符や改行はエスケープされます。構造体キーは並べ替えられた順序で反復されます。例:
struct(key=123).to_proto()
# key: 123

struct(key=True).to_proto()
# key: true

struct(key=[1, 2, 3]).to_proto()
# key: 1
# key: 2
# key: 3

struct(key='text').to_proto()
# key: "text"

struct(key=struct(inner_key='text')).to_proto()
# key {
#   inner_key: "text"
# }

struct(key=[struct(inner_key=1), struct(inner_key=2)]).to_proto()
# key {
#   inner_key: 1
# }
# key {
#   inner_key: 2
# }

struct(key=struct(inner_key=struct(inner_inner_key='text'))).to_proto()
# key {
#    inner_key {
#     inner_inner_key: "text"
#   }
# }

struct(foo={4: 3, 2: 1}).to_proto()
# foo: {
#   key: 4
#   value: 3
# }
# foo: {
#   key: 2
#   value: 1
# }

非推奨: 代わりに proto.encode_text(x) を使用してください。