protobuf:run

Full name:

com.github.igor-petruk.protobuf:protobuf-maven-plugin:0.6.4-SNAPSHOT:run

Description:

(no description)

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Binds by default to the lifecycle phase: generate-sources.

Required Parameters

Name Type Since Description
addSources String - Specifies a mode for plugin whether it should add outputDirectory to sources that are going to be compiled Can be "main", "test" or "none"
Default value is: main.
cleanOutputFolder boolean - If this parameter is set to "true" output folder is cleaned prior to build. This will not let old and new classes coexist after package or class rename in your IDE cache or after non-clean rebuild. Set this to "false" if you are doing multiple plugin invocations per build and it is important to preserve output folder contents
Default value is: true.
extension String - Default extension for protobuf files
Default value is: .proto.
ignoreVersions boolean - Setting to "true" disables version check between 'protoc' and the protobuf library used by module
Default value is: false.

Optional Parameters

Name Type Since Description
includeDirectories File[] - This parameter lets you specify additional include paths to protoc.
inputDirectories File[] - Input directories that have *.protoc files (or the configured extension). If none specified then src/main/protobuf is used.
outputDirectory File - Output directory, that generated java files would be stored Defaults to "${project.build.directory}/generated-sources/protobuf" or "${project.build.directory}/generated-test-sources/protobuf" depending addSources parameter
protobufArtifactId String - This parameter allows to override protobuf library artifactId
Default value is: protobuf-java.
protobufGroupId String - This parameter allows to override protobuf library groupId
Default value is: com.google.protobuf.
protocCommand String - This parameter allows to override the protoc command that is going to be used.
Default value is: protoc.

Parameter Details

addSources:

Specifies a mode for plugin whether it should add outputDirectory to sources that are going to be compiled Can be "main", "test" or "none"
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${addSources}
  • Default: main

cleanOutputFolder:

If this parameter is set to "true" output folder is cleaned prior to build. This will not let old and new classes coexist after package or class rename in your IDE cache or after non-clean rebuild. Set this to "false" if you are doing multiple plugin invocations per build and it is important to preserve output folder contents
  • Type: boolean
  • Required: Yes
  • Expression: ${cleanOutputFolder}
  • Default: true

extension:

Default extension for protobuf files
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${extension}
  • Default: .proto

ignoreVersions:

Setting to "true" disables version check between 'protoc' and the protobuf library used by module
  • Type: boolean
  • Required: Yes
  • Expression: ${ignoreVersions}
  • Default: false

includeDirectories:

This parameter lets you specify additional include paths to protoc.
  • Type: java.io.File[]
  • Required: No
  • Expression: ${includeDirectories}

inputDirectories:

Input directories that have *.protoc files (or the configured extension). If none specified then src/main/protobuf is used.
  • Type: java.io.File[]
  • Required: No
  • Expression: ${inputDirectories}

outputDirectory:

Output directory, that generated java files would be stored Defaults to "${project.build.directory}/generated-sources/protobuf" or "${project.build.directory}/generated-test-sources/protobuf" depending addSources parameter
  • Type: java.io.File
  • Required: No
  • Expression: ${outputDirectory}

protobufArtifactId:

This parameter allows to override protobuf library artifactId
  • Type: java.lang.String
  • Required: No
  • Expression: ${protobufArtifactId}
  • Default: protobuf-java

protobufGroupId:

This parameter allows to override protobuf library groupId
  • Type: java.lang.String
  • Required: No
  • Expression: ${protobufGroupId}
  • Default: com.google.protobuf

protocCommand:

This parameter allows to override the protoc command that is going to be used.
  • Type: java.lang.String
  • Required: No
  • Expression: ${protocCommand}
  • Default: protoc