exceptioncodes:report

Note:This goal should be used as a Maven report.

Full name:

de.smartics.exceptions:exceptioncodes-maven-plugin:0.10.2:report

Description:

Generates exception code documentation.

Attributes:

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

Optional Parameters

Name Type Since Description
addModuleSrcFolders boolean 1.0 Flag to add source pathes of modules of a multi module build. This allows to reference codes of all dependent modules.
Default value is: true.
additionalSources String - Specifies additional root directories of source files to consider. Please note that source file archives found at the same location as the class file archives are automatically visible. The source archive is required to have the suffix -sources in front of the extension and only jar- and zip-archives are supported.
excludes ArrayList 1.0 Specifies the names filter of the source and class files to be excluded from the reports. The path starts at the source path root, not at the project root.
includes ArrayList 1.0 Specifies the names filter of the source and class files to be included in the reports. The path starts at the source path root, not at the project root.
javadocDir File - Specifies the path to the directory the maven-javadoc-report generates the Javadoc HTML files. This allows the report generated by this plugin to reference Javadoc pages.
Default value is: ${project.reporting.outputDirectory}/apidocs.
locale String - The locale to use regardless of the report. This should be set to the locale the Javadoc comment is written in. If not set, the Maven provided locale is used.
logLevel String - Specifies the log level used for this plugin.

Allowed values are SEVERE, WARNING, INFO and FINEST.


outputName String - Specifies the name of the file to save the properties report (without extension).
Default value is: exception-codes-report.
reportEncoding String - Specifies the encoding the report will be written.
Default value is: UTF-8.
reportGenerator String - Specifies the name of the report generator instance. This class has to implement de.smartics.exceptions.report.ReportGenerator.
Currently three implementations are provided: de.smartics.maven.exceptions.report.PackageSortedSinkReportGenerator , de.smartics.maven.exceptions.report.CodeSortedSinkReportGenerator , and de.smartics.maven.exceptions.report.ComponentCodeSortedSinkReportGenerator .

Default value is: de.smartics.maven.exceptions.report.PackageSortedSinkReportGenerator.
skip boolean 1.0 A simple flag to skip the generation of the report. If set on the command line use -Dexceptioncodes.skip.
Default value is: false.
sourceEncoding String - Specifies the encoding the sources will be read.
Default value is: UTF-8.
sourceVersion String - Specifies the Java version of the sources.
Default value is: 1.5.

Parameter Details

addModuleSrcFolders:

Flag to add source pathes of modules of a multi module build. This allows to reference codes of all dependent modules.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${exceptioncodes.addModuleSrcFolders}
  • Default: true

additionalSources:

Specifies additional root directories of source files to consider. Please note that source file archives found at the same location as the class file archives are automatically visible. The source archive is required to have the suffix -sources in front of the extension and only jar- and zip-archives are supported.
  • Type: java.lang.String
  • Required: No
  • Expression: ${exceptioncodes.additionalSources}

excludes:

Specifies the names filter of the source and class files to be excluded from the reports. The path starts at the source path root, not at the project root.
  • Type: java.util.ArrayList
  • Since: 1.0
  • Required: No
  • Expression: ${exceptioncodes.excludes}

includes:

Specifies the names filter of the source and class files to be included in the reports. The path starts at the source path root, not at the project root.
  • Type: java.util.ArrayList
  • Since: 1.0
  • Required: No
  • Expression: ${exceptioncodes.includes}

javadocDir:

Specifies the path to the directory the maven-javadoc-report generates the Javadoc HTML files. This allows the report generated by this plugin to reference Javadoc pages.
  • Type: java.io.File
  • Required: No
  • Expression: ${report.javadocDir}
  • Default: ${project.reporting.outputDirectory}/apidocs

locale:

The locale to use regardless of the report. This should be set to the locale the Javadoc comment is written in. If not set, the Maven provided locale is used.
  • Type: java.lang.String
  • Required: No
  • Expression: ${exceptioncodes.locale}

logLevel:

Specifies the log level used for this plugin.

Allowed values are SEVERE, WARNING, INFO and FINEST.

  • Type: java.lang.String
  • Required: No
  • Expression: ${exceptioncodes.logLevel}

outputName:

Specifies the name of the file to save the properties report (without extension).
  • Type: java.lang.String
  • Required: No
  • Expression: ${properties.report.fileName}
  • Default: exception-codes-report

reportEncoding:

Specifies the encoding the report will be written.
  • Type: java.lang.String
  • Required: No
  • Expression: ${exceptioncodes.report.encoding}
  • Default: UTF-8

reportGenerator:

Specifies the name of the report generator instance. This class has to implement de.smartics.exceptions.report.ReportGenerator.
Currently three implementations are provided: de.smartics.maven.exceptions.report.PackageSortedSinkReportGenerator , de.smartics.maven.exceptions.report.CodeSortedSinkReportGenerator , and de.smartics.maven.exceptions.report.ComponentCodeSortedSinkReportGenerator .
  • Type: java.lang.String
  • Required: No
  • Expression: ${exceptioncodes.report.generator}
  • Default: de.smartics.maven.exceptions.report.PackageSortedSinkReportGenerator

skip:

A simple flag to skip the generation of the report. If set on the command line use -Dexceptioncodes.skip.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Expression: ${exceptioncodes.skip}
  • Default: false

sourceEncoding:

Specifies the encoding the sources will be read.
  • Type: java.lang.String
  • Required: No
  • Expression: ${exceptioncodes.build.sourceEncoding}
  • Default: UTF-8

sourceVersion:

Specifies the Java version of the sources.
  • Type: java.lang.String
  • Required: No
  • Expression: ${exceptioncodes.build.sourceVersion}
  • Default: 1.5