tree: 6ee9252da3a228635d0004720a140968def1a3fd
  1. example/
  2. BUILD.bazel
  3. deps.bzl
  4. java_grpc_compile.bzl
  5. java_grpc_library.bzl
  6. java_proto_compile.bzl
  7. java_proto_library.bzl
  8. javadoc_library.bzl
  9. README.md
java/README.md

java

RuleDescription
java_proto_compileGenerates a srcjar with protobuf *.java files
java_grpc_compileGenerates a srcjar with protobuf+gRPC *.java files
java_proto_libraryGenerates a jar with compiled protobuf *.class files
java_grpc_libraryGenerates a jar with compiled protobuf+gRPC *.class files

java_proto_compile

Generates a srcjar with protobuf *.java files

WORKSPACE

load("@build_stack_rules_proto//java:deps.bzl", "java_proto_compile")

java_proto_compile()

BUILD.bazel

load("@build_stack_rules_proto//java:java_proto_compile.bzl", "java_proto_compile")

java_proto_compile(
    name = "person_java_proto",
    deps = ["@build_stack_rules_proto//example/proto:person_proto"],
)

Mandatory Attributes

NameTypeDefaultDescription
depslist<ProtoInfo>[]List of labels that provide a ProtoInfo (such as native.proto_library)

Optional Attributes

NameTypeDefaultDescription
pluginslist<ProtoPluginInfo>[]List of labels that provide a ProtoPluginInfo
plugin_optionslist<string>[]List of additional ‘global’ plugin options (applies to all plugins). To apply plugin specific options, use the options attribute on proto_plugin
outputslist<generated file>[]List of additional expected generated file outputs
verboseint0The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
include_importsboolTruePass the --include_imports argument to the protoc_plugin
include_source_infoboolTruePass the --include_source_info argument to the protoc_plugin
transitiveboolTrueGenerate outputs for both *.proto directly named in deps AND all their transitive proto_library dependencies
transitivitystring_dict{}Transitive filters to apply when the ‘transitive’ property is enabled. This string_dict can be used to exclude or explicitly include protos from the compilation list by using exclude or include respectively as the dict value

java_grpc_compile

Generates a srcjar with protobuf+gRPC *.java files

WORKSPACE

load("@build_stack_rules_proto//java:deps.bzl", "java_grpc_compile")

java_grpc_compile()

BUILD.bazel

load("@build_stack_rules_proto//java:java_grpc_compile.bzl", "java_grpc_compile")

java_grpc_compile(
    name = "greeter_java_grpc",
    deps = ["@build_stack_rules_proto//example/proto:greeter_grpc"],
)

Mandatory Attributes

NameTypeDefaultDescription
depslist<ProtoInfo>[]List of labels that provide a ProtoInfo (such as native.proto_library)

Optional Attributes

NameTypeDefaultDescription
pluginslist<ProtoPluginInfo>[]List of labels that provide a ProtoPluginInfo
plugin_optionslist<string>[]List of additional ‘global’ plugin options (applies to all plugins). To apply plugin specific options, use the options attribute on proto_plugin
outputslist<generated file>[]List of additional expected generated file outputs
verboseint0The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
include_importsboolTruePass the --include_imports argument to the protoc_plugin
include_source_infoboolTruePass the --include_source_info argument to the protoc_plugin
transitiveboolTrueGenerate outputs for both *.proto directly named in deps AND all their transitive proto_library dependencies
transitivitystring_dict{}Transitive filters to apply when the ‘transitive’ property is enabled. This string_dict can be used to exclude or explicitly include protos from the compilation list by using exclude or include respectively as the dict value

java_proto_library

Generates a jar with compiled protobuf *.class files

WORKSPACE

load("@build_stack_rules_proto//java:deps.bzl", "java_proto_library")

java_proto_library()

BUILD.bazel

load("@build_stack_rules_proto//java:java_proto_library.bzl", "java_proto_library")

java_proto_library(
    name = "person_java_library",
    deps = ["@build_stack_rules_proto//example/proto:person_proto"],
)

Mandatory Attributes

NameTypeDefaultDescription
depslist<ProtoInfo>[]List of labels that provide a ProtoInfo (such as native.proto_library)

Optional Attributes

NameTypeDefaultDescription
pluginslist<ProtoPluginInfo>[]List of labels that provide a ProtoPluginInfo
plugin_optionslist<string>[]List of additional ‘global’ plugin options (applies to all plugins). To apply plugin specific options, use the options attribute on proto_plugin
outputslist<generated file>[]List of additional expected generated file outputs
verboseint0The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
include_importsboolTruePass the --include_imports argument to the protoc_plugin
include_source_infoboolTruePass the --include_source_info argument to the protoc_plugin
transitiveboolTrueGenerate outputs for both *.proto directly named in deps AND all their transitive proto_library dependencies
transitivitystring_dict{}Transitive filters to apply when the ‘transitive’ property is enabled. This string_dict can be used to exclude or explicitly include protos from the compilation list by using exclude or include respectively as the dict value

java_grpc_library

Generates a jar with compiled protobuf+gRPC *.class files

WORKSPACE

load("@build_stack_rules_proto//:deps.bzl", "io_grpc_grpc_java")

io_grpc_grpc_java()

load("@io_grpc_grpc_java//:repositories.bzl", "grpc_java_repositories")

grpc_java_repositories(omit_com_google_protobuf = True)

load("@build_stack_rules_proto//java:deps.bzl", "java_grpc_library")

java_grpc_library()

BUILD.bazel

load("@build_stack_rules_proto//java:java_grpc_library.bzl", "java_grpc_library")

java_grpc_library(
    name = "greeter_java_library",
    deps = ["@build_stack_rules_proto//example/proto:greeter_grpc"],
)

Mandatory Attributes

NameTypeDefaultDescription
depslist<ProtoInfo>[]List of labels that provide a ProtoInfo (such as native.proto_library)

Optional Attributes

NameTypeDefaultDescription
pluginslist<ProtoPluginInfo>[]List of labels that provide a ProtoPluginInfo
plugin_optionslist<string>[]List of additional ‘global’ plugin options (applies to all plugins). To apply plugin specific options, use the options attribute on proto_plugin
outputslist<generated file>[]List of additional expected generated file outputs
verboseint0The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc
include_importsboolTruePass the --include_imports argument to the protoc_plugin
include_source_infoboolTruePass the --include_source_info argument to the protoc_plugin
transitiveboolTrueGenerate outputs for both *.proto directly named in deps AND all their transitive proto_library dependencies
transitivitystring_dict{}Transitive filters to apply when the ‘transitive’ property is enabled. This string_dict can be used to exclude or explicitly include protos from the compilation list by using exclude or include respectively as the dict value