CODEWITHSUNDEEP
protocol-buffersproto
Suresh Lakku
Suresh Lakku

Reputation: 95

How to define value and id for enum in protobuf? (proto java client)

I am new to protobuf usage.

i am planning to write protobuf def with enum(s) in it.

is there any way to provide id, value and as well description in it.

after compilation i want generated enum should be equivalent as below example

enum Sample{
  W(0, "W"), P(0, "P"), C(0, "C"), B(0, "B")
  private final int id;
  private final String value;

  private Status(int id, String value) {
    this.id= id;
    this.value = value;
  }
}

Any help is very appreciated.

Upvotes: 4

Views: 10900

Answers (1)

Kenton Varda
Kenton Varda

Reputation: 45171

There is no way to generate exactly the Java enum in your example, but you can use "custom options" to add arbitrary annotation to protobuf declarations. See the documentation (scroll down a little bit to "custom options").

import "google/protobuf/descriptor.proto";

extend google.protobuf.EnumValueOptions {
  optional string name = 51234;
}

enum MyEnum {
  FOO = 0 [(name) = "foo"];
  BAR = 1 [(name) = "bar"];
}

The annotation is accessed through the EnumValueDescriptor interface.

Upvotes: 9

Related Questions