blob: 2e6f23cbea69d3d3be2b224d1695789cb15cc648 [file] [view]
# `java`
| Rule | Description |
| ---: | :--- |
| [java_proto_compile](#java_proto_compile) | Generates a srcjar with protobuf *.java files |
| [java_grpc_compile](#java_grpc_compile) | Generates a srcjar with protobuf+gRPC *.java files |
| [java_proto_library](#java_proto_library) | Generates a jar with compiled protobuf *.class files |
| [java_grpc_library](#java_grpc_library) | Generates a jar with compiled protobuf+gRPC *.class files |
---
## `java_proto_compile`
Generates a srcjar with protobuf *.java files
### `WORKSPACE`
```python
load("@build_stack_rules_proto//java:deps.bzl", "java_proto_compile")
java_proto_compile()
```
### `BUILD.bazel`
```python
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
| Name | Type | Default | Description |
| ---: | :--- | ------- | ----------- |
| deps | `list<ProtoInfo>` | `[]` | List of labels that provide a `ProtoInfo` (such as `native.proto_library`) |
### Optional Attributes
| Name | Type | Default | Description |
| ---: | :--- | ------- | ----------- |
| verbose | `int` | `0` | The 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* |
---
## `java_grpc_compile`
Generates a srcjar with protobuf+gRPC *.java files
### `WORKSPACE`
```python
load("@build_stack_rules_proto//java:deps.bzl", "java_grpc_compile")
java_grpc_compile()
```
### `BUILD.bazel`
```python
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
| Name | Type | Default | Description |
| ---: | :--- | ------- | ----------- |
| deps | `list<ProtoInfo>` | `[]` | List of labels that provide a `ProtoInfo` (such as `native.proto_library`) |
### Optional Attributes
| Name | Type | Default | Description |
| ---: | :--- | ------- | ----------- |
| verbose | `int` | `0` | The 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* |
---
## `java_proto_library`
Generates a jar with compiled protobuf *.class files
### `WORKSPACE`
```python
load("@build_stack_rules_proto//java:deps.bzl", "java_proto_library")
java_proto_library()
```
### `BUILD.bazel`
```python
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
| Name | Type | Default | Description |
| ---: | :--- | ------- | ----------- |
| deps | `list<ProtoInfo>` | `[]` | List of labels that provide a `ProtoInfo` (such as `native.proto_library`) |
### Optional Attributes
| Name | Type | Default | Description |
| ---: | :--- | ------- | ----------- |
| verbose | `int` | `0` | The 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* |
---
## `java_grpc_library`
Generates a jar with compiled protobuf+gRPC *.class files
### `WORKSPACE`
```python
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`
```python
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
| Name | Type | Default | Description |
| ---: | :--- | ------- | ----------- |
| deps | `list<ProtoInfo>` | `[]` | List of labels that provide a `ProtoInfo` (such as `native.proto_library`) |
### Optional Attributes
| Name | Type | Default | Description |
| ---: | :--- | ------- | ----------- |
| verbose | `int` | `0` | The 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* |