Class ProtocCompileMojo
- java.lang.Object
-
- org.apache.maven.plugin.AbstractMojo
-
- org.xolstice.maven.plugin.protobuf.AbstractProtocMojo
-
- org.xolstice.maven.plugin.protobuf.AbstractProtocCompileMojo
-
- org.xolstice.maven.plugin.protobuf.ProtocCompileMojo
-
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
@Mojo(name="compile", defaultPhase=GENERATE_SOURCES, requiresDependencyResolution=COMPILE, threadSafe=true) public final class ProtocCompileMojo extends AbstractProtocCompileMojo
This mojo executes theprotoc
compiler for generating main Java sources from protocol buffer definitions. It also searches dependency artifacts for.proto
files and includes them in theproto_path
so that they can be referenced. Finally, it adds the.proto
files to the project as resources so that they are included in the final artifact.
-
-
Field Summary
Fields Modifier and Type Field Description private java.io.File
outputDirectory
This is the directory into which the.java
will be created.-
Fields inherited from class org.xolstice.maven.plugin.protobuf.AbstractProtocCompileMojo
descriptorSetClassifier
-
Fields inherited from class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo
attachDescriptorSet, attachProtoSources, buildContext, descriptorSetFileName, includeDependenciesInDescriptorSet, includeSourceInfoInDescriptorSet, project, projectHelper, session, toolchainManager, useArgumentFile, writeDescriptorSet
-
-
Constructor Summary
Constructors Constructor Description ProtocCompileMojo()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addProtocBuilderParameters(Protoc.Builder protocBuilder)
Adds mojo-specific parameters to the protoc builder.protected java.io.File
getOutputDirectory()
Returns the output directory for generated sources.-
Methods inherited from class org.xolstice.maven.plugin.protobuf.AbstractProtocCompileMojo
doAttachGeneratedFiles, doAttachProtoSources, getDependencyArtifacts, getDescriptorSetOutputDirectory, getProtoSourceRoot
-
Methods inherited from class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo
checkFilesUpToDate, checkParameters, createDependencyArtifact, createDependencyArtifact, createProtocPlugins, detectJavaHome, doAttachFiles, execute, findGeneratedFilesInDirectory, findProtoFilesInDirectories, findProtoFilesInDirectory, getDependencyArtifactFiles, getExcludes, getIncludes, hasDelta, lastModified, makeProtoPathFromJars, resolveBinaryArtifact, skipMojo, toHexString, truncatePath
-
-
-
-
Method Detail
-
addProtocBuilderParameters
protected void addProtocBuilderParameters(Protoc.Builder protocBuilder)
Description copied from class:AbstractProtocMojo
Adds mojo-specific parameters to the protoc builder.- Overrides:
addProtocBuilderParameters
in classAbstractProtocMojo
- Parameters:
protocBuilder
- the builder to be modified.
-
getOutputDirectory
protected java.io.File getOutputDirectory()
Description copied from class:AbstractProtocMojo
Returns the output directory for generated sources. Depends on build phase so must be defined in concrete implementation.- Specified by:
getOutputDirectory
in classAbstractProtocMojo
- Returns:
- output directory for generated sources.
-
-