io.protobufx.protoc.gen.spring.generator

Class ProtocPluginCodeGenerator

java.lang.Object

io.protobufx.protoc.gen.spring.generator.ProtocPluginCodeGenerator

public abstract class ProtocPluginCodeGenerator
extends java.lang.Object

This is the central class that does the heavy lifting of: 1) Reading and parsing the PluginProtos.CodeGeneratorRequest 2) Generating the code (extensions of this class control how this is actually done). 3) Writing out the PluginProtos.CodeGeneratorResponse.

The user of this class should implement the abstract methods and override the necessary code generation methods, and then use generate() from their plugin's Main class to do the generation.

Field Summary

Fields

Modifier and Type	Field and Description
protected Parameters	parameters Stores build parameters.

Constructor Summary

Constructors

Constructor and Description
ProtocPluginCodeGenerator()

Method Summary

Modifier and Type	Method and Description
void	generate() This is the interface into the ProtocPluginCodeGenerator.
protected java.util.Optional<java.lang.String>	generateCode(AbstractDescriptor abstractDescriptor)
protected java.util.Optional<java.lang.String>	generateEnumCode(EnumDescriptor enumDescriptor) Generate the Java code for a particular EnumDescriptor.
protected abstract java.lang.String	generateImports() Generate the Java imports required by the generated code in your plugin.
protected java.util.Optional<java.lang.String>	generateMessageCode(MessageDescriptor messageDescriptor) Generate the Java code for a particular MessageDescriptor.
protected abstract java.lang.String	generatePluginJavaClass(java.lang.String protoJavaClass) This method should return the name of the plugin's outer Java class for a particular file, derived from the name of the outer Java class generated by the regular protobuf compiler.
protected java.util.Optional<java.lang.String>	generateServiceCode(ServiceDescriptor serviceDescriptor) Generate the Java code for a particular ServiceDescriptor.
protected abstract java.lang.String	getPluginName() This method should return the name of the plugin.
protected boolean	skipFile(com.google.protobuf.DescriptorProtos.FileDescriptorProto fileDescriptorProto) Whether or not to skip generating code for a particular file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

parameters

protected final Parameters parameters

Stores build parameters.

Constructor Detail

ProtocPluginCodeGenerator

public ProtocPluginCodeGenerator()

Method Detail

getPluginName

@Nonnull
protected abstract java.lang.String getPluginName()

This method should return the name of the plugin. This will appear in the comments of the generated files (so that it's clear which plugin generated them).

Returns:

The name of the plugin.

generatePluginJavaClass

@Nonnull
protected abstract java.lang.String generatePluginJavaClass(@Nonnull
                                                                     java.lang.String protoJavaClass)

This method should return the name of the plugin's outer Java class for a particular file, derived from the name of the outer Java class generated by the regular protobuf compiler. All generated classes from a particular file will be inside this outer class. This is identical to the behaviour of the regular protobuf compiler for Java code, where all classes inside a single .proto file are wrapped in a single Java outer class.

Parameters:

protoJavaClass - The Java class generated by the regular protobuf compiler. For example if you have a TestDTO.proto file, this will be "TestDTO".

Returns:

The Java class name for the file generated by the user's plugin. For example, if your plugin is "protoc-generate-money", this might be "TestDTOMoney."

generateImports

@Nonnull
protected abstract java.lang.String generateImports()

Generate the Java imports required by the generated code in your plugin.

Returns:

A string, listing all the imports. e.g: "import java.util.List;import java.util.Map;"

generateEnumCode

@Nonnull
protected java.util.Optional<java.lang.String> generateEnumCode(@Nonnull
                                                                         EnumDescriptor enumDescriptor)

Generate the Java code for a particular EnumDescriptor.

Parameters:

enumDescriptor - The EnumDescriptor for an enum defined in the .proto file.

Returns:

An Optional containing a string of Java code generated from the input descriptor. An empty Optional if this particular plugin doesn't want to generate anything based on enums.

generateMessageCode

@Nonnull
protected java.util.Optional<java.lang.String> generateMessageCode(@Nonnull
                                                                            MessageDescriptor messageDescriptor)

Generate the Java code for a particular MessageDescriptor.

Parameters:

messageDescriptor - The MessageDescriptor for a message defined in the .proto file.

Returns:

An Optional containing a string of Java code generated from the input descriptor. An empty Optional if this particular plugin doesn't want to generate anything based on messages.

generateServiceCode

@Nonnull
protected java.util.Optional<java.lang.String> generateServiceCode(@Nonnull
                                                                            ServiceDescriptor serviceDescriptor)

Generate the Java code for a particular ServiceDescriptor.

Parameters:

serviceDescriptor - The ServiceDescriptor for a message defined in the .proto file.

Returns:

An Optional containing a string of Java code generated from the input descriptor. An empty Optional if this particular plugin doesn't want to generate anything based on services.

skipFile

protected boolean skipFile(@Nonnull
                           com.google.protobuf.DescriptorProtos.FileDescriptorProto fileDescriptorProto)

Whether or not to skip generating code for a particular file. Some plugins may only want to generate code for specific files (e.g. files with services defined in them). This method provides a way to do that. Skipped files still get processed for types defined in them. The skipping applies only to the code generation step.

Parameters:

fileDescriptorProto - The descriptor of the file.

Returns:

True if the plugin does not want to generate any code for this file. False otherwise.

generateCode

@Nonnull
protected final java.util.Optional<java.lang.String> generateCode(@Nonnull
                                                                           AbstractDescriptor abstractDescriptor)

generate

public final void generate()
                    throws java.io.IOException

This is the interface into the ProtocPluginCodeGenerator. Plugin implementations should call this method from their Main class to: 1) Read the PluginProtos.CodeGeneratorRequest from stdin. 2) Generate code and format a PluginProtos.CodeGeneratorResponse. 3) Write the response to stdout.

Throws:

java.io.IOException - If there is an issue with reading/writing from/to stdin/stdout.