tentackle:analyze
Full name:
org.tentackle:tentackle-maven-plugin:25.20.1.0:analyze
Description:
Generates code and meta-information prior to wurbeling and compiling the sources.
Processes all annotations annotated with @Analyze, such as @Service.
Depending on the handler of each annotation, the results are either written as service descriptors to servicesDir, as analyze info to analyzeDir, or placed on heap to be picked up by the wurblets.
Attributes:
- Requires a Maven project to be executed.
- Requires dependency resolution of artifacts in scope:
compile. - The goal is thread-safe and supports parallel builds.
- Binds by default to the lifecycle phase:
generate-sources.
Required Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<analyzeDir> |
File |
- |
Directory for the analyze-results. Default: ${project.build.directory}/analyzeUser Property: wurbel.analyzeDir |
<servicesDir> |
File |
- |
Directory for the generated services.
Must be registered as a resource directory to end up in the artifact. Default: ${project.build.directory}/generated-resources/servicesUser Property: tentackle.serviceDir |
<sourceDir> |
File |
- |
Directory holding the sources to be processed.
Defaults to all java sources of the current project. If this is not desired, filesets must be used. Default: ${project.build.sourceDirectory}User Property: wurbel.sourceDir |
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<charset> |
String |
- |
The encoding to read and write files.
Applied JVM-wide, see org.tentackle.maven.AbstractTentackleMojo.determineEncoding()
.Default: ${project.build.sourceEncoding} |
<compilerArgs> |
List<String> |
- |
Arguments to be passed to the compiler.
(see maven-compiler-plugin) Unless one of them is a |
<compilerArgument> |
String |
- |
A single argument to be passed to the compiler as is.
(see maven-compiler-plugin) |
<encoding> |
String |
- |
The source file encoding.
If not set, the compiler's default is used. Default: ${project.build.sourceEncoding} |
<filesets> |
List<FileSet> |
- |
The list of file sets.
If set, they are processed instead of the whole source directory. A file set without a directory defaults to the source directory. |
<index> |
String |
- |
Optional index of the generated service resources, relative to servicesDir.
A plain list of resource paths, one per line, as read by org.tentackle.common.ServiceFactory#applyResourceIndex, for example in an OSGi activator.
Example: <index>META-INF/RESOURCE-INDEX.LIST</index> |
<jdkToolchain> |
Map<String,String> |
- |
Toolchain for invocation of external tools.
Explicitly specifies the "jdk" toolchain for this plugin only. Overrides the toolchain selected by the maven-toolchain-plugin, if any.
Example: <jdkToolchain>
<version>25</version>
</jdkToolchain>
To deselect the toolchain configured by the maven-toolchain-plugin:
<jdkToolchain></jdkToolchain> |
<minLogLevel> |
String |
- |
The minimum logging java.util.logging.Level
to redirect java.util logging to the maven logger.
Any name or value accepted by java.util.logging.Level.parse(java.lang.String)
.Default: WARNING |
<showCompileOutput> |
boolean |
- |
Shows the compiler diagnostics in the build log.
Errors reported by the annotation processors are always shown. Default: ${tentackle.showCompileOutput} |
<skip> |
Boolean |
- |
Skips processing.
If not set, defaults to true if packaging is "pom" and the execution is recursive (see org.tentackle.maven.AbstractTentackleMojo.isSkippedByDefault()
). |
<verbosity> |
String |
- |
The verbosity.
One of "default", "info" or "debug". Other values are treated as "default". If not set, debug is turned on by Maven's global debug flag (see command line switch -X).Default: ${tentackle.verbosity} |
Parameter Details
<analyzeDir>
Directory for the analyze-results.
- Type:
java.io.File - Required:
Yes - User Property:
wurbel.analyzeDir - Default:
${project.build.directory}/analyze
<charset>
The encoding to read and write files.
Applied JVM-wide, see
Applied JVM-wide, see
org.tentackle.maven.AbstractTentackleMojo.determineEncoding()
.- Type:
java.lang.String - Required:
No - Default:
${project.build.sourceEncoding}
<compilerArgs>
Arguments to be passed to the compiler.
(see maven-compiler-plugin)
(see maven-compiler-plugin)
Unless one of them is a -proc: option, -proc:only is added.
- Type:
java.util.List<java.lang.String> - Required:
No
<compilerArgument>
A single argument to be passed to the compiler as is.
(see maven-compiler-plugin)
(see maven-compiler-plugin)
- Type:
java.lang.String - Required:
No
<encoding>
The source file encoding.
If not set, the compiler's default is used.
If not set, the compiler's default is used.
- Type:
java.lang.String - Required:
No - Default:
${project.build.sourceEncoding}
<filesets>
The list of file sets.
If set, they are processed instead of the whole source directory. A file set without a directory defaults to the source directory.
If set, they are processed instead of the whole source directory. A file set without a directory defaults to the source directory.
- Type:
java.util.List<org.apache.maven.shared.model.fileset.FileSet> - Required:
No
<index>
Optional index of the generated service resources, relative to
A plain list of resource paths, one per line, as read by
servicesDir.
A plain list of resource paths, one per line, as read by
org.tentackle.common.ServiceFactory#applyResourceIndex, for example in an OSGi activator.
Example: <index>META-INF/RESOURCE-INDEX.LIST</index>
- Type:
java.lang.String - Required:
No
<jdkToolchain>
Toolchain for invocation of external tools.
Explicitly specifies the
Explicitly specifies the
"jdk" toolchain for this plugin only. Overrides the toolchain selected by the maven-toolchain-plugin, if any.
Example:
<jdkToolchain>
<version>25</version>
</jdkToolchain>
To deselect the toolchain configured by the maven-toolchain-plugin:
<jdkToolchain></jdkToolchain>
- Type:
java.util.Map<java.lang.String, java.lang.String> - Required:
No
<minLogLevel>
The minimum logging
Any name or value accepted by
java.util.logging.Level
to redirect java.util logging to the maven logger.
Any name or value accepted by
java.util.logging.Level.parse(java.lang.String)
.- Type:
java.lang.String - Required:
No - Default:
WARNING
<servicesDir>
Directory for the generated services.
Must be registered as a resource directory to end up in the artifact.
Must be registered as a resource directory to end up in the artifact.
- Type:
java.io.File - Required:
Yes - User Property:
tentackle.serviceDir - Default:
${project.build.directory}/generated-resources/services
<showCompileOutput>
Shows the compiler diagnostics in the build log.
Errors reported by the annotation processors are always shown.
Errors reported by the annotation processors are always shown.
- Type:
boolean - Required:
No - Default:
${tentackle.showCompileOutput}
<skip>
Skips processing.
If not set, defaults to true if packaging is "pom" and the execution is recursive (see
If not set, defaults to true if packaging is "pom" and the execution is recursive (see
org.tentackle.maven.AbstractTentackleMojo.isSkippedByDefault()
).- Type:
java.lang.Boolean - Required:
No
<sourceDir>
Directory holding the sources to be processed.
Defaults to all java sources of the current project. If this is not desired, filesets must be used.
Defaults to all java sources of the current project. If this is not desired, filesets must be used.
- Type:
java.io.File - Required:
Yes - User Property:
wurbel.sourceDir - Default:
${project.build.sourceDirectory}
<verbosity>
The verbosity.
One of "default", "info" or "debug". Other values are treated as "default".
If not set, debug is turned on by Maven's global debug flag (see command line switch
One of "default", "info" or "debug". Other values are treated as "default".
If not set, debug is turned on by Maven's global debug flag (see command line switch
-X).- Type:
java.lang.String - Required:
No - Default:
${tentackle.verbosity}
Tentackle