org.xolstice.maven.plugin.protobuf

Class Protoc.Builder

java.lang.Object

org.xolstice.maven.plugin.protobuf.Protoc.Builder

Enclosing class:

Protoc

static final class Protoc.Builder
extends Object

This class builds Protoc instances.

Constructor Summary

Constructors

Constructor and Description
Builder(String executable) Constructs a new builder.

Method Summary

Modifier and Type	Method and Description
Protoc.Builder	addPlugin(ProtocPlugin plugin) Adds a protoc plugin definition for custom code generation.
Protoc.Builder	addProtoFile(File protoFile) Adds a proto file to be compiled.
Protoc.Builder	addProtoFiles(Iterable<File> protoFiles) Adds a collection of proto files to be compiled.
Protoc.Builder	addProtoPathElement(File protopathElement) Adds the protopathElement to the protopath.
Protoc.Builder	addProtoPathElements(Iterable<File> protopathElements) Adds a number of elements to the protopath.
Protoc	build() Builds and returns a fully configured instance of Protoc wrapper.
Protoc.Builder	setCppOutputDirectory(File cppOutputDirectory) Sets the directory into which C++ source files will be generated.
Protoc.Builder	setCsharpOutputDirectory(File csharpOutputDirectory) Sets the directory into which C# source files will be generated.
Protoc.Builder	setCustomOutputDirectory(File customOutputDirectory) Sets the directory into which a custom protoc plugin will generate files.
Protoc.Builder	setJavaNanoOutputDirectory(File javaNanoOutputDirectory) Sets the directory into which JavaNano source files will be generated.
Protoc.Builder	setJavaOutputDirectory(File javaOutputDirectory) Sets the directory into which Java source files will be generated.
Protoc.Builder	setJavaScriptOutputDirectory(File javaScriptOutputDirectory) Sets the directory into which JavaScript source files will be generated.
Protoc.Builder	setNativePluginExecutable(String nativePluginExecutable)
Protoc.Builder	setNativePluginId(String nativePluginId)
Protoc.Builder	setNativePluginParameter(String nativePluginParameter)
Protoc.Builder	setPluginDirectory(File pluginDirectory)
Protoc.Builder	setPythonOutputDirectory(File pythonOutputDirectory) Sets the directory into which Python source files will be generated.
Protoc.Builder	setTempDirectory(File tempDirectory)
Protoc.Builder	useArgumentFile(boolean useArgumentFile)
Protoc.Builder	withDescriptorSetFile(File descriptorSetFile, boolean includeImports, boolean includeSourceInfoInDescriptorSet)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

Builder(String executable)

Constructs a new builder.

Parameters:

executable - The path to the protoc executable.

Method Detail

setTempDirectory

public Protoc.Builder setTempDirectory(File tempDirectory)

setJavaOutputDirectory

public Protoc.Builder setJavaOutputDirectory(File javaOutputDirectory)

Sets the directory into which Java source files will be generated.

Parameters:

javaOutputDirectory - a directory into which Java source files will be generated.

Returns:

this builder instance.

setJavaNanoOutputDirectory

public Protoc.Builder setJavaNanoOutputDirectory(File javaNanoOutputDirectory)

Sets the directory into which JavaNano source files will be generated.

Parameters:

javaNanoOutputDirectory - a directory into which Java source files will be generated.

Returns:

this builder instance.

setCppOutputDirectory

public Protoc.Builder setCppOutputDirectory(File cppOutputDirectory)

Sets the directory into which C++ source files will be generated.

Parameters:

cppOutputDirectory - a directory into which C++ source files will be generated.

Returns:

this builder instance.

setPythonOutputDirectory

public Protoc.Builder setPythonOutputDirectory(File pythonOutputDirectory)

Sets the directory into which Python source files will be generated.

Parameters:

pythonOutputDirectory - a directory into which Python source files will be generated.

Returns:

this builder instance.

setCsharpOutputDirectory

public Protoc.Builder setCsharpOutputDirectory(File csharpOutputDirectory)

Sets the directory into which C# source files will be generated.

Parameters:

csharpOutputDirectory - a directory into which C# source files will be generated.

Returns:

this builder instance.

setJavaScriptOutputDirectory

public Protoc.Builder setJavaScriptOutputDirectory(File javaScriptOutputDirectory)

Sets the directory into which JavaScript source files will be generated.

Parameters:

javaScriptOutputDirectory - a directory into which JavaScript source files will be generated.

Returns:

this builder instance.

setCustomOutputDirectory

public Protoc.Builder setCustomOutputDirectory(File customOutputDirectory)

Sets the directory into which a custom protoc plugin will generate files.

Parameters:

customOutputDirectory - a directory into which a custom protoc plugin will generate files.

Returns:

this builder instance.

addProtoFile

public Protoc.Builder addProtoFile(File protoFile)

Adds a proto file to be compiled. Proto files must be on the protopath and this method will fail if a proto file is added without first adding a parent directory to the protopath.

Parameters:

protoFile - source protobuf definitions file.

Returns:

The builder.

addPlugin

public Protoc.Builder addPlugin(ProtocPlugin plugin)

Adds a protoc plugin definition for custom code generation.

Parameters:

plugin - plugin definition

Returns:

this builder instance.

setPluginDirectory

public Protoc.Builder setPluginDirectory(File pluginDirectory)

setNativePluginId

public Protoc.Builder setNativePluginId(String nativePluginId)

setNativePluginExecutable

public Protoc.Builder setNativePluginExecutable(String nativePluginExecutable)

setNativePluginParameter

public Protoc.Builder setNativePluginParameter(String nativePluginParameter)

withDescriptorSetFile

public Protoc.Builder withDescriptorSetFile(File descriptorSetFile,
                                            boolean includeImports,
                                            boolean includeSourceInfoInDescriptorSet)

useArgumentFile

public Protoc.Builder useArgumentFile(boolean useArgumentFile)

addProtoFiles

public Protoc.Builder addProtoFiles(Iterable<File> protoFiles)

Adds a collection of proto files to be compiled.

Parameters:

protoFiles - a collection of source protobuf definition files.

Returns:

this builder instance.

See Also:

addProtoFile(File)

addProtoPathElement

public Protoc.Builder addProtoPathElement(File protopathElement)

Adds the protopathElement to the protopath.

Parameters:

protopathElement - A directory to be searched for imported protocol buffer definitions.

Returns:

The builder.

addProtoPathElements

public Protoc.Builder addProtoPathElements(Iterable<File> protopathElements)

Adds a number of elements to the protopath.

Parameters:

protopathElements - directories to be searched for imported protocol buffer definitions.

Returns:

this builder instance.

See Also:

addProtoPathElement(File)

build

public Protoc build()

Builds and returns a fully configured instance of Protoc wrapper.

Returns:

a configured Protoc instance.