MAVEN PROCESSOR PLUGIN – processor:process

processor:process

Full name:

org.bsc.maven:maven-processor-plugin:5.1:process

Description:

(no description)

Attributes:

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

Required Parameters

Name	Type	Since	Description
`<defaultOutputDirectory>`	`File`	`-`	default output directory Default value is: `${project.build.directory}/generated-sources/apt`.
`<failOnError>`	`Boolean`	`-`	Indicates whether the build will continue even if there are compilation errors; defaults to true. Default value is: `true`. User property is: `annotation.failOnError`.
`<outputDiagnostics>`	`boolean`	`-`	Indicates whether the compiler output should be visible, defaults to true. Default value is: `true`. User property is: `annotation.outputDiagnostics`.
`<sourceDirectory>`	`File`	`-`	project sourceDirectory Default value is: `${project.build.sourceDirectory}`.

Optional Parameters

Name	Type	Since	Description
`<addCompileSourceRoots>`	`boolean`	`2.1.1`	if true add to the source directory of the annotation processor all compile source roots detected int the project This is useful when we plan to use build-helper-maven-plugin Default value is: `false`.
`<addOutputDirectoryToCompilationSources>`	`Boolean`	`-`	Controls whether or not the output directory is added to compilation
`<additionalSourceDirectories>`	`List`	`-`	additional source directories for the annotation processors.
`<annotationProcessorPaths>`	`List`	`5.0-rc2`
`<appendSourceArtifacts>`	`boolean`	`2.2.0`	append source artifacts to sources list Default value is: `false`.
`<compilerArguments>`	`String`	`-`	Additional compiler arguments
`<encoding>`	`String`	`2.2.1`	The character set used for decoding sources User property is: `project.build.sourceEncoding`.
`<excludes>`	`String[]`	`-`	excludes pattern
`<fork>`	`boolean`	`3.3`	Allows running the compiler in a separate process. If false it uses the built in compiler, while if true it will use an executable. to set source and target use maven.processor.source maven.processor.target Default value is: `false`. User property is: `fork`.
`<includes>`	`String[]`	`-`	includes pattern
`<optionMap>`	`Map`	`-`	Additional processor options (see javax.annotation.processing.ProcessingEnvironment#getOptions() Alias is: `options`.
`<outputClassDirectory>`	`File`	`-`	Set the destination directory for class files (same behaviour of -d option) Default value is: `${project.build.outputDirectory}`.
`<outputDirectory>`	`File`	`-`	Specify the directory where to place generated source files (same behaviour of -s option)
`<processSourceArtifacts>`	`List`	`2.2.5`	List of artifacts on which perform sources scanning Each artifact must be specified in the form grouId:artifactId. If you need to include all artifacts belonging a groupId, specify as artifactId the character '' e.g. org.bsc.maven:maven-confluence-plugin org.bsc.maven:
`<processors>`	`String[]`	`-`	Annotation Processor FQN (Full Qualified Name) - when processors are not specified, the default discovery mechanism will be used
`<releaseVersion>`	`String`	`3.3.3`	value of -release parameter in java 9+
`<skip>`	`boolean`	`3.1.0`	Set this to true to skip annotation processing. Default value is: `false`. User property is: `skipAnnotationProcessing`.
`<skipSourcesUnchanged>`	`boolean`	`4.3`	Set this to true to skip annotation processing when there are no changes in the source files compared to the generated files. Default value is: `false`. User property is: `skipSourcesUnchangedAnnotationProcessing`.
`<systemProperties>`	`Map`	`-`	System properties set before processor invocation.

Parameter Details

<addCompileSourceRoots>

if true add to the source directory of the annotation processor all compile source roots detected int the project This is useful when we plan to use build-helper-maven-plugin

Type: boolean
Since: 2.1.1
Required: No
Default: false

<addOutputDirectoryToCompilationSources>

Controls whether or not the output directory is added to compilation

Type: java.lang.Boolean
Required: No

<additionalSourceDirectories>

additional source directories for the annotation processors.

Type: java.util.List
Required: No

<annotationProcessorPaths>

Type: java.util.List
Since: 5.0-rc2
Required: No

<appendSourceArtifacts>

append source artifacts to sources list

Type: boolean
Since: 2.2.0
Required: No
Default: false

<compilerArguments>

Additional compiler arguments

Type: java.lang.String
Required: No

<defaultOutputDirectory>

default output directory

Type: java.io.File
Required: Yes
Default: ${project.build.directory}/generated-sources/apt

<encoding>

The character set used for decoding sources

Type: java.lang.String
Since: 2.2.1
Required: No
User Property: project.build.sourceEncoding

<excludes>

excludes pattern

Type: java.lang.String[]
Required: No

<failOnError>

Indicates whether the build will continue even if there are compilation errors; defaults to true.

Type: java.lang.Boolean
Required: Yes
User Property: annotation.failOnError
Default: true

Allows running the compiler in a separate process. If false it uses the built in compiler, while if true it will use an executable. to set source and target use maven.processor.source maven.processor.target

Type: boolean
Since: 3.3
Required: No
User Property: fork
Default: false

<includes>

includes pattern

Type: java.lang.String[]
Required: No

<optionMap>

Additional processor options (see javax.annotation.processing.ProcessingEnvironment#getOptions()

Type: java.util.Map
Required: No
Alias: options

<outputClassDirectory>

Set the destination directory for class files (same behaviour of -d option)

Type: java.io.File
Required: No
Default: ${project.build.outputDirectory}

<outputDiagnostics>

Indicates whether the compiler output should be visible, defaults to true.

Type: boolean
Required: Yes
User Property: annotation.outputDiagnostics
Default: true

<outputDirectory>

Specify the directory where to place generated source files (same behaviour of -s option)

Type: java.io.File
Required: No

<processSourceArtifacts>

List of artifacts on which perform sources scanning Each artifact must be specified in the form grouId:artifactId. If you need to include all artifacts belonging a groupId, specify as artifactId the character '*' e.g. org.bsc.maven:maven-confluence-plugin org.bsc.maven:*

Type: java.util.List
Since: 2.2.5
Required: No