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; 默认值 = []
执行期间此注解处理器所需的文件。
generates_api 默认值 = False
在此注解处理器生成 API 代码时设置为 true。

在生成 Java 目标的标头 jar(包含方法签名)之前,会将此类注解处理器应用于该目标。如果不存在 API 插件,则从源代码生成标头 jar 文件,从而减少关键路径。

警告:此参数会影响构建性能,请仅在必要时使用。

api_generating_plugins

JavaPluginData JavaPluginInfo.api_generating_plugins

返回有关生成由此目标定义或导出的插件的 API 的数据。

在生成 Java 目标的标头 jar(包含方法签名)之前,这些注解处理器会应用于该目标。如果不存在 API 插件,则从源代码生成标头 JAR 文件,从而缩减关键路径。

api_generating_pluginsplugins 的子集。

java_outputs

list JavaPluginInfo.java_outputs

返回有关此类似 Java/Java 的目标的输出的信息。

插件

JavaPluginData JavaPluginInfo.plugins

返回有关使用方目标应应用的所有插件的数据。

这通常是 java_plugin 本身或导出一个或多个插件的 java_library

java_library 会运行注释处理,此字段中的所有插件都显示在 depsplugins 属性中。

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_ending(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)。