Index

A B C D E F G H I J K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractProtocCompileMojo - Class in org.xolstice.maven.plugin.protobuf

An abstract base mojo configuration for using protoc compiler with the main sources.

AbstractProtocCompileMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.AbstractProtocCompileMojo

AbstractProtocMojo - Class in org.xolstice.maven.plugin.protobuf

Abstract Mojo implementation.

AbstractProtocMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

AbstractProtocTestCompileMojo - Class in org.xolstice.maven.plugin.protobuf

An abstract base mojo configuration for using protoc compiler with the test sources.

AbstractProtocTestCompileMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.AbstractProtocTestCompileMojo

additionalProtoPathElements - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Additional source paths for .proto definitions.

addPlugin(ProtocPlugin) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

Adds a protoc plugin definition for custom code generation.

addProtocBuilderParameters(Protoc.Builder) - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Adds mojo-specific parameters to the protoc builder.

addProtocBuilderParameters(Protoc.Builder) - Method in class org.xolstice.maven.plugin.protobuf.ProtocCompileCppMojo

addProtocBuilderParameters(Protoc.Builder) - Method in class org.xolstice.maven.plugin.protobuf.ProtocCompileCsharpMojo

addProtocBuilderParameters(Protoc.Builder) - Method in class org.xolstice.maven.plugin.protobuf.ProtocCompileCustomMojo

addProtocBuilderParameters(Protoc.Builder) - Method in class org.xolstice.maven.plugin.protobuf.ProtocCompileJavaNanoMojo

Deprecated.

addProtocBuilderParameters(Protoc.Builder) - Method in class org.xolstice.maven.plugin.protobuf.ProtocCompileJavaScriptMojo

addProtocBuilderParameters(Protoc.Builder) - Method in class org.xolstice.maven.plugin.protobuf.ProtocCompileMojo

addProtocBuilderParameters(Protoc.Builder) - Method in class org.xolstice.maven.plugin.protobuf.ProtocCompilePythonMojo

addProtocBuilderParameters(Protoc.Builder) - Method in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCppMojo

addProtocBuilderParameters(Protoc.Builder) - Method in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCsharpMojo

addProtocBuilderParameters(Protoc.Builder) - Method in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCustomMojo

addProtocBuilderParameters(Protoc.Builder) - Method in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileJavaNanoMojo

Deprecated.

addProtocBuilderParameters(Protoc.Builder) - Method in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileJavaScriptMojo

addProtocBuilderParameters(Protoc.Builder) - Method in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileMojo

addProtocBuilderParameters(Protoc.Builder) - Method in class org.xolstice.maven.plugin.protobuf.ProtocTestCompilePythonMojo

addProtoFile(File) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

Adds a proto file to be compiled.

addProtoFiles(Iterable) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

Adds a collection of proto files to be compiled.

addProtoPathElement(File) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

Adds the protopathElement to the protopath.

addProtoPathElements(Iterable) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

Adds a number of elements to the protopath.

append(StringBuilder, String, int) - Method in class org.xolstice.maven.plugin.protobuf.HelpMojo

Append a description to the buffer by respecting the indentSize and lineLength parameters.

archDirectoryExists(String) - Method in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

args - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

artifactFactory - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

A factory for Maven artifact definitions.

artifactFactory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

artifactId - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

artifactResolver - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

A component that implements resolution of Maven artifacts from repositories.

attachDescriptorSet - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

If set to true, the generated descriptor set will be attached to the build.

attachProtoSources - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

If set to true, then the specified protobuf source files from this project will be attached as resources to the build, for subsequent inclusion into the final artifact.

B

build() - Method in class org.xolstice.maven.plugin.protobuf.HelpMojo

build() - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

Builds and returns a fully configured instance of Protoc wrapper.

buildContext - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Build context that tracks changes to the source and target files.

Builder(String) - Constructor for class org.xolstice.maven.plugin.protobuf.Protoc.Builder

Constructs a new builder.

buildProtocCommand() - Method in class org.xolstice.maven.plugin.protobuf.Protoc

Creates the command line arguments.

buildUnixPlugin() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

buildWindowsPlugin() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

C

checkFilesUpToDate(Iterable, Iterable) - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Checks that the source files don't have modification time that is later than the target files.

checkParameters() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

checkProtoFileIsInProtopath(File) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

checkProtoFileIsInProtopathHelper(File) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

checkStaleness - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Normally protoc is invoked on every execution of the plugin.

classifier - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

clearOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

When true, the output directory will be cleared out prior to code generation.

copyWinRun4JExecutable() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

cppOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

A directory into which C++ source files will be generated.

cppOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

A directory into which C++ source files will be generated.

createDefaultToolchain() - Method in class org.xolstice.maven.toolchain.protobuf.DefaultProtobufToolchainFactory

createDependencyArtifact(String) - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Creates a dependency artifact from a specification in groupId:artifactId:version[:type[:classifier]] format.

createDependencyArtifact(String, String, String, String, String) - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

createFileWithArguments(String[]) - Method in class org.xolstice.maven.plugin.protobuf.Protoc

Put args into a temp file to be referenced using the @ option in protoc command line.

createPluginDirectory() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

createProtocPlugins() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Generates native launchers for java protoc plugins.

createToolchain(ToolchainModel) - Method in class org.xolstice.maven.toolchain.protobuf.DefaultProtobufToolchainFactory

csharpOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

A directory into which C# source files will be generated.

csharpOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

A directory into which C# source files will be generated.

customOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

A directory into which a custom protoc plugin will generate files.

customOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

A directory into which a custom protoc plugin will generate files.

D

DATA_MODEL_SYSPROP - Static variable in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

DEFAULT_INCLUDES - Static variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

DEFAULT_LINE_LENGTH - Static variable in class org.xolstice.maven.plugin.protobuf.HelpMojo

DefaultProtobufToolchain - Class in org.xolstice.maven.toolchain.protobuf

Based on org.apache.maven.toolchain.java.DefaultJavaToolChain.

DefaultProtobufToolchain(ToolchainModel, Logger) - Constructor for class org.xolstice.maven.toolchain.protobuf.DefaultProtobufToolchain

DefaultProtobufToolchainFactory - Class in org.xolstice.maven.toolchain.protobuf

Based on org.apache.maven.toolchain.java.DefaultJavaToolchainFactory.

DefaultProtobufToolchainFactory() - Constructor for class org.xolstice.maven.toolchain.protobuf.DefaultProtobufToolchainFactory

descriptorSetClassifier - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocCompileMojo

If generated descriptor set is to be attached to the build, specifies an optional classifier.

descriptorSetClassifier - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocTestCompileMojo

If generated descriptor set is to be attached to the build, specifies an optional classifier.

descriptorSetFile - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

descriptorSetFile - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

descriptorSetFileName - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

The descriptor set file name.

descriptorSetOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocCompileMojo

This is the directory into which the (optional) descriptor set file will be created.

descriptorSetOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocTestCompileMojo

This is the directory into which the (optional) descriptor set file will be created.

detail - Variable in class org.xolstice.maven.plugin.protobuf.HelpMojo

If true, display all settable properties for each goal.

detectJavaHome() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Attempts to detect java home directory, using jdk toolchain if available, with a fallback to java.home system property.

doAttachFiles() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

doAttachGeneratedFiles() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocCompileMojo

doAttachGeneratedFiles() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

doAttachGeneratedFiles() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocTestCompileMojo

doAttachProtoSources() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocCompileMojo

doAttachProtoSources() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

doAttachProtoSources() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocTestCompileMojo

E

error - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

A buffer to consume error output from the protoc executable.

excludes - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

A list of <exclude> elements specifying the protobuf definition files (by pattern) that should be excluded from compilation.

executable - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

Path to the protoc executable.

executable - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

Path to the protoc executable.

execute() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Executes the mojo.

execute() - Method in class org.xolstice.maven.plugin.protobuf.HelpMojo

execute() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

Resolves the plugin's dependencies to the local Maven repository and builds the plugin executable.

execute(Log) - Method in class org.xolstice.maven.plugin.protobuf.Protoc

Invokes the protoc compiler using the configuration specified at construction.

F

findGeneratedFilesInDirectory(File) - Static method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

findJvmLocation(File, String...) - Static method in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

findNamedChild(Node, String) - Static method in class org.xolstice.maven.plugin.protobuf.HelpMojo

findProtoFilesInDirectories(Iterable) - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

findProtoFilesInDirectory(File) - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

findSingleChild(Node, String) - Static method in class org.xolstice.maven.plugin.protobuf.HelpMojo

findTool(String) - Method in class org.xolstice.maven.toolchain.protobuf.DefaultProtobufToolchain

fixUnicodeOutput(String) - Static method in class org.xolstice.maven.plugin.protobuf.Protoc

Transcodes the output from system default charset to UTF-8.

forceMojoExecution - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Usually most of protobuf mojos will not get executed on parent poms (i.e.

G

getArgs() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

Returns optional command line arguments to pass to the main() method.

getArtifactId() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

Returns the plugin's artifact id for dependency resolution.

getBeanProperty(Object, String) - Static method in class org.xolstice.maven.toolchain.protobuf.DefaultProtobufToolchainFactory

getClassifier() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

Returns an optional classifier of the plugin's artifact for dependency resolution.

getDependencyArtifactFiles() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Gets the File for each dependency artifact.

getDependencyArtifacts() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocCompileMojo

getDependencyArtifacts() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

getDependencyArtifacts() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocTestCompileMojo

getDescriptorSetOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocCompileMojo

getDescriptorSetOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Returns output directory for descriptor set file.

getDescriptorSetOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocTestCompileMojo

getError() - Method in class org.xolstice.maven.plugin.protobuf.Protoc

getExcludes() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

getGroupId() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

Returns group id of the plugin's artifact for dependency resolution.

getId() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

Returns the unique id for this plugin.

getIncludes() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

getIndentLevel(String) - Static method in class org.xolstice.maven.plugin.protobuf.HelpMojo

Gets the indentation level of the specified line.

getJavaHome() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

getJvmArgs() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

Returns optional JVM options for plugin execution.

getMainClass() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

Returns the plugin's Java main class to be execute by protoc.

getOutput() - Method in class org.xolstice.maven.plugin.protobuf.Protoc

getOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Returns the output directory for generated sources.

getOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.ProtocCompileCppMojo

getOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.ProtocCompileCsharpMojo

getOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.ProtocCompileCustomMojo

getOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.ProtocCompileJavaNanoMojo

Deprecated.

getOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.ProtocCompileJavaScriptMojo

getOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.ProtocCompileMojo

getOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.ProtocCompilePythonMojo

getOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCppMojo

getOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCsharpMojo

getOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCustomMojo

getOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileJavaNanoMojo

Deprecated.

getOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileJavaScriptMojo

getOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileMojo

getOutputDirectory() - Method in class org.xolstice.maven.plugin.protobuf.ProtocTestCompilePythonMojo

getPluginExecutableFile(File) - Method in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

Returns the generated plugin executable path.

getPluginName() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

getPropertyFromExpression(String) - Static method in class org.xolstice.maven.plugin.protobuf.HelpMojo

getProtocExecutable() - Method in class org.xolstice.maven.toolchain.protobuf.DefaultProtobufToolchain

getProtocExecutable() - Method in interface org.xolstice.maven.toolchain.protobuf.ProtobufToolchain

getProtoSourceRoot() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocCompileMojo

getProtoSourceRoot() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

getProtoSourceRoot() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocTestCompileMojo

getProvidesProperties(ToolchainModel) - Static method in class org.xolstice.maven.toolchain.protobuf.DefaultProtobufToolchainFactory

Get provides properties in in a way compatible with toolchains descriptor version 1.0 (Maven 2.0.9 to 3.2.3, where it is represented as Object/DOM) and descriptor version 1.1 (Maven 3.2.4 and later, where it is represented as Properties).

getSingleChild(Node, String) - Static method in class org.xolstice.maven.plugin.protobuf.HelpMojo

getValue(Node, String) - Static method in class org.xolstice.maven.plugin.protobuf.HelpMojo

getVersion() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

Returns the plugin's version specification for dependency resolution.

getWinJvmDataModel() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

getWinrun4jExecutablePath() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

goal - Variable in class org.xolstice.maven.plugin.protobuf.HelpMojo

The name of the goal for which to show help.

groupId - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

H

hasDelta(Iterable) - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Checks if the injected build context has changes in any of the specified files.

hashDependentPaths - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Set this to false to disable hashing of dependent jar paths.

HelpMojo - Class in org.xolstice.maven.plugin.protobuf

Display help information on protobuf-maven-plugin.
Call mvn protobuf:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.

HelpMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.HelpMojo

HEX_CHARS - Static variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

I

id - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

includeDependenciesInDescriptorSet - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

If true and writeDescriptorSet has been set, the compiler will include all dependencies in the descriptor set making it "self-contained".

includeImportsInDescriptorSet - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

includeImportsInDescriptorSet - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

includes - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

A list of <include> elements specifying the protobuf definition files (by pattern) that should be included in compilation.

includeSourceInfoInDescriptorSet - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

If true and writeDescriptorSet has been set, do not strip SourceCodeInfo from the FileDescriptorProto.

includeSourceInfoInDescriptorSet - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

includeSourceInfoInDescriptorSet - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

indentSize - Variable in class org.xolstice.maven.plugin.protobuf.HelpMojo

The number of spaces per indentation level, should be positive.

isNotEmpty(String) - Static method in class org.xolstice.maven.plugin.protobuf.HelpMojo

J

javaHome - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

javaNanoOptions - Variable in class org.xolstice.maven.plugin.protobuf.ProtocCompileJavaNanoMojo

Deprecated.

Additional comma-separated options to be passed to the JavaNano generator.

javaNanoOptions - Variable in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileJavaNanoMojo

Deprecated.

Additional comma-separated options to be passed to the JavaNano generator.

javaNanoOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

A directory into which Java Nano source files will be generated.

javaNanoOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

A directory into which JavaNano source files will be generated.

javaOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

A directory into which Java source files will be generated.

javaOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

A directory into which Java source files will be generated.

javaScriptOptions - Variable in class org.xolstice.maven.plugin.protobuf.ProtocCompileJavaScriptMojo

Additional comma-separated options to be passed to the JavaScript generator.

javaScriptOptions - Variable in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileJavaScriptMojo

Additional comma-separated options to be passed to the JavaScript generator.

javaScriptOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

A directory into which JavaScript source files will be generated.

javaScriptOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

A directory into which JavaScript source files will be generated.

jvmArgs - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

K

KEY_PROTOC_EXECUTABLE - Static variable in class org.xolstice.maven.toolchain.protobuf.DefaultProtobufToolchain

L

lastModified(Iterable) - Static method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Returns timestamp for the most recently modified file in the given set.

lineLength - Variable in class org.xolstice.maven.plugin.protobuf.HelpMojo

The maximum length of a display line, should be positive.

localRepository - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

This is the path to the local maven repository.

localRepository - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

log - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

LOG_PREFIX - Static variable in class org.xolstice.maven.plugin.protobuf.Protoc

Prefix for logging the debug messages.

logExecutionParameters(Log) - Method in class org.xolstice.maven.plugin.protobuf.Protoc

Logs execution parameters on debug level to the specified logger.

logger - Variable in class org.xolstice.maven.toolchain.protobuf.DefaultProtobufToolchainFactory

M

mainClass - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

makeProtoPathFromJars(File, Iterable) - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Unpacks proto descriptors that are bundled inside dependent artifacts into a temporary directory.

md5Hash(String) - Static method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

MojoConfigurationException - Exception Class in org.xolstice.maven.plugin.protobuf

An exception to indicate that plugin configuration was incorrect.

MojoConfigurationException(String) - Constructor for exception class org.xolstice.maven.plugin.protobuf.MojoConfigurationException

MojoConfigurationException(String, Throwable) - Constructor for exception class org.xolstice.maven.plugin.protobuf.MojoConfigurationException

MojoInitializationException - Exception Class in org.xolstice.maven.plugin.protobuf

An exception to indicate that plugin initialization has failed.

MojoInitializationException(String) - Constructor for exception class org.xolstice.maven.plugin.protobuf.MojoInitializationException

MojoInitializationException(String, Throwable) - Constructor for exception class org.xolstice.maven.plugin.protobuf.MojoInitializationException

N

nativePluginExecutable - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

nativePluginExecutable - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

nativePluginId - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

nativePluginId - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

nativePluginParameter - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

nativePluginParameter - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

O

org.xolstice.maven.plugin.protobuf - package org.xolstice.maven.plugin.protobuf

org.xolstice.maven.toolchain.protobuf - package org.xolstice.maven.toolchain.protobuf

output - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

A buffer to consume standard output from the protoc executable.

outputBaseDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocCompileCustomMojo

This is the base directory for the generated code.

outputBaseDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCustomMojo

This is the base directory for the generated code.

outputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocCompileCppMojo

This is the directory into which the .cpp will be created.

outputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocCompileCsharpMojo

This is the directory into which the .cs will be created.

outputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocCompileCustomMojo

This is the directory where the generated code will be placed.

outputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocCompileJavaNanoMojo

Deprecated.

This is the directory into which the .java will be created.

outputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocCompileJavaScriptMojo

This is the directory into which the .js will be created.

outputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocCompileMojo

This is the directory into which the .java will be created.

outputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocCompilePythonMojo

This is the directory into which the .py will be created.

outputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCppMojo

This is the directory into which the .cpp test sources will be created.

outputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCsharpMojo

This is the directory into which the .cs test sources will be created.

outputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCustomMojo

This is the directory where the generated code will be placed.

outputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileJavaNanoMojo

Deprecated.

This is the directory into which the .java test sources will be created.

outputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileJavaScriptMojo

This is the directory into which the .js test sources will be created.

outputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileMojo

This is the directory into which the .java test sources will be created.

outputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocTestCompilePythonMojo

This is the directory into which the .py test sources will be created.

P

PLUGIN_HELP_PATH - Static variable in class org.xolstice.maven.plugin.protobuf.HelpMojo

pluginArtifact - Variable in class org.xolstice.maven.plugin.protobuf.ProtocCompileCustomMojo

Plugin artifact specification, in groupId:artifactId:version[:type[:classifier]] format.

pluginArtifact - Variable in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCustomMojo

Plugin artifact specification, in groupId:artifactId:version[:type[:classifier]] format.

pluginDefinition - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

pluginDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

pluginDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

pluginDirectory - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

pluginExecutable - Variable in class org.xolstice.maven.plugin.protobuf.ProtocCompileCustomMojo

An optional path to plugin executable.

pluginExecutable - Variable in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCustomMojo

An optional path to plugin executable.

pluginExecutableFile - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

pluginId - Variable in class org.xolstice.maven.plugin.protobuf.ProtocCompileCustomMojo

A unique id that identifies the plugin to protoc.

pluginId - Variable in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCustomMojo

A unique id that identifies the plugin to protoc.

pluginParameter - Variable in class org.xolstice.maven.plugin.protobuf.ProtocCompileCustomMojo

An optional parameter to be passed to the plugin.

pluginParameter - Variable in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCustomMojo

An optional parameter to be passed to the plugin.

plugins - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

plugins - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

pluginTool - Variable in class org.xolstice.maven.plugin.protobuf.ProtocCompileCustomMojo

If ProtocCompileCustomMojo.pluginToolchain is specified, this parameter specifies the tool in the toolchain, which is to be resolved as plugin executable.

pluginTool - Variable in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCustomMojo

If ProtocTestCompileCustomMojo.pluginToolchain is specified, this parameter specifies the tool in the toolchain, which is to be resolved as plugin executable.

pluginToolchain - Variable in class org.xolstice.maven.plugin.protobuf.ProtocCompileCustomMojo

A name of an optional custom toolchain that can be used to locate the plugin executable.

pluginToolchain - Variable in class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCustomMojo

A name of an optional custom toolchain that can be used to locate the plugin executable.

project - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

The current Maven project.

projectHelper - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

A helper used to add resources to the project.

PROTO_FILE_SUFFIX - Static variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

ProtobufToolchain - Interface in org.xolstice.maven.toolchain.protobuf

A tool chain for protobuf compiler (protoc).

Protoc - Class in org.xolstice.maven.plugin.protobuf

This class represents an invokable configuration of the protoc compiler.

Protoc(String, List, List, File, File, File, File, File, File, File, File, boolean, boolean, List, File, String, String, String, File, boolean) - Constructor for class org.xolstice.maven.plugin.protobuf.Protoc

Constructs a new instance.

Protoc.Builder - Class in org.xolstice.maven.plugin.protobuf

This class builds Protoc instances.

protocArtifact - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Protobuf compiler artifact specification, in groupId:artifactId:version[:type[:classifier]] format.

ProtocCompileCppMojo - Class in org.xolstice.maven.plugin.protobuf

This mojo executes the protoc compiler for generating main C++ sources from protocol buffer definitions.

ProtocCompileCppMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.ProtocCompileCppMojo

ProtocCompileCsharpMojo - Class in org.xolstice.maven.plugin.protobuf

This mojo executes the protoc compiler for generating main C# sources from protocol buffer definitions.

ProtocCompileCsharpMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.ProtocCompileCsharpMojo

ProtocCompileCustomMojo - Class in org.xolstice.maven.plugin.protobuf

This mojo executes the protoc compiler with the specified plugin executable to generate main sources from protocol buffer definitions.

ProtocCompileCustomMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.ProtocCompileCustomMojo

ProtocCompileJavaNanoMojo - Class in org.xolstice.maven.plugin.protobuf

Deprecated.

JavaNano has been deprecated in favour of Java Lite. Please see Protocol Buffers documentation for details.

ProtocCompileJavaNanoMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.ProtocCompileJavaNanoMojo

Deprecated.

ProtocCompileJavaScriptMojo - Class in org.xolstice.maven.plugin.protobuf

This mojo executes the protoc compiler for generating main JavaScript sources from protocol buffer definitions.

ProtocCompileJavaScriptMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.ProtocCompileJavaScriptMojo

ProtocCompileMojo - Class in org.xolstice.maven.plugin.protobuf

This mojo executes the protoc compiler for generating main Java sources from protocol buffer definitions.

ProtocCompileMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.ProtocCompileMojo

ProtocCompilePythonMojo - Class in org.xolstice.maven.plugin.protobuf

This mojo executes the protoc compiler for generating main python sources from protocol buffer definitions.

ProtocCompilePythonMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.ProtocCompilePythonMojo

protocExecutable - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

This is the path to the protoc executable.

protocExecutable - Variable in class org.xolstice.maven.toolchain.protobuf.DefaultProtobufToolchain

ProtocPlugin - Class in org.xolstice.maven.plugin.protobuf

Describes a protoc plugin that is written in Java and assembled from resolved artifacts at runtime.

ProtocPlugin() - Constructor for class org.xolstice.maven.plugin.protobuf.ProtocPlugin

ProtocPluginAssembler - Class in org.xolstice.maven.plugin.protobuf

Creates an executable protoc plugin (written in Java) from a ProtocPlugin specification.

ProtocPluginAssembler(ProtocPlugin, MavenSession, Artifact, ArtifactFactory, RepositorySystem, ResolutionErrorHandler, ArtifactRepository, List, File, Log) - Constructor for class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

protocPluginDirectory - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

A directory where native launchers for java protoc plugins will be generated.

protocPlugins - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Specifies one of more custom protoc plugins, written in Java and available as Maven artifacts.

ProtocTestCompileCppMojo - Class in org.xolstice.maven.plugin.protobuf

This mojo executes the protoc compiler for generating test C++ sources from protocol buffer definitions.

ProtocTestCompileCppMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCppMojo

ProtocTestCompileCsharpMojo - Class in org.xolstice.maven.plugin.protobuf

This mojo executes the protoc compiler for generating test C# sources from protocol buffer definitions.

ProtocTestCompileCsharpMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCsharpMojo

ProtocTestCompileCustomMojo - Class in org.xolstice.maven.plugin.protobuf

This mojo executes the protoc compiler with the specified plugin executable to generate test sources from protocol buffer definitions.

ProtocTestCompileCustomMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.ProtocTestCompileCustomMojo

ProtocTestCompileJavaNanoMojo - Class in org.xolstice.maven.plugin.protobuf

Deprecated.

JavaNano has been deprecated in favour of Java Lite. Please see Protocol Buffers documentation for details.

ProtocTestCompileJavaNanoMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.ProtocTestCompileJavaNanoMojo

Deprecated.

ProtocTestCompileJavaScriptMojo - Class in org.xolstice.maven.plugin.protobuf

This mojo executes the protoc compiler for generating test JavaScript sources from protocol buffer definitions.

ProtocTestCompileJavaScriptMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.ProtocTestCompileJavaScriptMojo

ProtocTestCompileMojo - Class in org.xolstice.maven.plugin.protobuf

This mojo executes the protoc compiler for generating test Java sources from protocol buffer definitions.

ProtocTestCompileMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.ProtocTestCompileMojo

ProtocTestCompilePythonMojo - Class in org.xolstice.maven.plugin.protobuf

This mojo executes the protoc compiler for generating test python sources from protocol buffer definitions.

ProtocTestCompilePythonMojo() - Constructor for class org.xolstice.maven.plugin.protobuf.ProtocTestCompilePythonMojo

protoFiles - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

protoFiles - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

A set of protobuf definitions to process.

protopathElements - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

protoPathElements - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

A set of directories in which to search for definition imports.

protoSourceRoot - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocCompileMojo

The source directories containing the .proto definitions to be compiled.

protoTestSourceRoot - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocTestCompileMojo

The source directories containing the test .proto definitions to be compiled.

pythonOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

A directory into which Python source files will be generated.

pythonOutputDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

A directory into which Python source files will be generated.

R

remoteRepositories - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Remote repositories for artifact resolution.

remoteRepositories - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

repeat(String, int) - Static method in class org.xolstice.maven.plugin.protobuf.HelpMojo

Repeat a String n times to form a new string.

repositorySystem - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

A component that handles resolution of Maven artifacts.

repositorySystem - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

resolutionErrorHandler - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

A component that handles resolution errors.

resolutionErrorHandler - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

resolveBinaryArtifact(Artifact) - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

resolvedJars - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

resolvePluginDependencies() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

rootResolutionArtifact - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

S

session - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

The current Maven Session Object.

session - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPluginAssembler

setCppOutputDirectory(File) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

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

setCsharpOutputDirectory(File) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

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

setCustomOutputDirectory(File) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

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

setJavaHome(String) - Method in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

setJavaNanoOutputDirectory(File) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

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

setJavaOutputDirectory(File) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

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

setJavaScriptOutputDirectory(File) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

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

setNativePluginExecutable(String) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

setNativePluginId(String) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

setNativePluginParameter(String) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

setPluginDirectory(File) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

setProtocExecutable(String) - Method in class org.xolstice.maven.toolchain.protobuf.DefaultProtobufToolchain

setProtocExecutable(String) - Method in interface org.xolstice.maven.toolchain.protobuf.ProtobufToolchain

setPythonOutputDirectory(File) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

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

setTempDirectory(File) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

skip - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

When true, skip the execution.

skipMojo() - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Determine if the mojo execution should get skipped.

staleMillis - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Sets the granularity in milliseconds of the last modification date for testing whether source protobuf definitions need recompilation.

T

tempDirectory - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

A directory where temporary files will be generated.

tempDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

tempDirectory - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

A directory where temporary files will be generated.

temporaryProtoFileDirectory - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Since protoc cannot access jars, proto files in dependencies are extracted to this location and deleted on exit.

toHexString(byte[]) - Static method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

toLines(String, int, int, int) - Static method in class org.xolstice.maven.plugin.protobuf.HelpMojo

Splits the specified text into lines of convenient display length.

toLines(List, String, int, int) - Static method in class org.xolstice.maven.plugin.protobuf.HelpMojo

Adds the specified line to the output sequence, performing line wrapping if necessary.

toolchainManager - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

An optional tool chain manager.

toProperties(Xpp3Dom) - Static method in class org.xolstice.maven.toolchain.protobuf.DefaultProtobufToolchainFactory

toString() - Method in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

toString() - Method in class org.xolstice.maven.toolchain.protobuf.DefaultProtobufToolchain

truncatePath(String) - Method in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

Truncates the path of jar files so that they are relative to the local repository.

U

useArgumentFile - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

If set to true, all command line arguments to protoc will be written to a file, and only a path to that file will be passed to protoc on the command line.

useArgumentFile - Variable in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

useArgumentFile - Variable in class org.xolstice.maven.plugin.protobuf.Protoc

A boolean indicating if the parameters to protoc should be passed in an argument file.

useArgumentFile(boolean) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

V

validate(Log) - Method in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

Validate the state of this plugin specification.

validateState() - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

Validates the internal state for consistency and completeness.

version - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

W

WIN_JVM_DATA_MODEL_32 - Static variable in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

WIN_JVM_DATA_MODEL_64 - Static variable in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

winJvmDataModel - Variable in class org.xolstice.maven.plugin.protobuf.ProtocPlugin

withDescriptorSetFile(File, boolean, boolean) - Method in class org.xolstice.maven.plugin.protobuf.Protoc.Builder

writeDescriptorSet - Variable in class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

If set to true, the compiler will generate a binary descriptor set file for the specified .proto files.

writeGoal(StringBuilder, String, Element) - Method in class org.xolstice.maven.plugin.protobuf.HelpMojo

writeParameter(StringBuilder, Node, Node) - Method in class org.xolstice.maven.plugin.protobuf.HelpMojo

A B C D E F G H I J K L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form