Package org.xolstice.maven.plugin.protobuf

Class AbstractProtocCompileMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

org.xolstice.maven.plugin.protobuf.AbstractProtocCompileMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

ProtocCompileCppMojo, ProtocCompileCsharpMojo, ProtocCompileCustomMojo, ProtocCompileJavaNanoMojo, ProtocCompileJavaScriptMojo, ProtocCompileMojo, ProtocCompilePythonMojo

public abstract class AbstractProtocCompileMojo
extends AbstractProtocMojo

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

Since:

0.3.3

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	descriptorSetClassifier	If generated descriptor set is to be attached to the build, specifies an optional classifier.
private java.io.File	descriptorSetOutputDirectory	This is the directory into which the (optional) descriptor set file will be created.
private java.io.File	protoSourceRoot	The source directories containing the .proto definitions to be compiled.

Fields inherited from class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

attachDescriptorSet, attachProtoSources, buildContext, descriptorSetFileName, includeDependenciesInDescriptorSet, includeSourceInfoInDescriptorSet, project, projectHelper, session, toolchainManager, useArgumentFile, writeDescriptorSet

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractProtocCompileMojo()

Method Summary

Modifier and Type	Method	Description
protected void	doAttachGeneratedFiles()
protected void	doAttachProtoSources()
protected java.util.List<org.apache.maven.artifact.Artifact>	getDependencyArtifacts()
protected java.io.File	getDescriptorSetOutputDirectory()	Returns output directory for descriptor set file.
protected java.io.File	getProtoSourceRoot()

Methods inherited from class org.xolstice.maven.plugin.protobuf.AbstractProtocMojo

addProtocBuilderParameters, checkFilesUpToDate, checkParameters, createDependencyArtifact, createDependencyArtifact, createProtocPlugins, detectJavaHome, doAttachFiles, execute, findGeneratedFilesInDirectory, findProtoFilesInDirectories, findProtoFilesInDirectory, getDependencyArtifactFiles, getExcludes, getIncludes, getOutputDirectory, hasDelta, lastModified, makeProtoPathFromJars, resolveBinaryArtifact, skipMojo, toHexString, truncatePath

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

protoSourceRoot

@Parameter(required=true,
           defaultValue="${basedir}/src/main/proto")
private java.io.File protoSourceRoot

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

descriptorSetOutputDirectory

@Parameter(required=true,
           defaultValue="${project.build.directory}/generated-resources/protobuf/descriptor-sets")
private java.io.File descriptorSetOutputDirectory

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

Since:

0.3.0

descriptorSetClassifier

@Parameter(required=false)
protected java.lang.String descriptorSetClassifier

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

Since:

0.4.1

Constructor Detail

AbstractProtocCompileMojo

public AbstractProtocCompileMojo()

Method Detail

doAttachProtoSources

protected void doAttachProtoSources()

Specified by:

doAttachProtoSources in class AbstractProtocMojo

doAttachGeneratedFiles

protected void doAttachGeneratedFiles()

Specified by:

doAttachGeneratedFiles in class AbstractProtocMojo

getDependencyArtifacts

protected java.util.List<org.apache.maven.artifact.Artifact> getDependencyArtifacts()

Specified by:

getDependencyArtifacts in class AbstractProtocMojo

getDescriptorSetOutputDirectory

protected java.io.File getDescriptorSetOutputDirectory()

Description copied from class: AbstractProtocMojo

Returns output directory for descriptor set file. Depends on build phase so must be defined in concrete implementation.

Specified by:

getDescriptorSetOutputDirectory in class AbstractProtocMojo

Returns:

output directory for generated descriptor set.

getProtoSourceRoot

protected java.io.File getProtoSourceRoot()

Specified by:

getProtoSourceRoot in class AbstractProtocMojo