https://github.com/Fadelis/protoc-gen-java-optional

Protoc Generator Java extension plugin to extends generated classes with setOrClear and getOptional methods.
https://github.com/Fadelis/protoc-gen-java-optional

grpc-java-nullable grpc-java-optional grpc-java-plugin java-protobuf-nullable protoc-gen-java-plugin set-or-clear

Last synced: 3 months ago
JSON representation

Protoc Generator Java extension plugin to extends generated classes with setOrClear and getOptional methods.

• Host: GitHub
• URL: https://github.com/Fadelis/protoc-gen-java-optional
• Owner: Fadelis
• License: apache-2.0
• Created: 2021-07-16T14:59:03.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-10-27T05:10:36.000Z (over 1 year ago)
• Last Synced: 2024-08-04T04:07:21.574Z (6 months ago)
• Topics: grpc-java-nullable, grpc-java-optional, grpc-java-plugin, java-protobuf-nullable, protoc-gen-java-plugin, set-or-clear
• Language: Java
• Homepage:
• Size: 38.1 KB
• Stars: 7
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-grpc - protoc-gen-java-optional - A Java Protoc plugin extending generated java classes with null safe `setOrClear` and `getOptional` methods. (Language-Specific / Java)

README

        
# Protoc Generator Java Optional ![Build pipeline](https://github.com/Fadelis/protoc-gen-java-optional/workflows/Build%20pipeline/badge.svg)

A Java Protoc plugin extending generated java classes with null safe `setOrClear` and `getOptional` methods. Also works for

protobuf primitive variables with the [optional](https://github.com/protocolbuffers/protobuf/blob/v3.12.0/docs/field_presence.md)

keyword.

## Quick usage

### Using `protoc` binary

You must have `protoc` binary installed in your system and have to download `protoc-gen-java-optional` executable based on

platform from GitHub [releases](https://github.com/Fadelis/protoc-gen-java-optional/releases)

or at `Files` section in [maven-central](https://mvnrepository.com/artifact/org.grpcmock/protoc-gen-java-optional/1.10.0).

With defaults:

```

protoc --proto-path=./protos/ --java_out=./out/directory --plugin=protoc-gen-java-optional=./path/to/plugin/protoc-gen-java-optional.exe --java-optional_out=./out/directory ./protos/sample.proto

```

With some parameters:

```

protoc --proto-path=./protos/ --java_out=./out/directory --plugin=protoc-gen-java-optional=./path/to/plugin/protoc-gen-java-optional.exe --java-optional_out=setter_optional=true,use_primitive_optionals=true:./out/directory ./protos/sample.proto

```

### Using [protobuf-maven-plugin](https://github.com/xolstice/protobuf-maven-plugin)

```xml

  

    

      kr.motd.maven

      os-maven-plugin

      ${os-maven-plugin.version}

    

  

  

    

      org.xolstice.maven.plugins

      protobuf-maven-plugin

      ${protobuf-maven-plugin.version}

      

        

          protobuf

          

            compile

          

          generate-sources

          

            com.google.protobuf:protoc:${protoc.version}:exe:${os.detected.classifier}

            ${project.basedir}/src/test/resources/

            true

            

              

                java-optional

                org.grpcmock

                protoc-gen-java-optional

                1.10.0

                org.grpcmock.protoc.plugin.OptionalGenerator

              

            

          

        

      

    

  

```

This plugin does not support passing java protoc plugin parameters

until https://github.com/xolstice/protobuf-maven-plugin/issues/56 is solved, so default options will be used.

### Using [protoc-jar-maven-plugin](https://github.com/os72/protoc-jar-maven-plugin)

This maven plugin is not supported as it does not support running multiple output types as a single protoc command. This protoc

plugin needs to be run together with the `java_out` target in order to extend generated classes.

## Configuration parameters

- `setter_object` - boolean flag indicating whether to add setter methods with the nullable object itself as argument.

  Default `true`.

- `setter_optional` - boolean flag indicating whether to add setter methods with `Optional` as an argument. Default `false`.

- `getter_optional` - boolean flag indicating whether to add getter methods returning `Optional`. Default `true`.

- `use_primitive_optionals` - boolean flag indicating whether to use primitive

  optionals (`OptionalInt/OptionalLong/OptionalDouble`) for `optional` protobuf primitive's setters and getters. Default `false`.