dev.jeka.plugins.protobuf

Class JkProtoc

java.lang.Object

dev.jeka.plugins.protobuf.JkProtoc

public class JkProtoc
extends java.lang.Object

A wrapper over the Java implementation of Protoc compiler.

Field Summary

Fields

Modifier and Type	Field and Description
static dev.jeka.core.api.depmanagement.JkModuleId	PROTOBUF_MODULE Module coordinate that should be included in the project as a compile-time dependency in order to use the generated classes.
static java.lang.String	PROTOC_JAR_VERSION

Method Summary

Modifier and Type	Method and Description
JkProtoc	addOptions(java.lang.String... options) Options to be passed to the protoc compiler.
JkProtoc	addProtoPath(java.nio.file.Path path) Add a location of which to search for import.
void	compile(dev.jeka.core.api.file.JkPathTreeSet protoFiles, java.lang.String... extraOptions) Compiles the specified proto files.
void	compile(java.util.List<java.nio.file.Path> protoFiles, java.lang.String... extraOptions) Compiles the specified proto files.
void	compile(java.nio.file.Path protoFileDir, java.lang.String... extraOptions) Compiles the specified proto files.
static JkProtoc	of()
static JkProtoc	ofJava(java.nio.file.Path outputPath)
JkProtoc	setJavaOutputDir(java.nio.file.Path path) The location of the generated Java sources.
JkProtoc	setLogCommand(boolean logCommand)
JkProtoc	setLogOutput(boolean logOutput)
JkProtoc	setProtocJarVersion(java.lang.String protocJarVersion) Sets the version of the Java implementation for the protoc compiler.
JkProtoc	setRepos(dev.jeka.core.api.depmanagement.JkRepoSet repos) Sets the repositories to fretch the protoc jar compiler from.

Methods inherited from class java.lang.Object

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

Field Detail

PROTOBUF_MODULE

public static final dev.jeka.core.api.depmanagement.JkModuleId PROTOBUF_MODULE

Module coordinate that should be included in the project as a compile-time dependency in order to use the generated classes.

PROTOC_JAR_VERSION

public static final java.lang.String PROTOC_JAR_VERSION

See Also:

Constant Field Values

Method Detail

of

public static JkProtoc of()

ofJava

public static JkProtoc ofJava(java.nio.file.Path outputPath)

compile

public void compile(dev.jeka.core.api.file.JkPathTreeSet protoFiles,
                    java.lang.String... extraOptions)

Compiles the specified proto files.

Parameters:

protoFiles - The proto files to compile.

extraOptions - Extra options to path to the protoc compiler.

compile

public void compile(java.nio.file.Path protoFileDir,
                    java.lang.String... extraOptions)

Compiles the specified proto files.

Parameters:

protoFileDir - The repository where lies proto files to compile.

extraOptions - Extra options to path to the protoc compiler.

compile

public void compile(java.util.List<java.nio.file.Path> protoFiles,
                    java.lang.String... extraOptions)

Compiles the specified proto files.

Parameters:

protoFiles - The proto files to compile.

extraOptions - Extra options to path to the protoc compiler.

setJavaOutputDir

public JkProtoc setJavaOutputDir(java.nio.file.Path path)

The location of the generated Java sources.

addProtoPath

public JkProtoc addProtoPath(java.nio.file.Path path)

Add a location of which to search for import. Shortcut for option `--proto_path=PATH`.

See : https://manpages.ubuntu.com/manpages/xenial/man1/protoc.1.html

addOptions

public JkProtoc addOptions(java.lang.String... options)

Options to be passed to the protoc compiler. See https://manpages.ubuntu.com/manpages/xenial/man1/protoc.1.html

setRepos

public JkProtoc setRepos(dev.jeka.core.api.depmanagement.JkRepoSet repos)

Sets the repositories to fretch the protoc jar compiler from. Default is maven central

setProtocJarVersion

public JkProtoc setProtocJarVersion(java.lang.String protocJarVersion)

Sets the version of the Java implementation for the protoc compiler.

setLogCommand

public JkProtoc setLogCommand(boolean logCommand)

setLogOutput

public JkProtoc setLogOutput(boolean logOutput)