smartics-properties:xml-export

Full name:

de.smartics.properties:smartics-properties-maven-plugin:0.2.0:xml-export

Description:

Generates an XML report about the properties of the given project. The reports are per default written to /META-INF/smartics-properties in the projectdoc format for properties. The information is read by the runtime if smartics-properties are used and is responsible to make compile-time information available (i.e. Javadoc comments).

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.0.
  • Invokes the execution of the lifecycle phase process-classes prior to executing itself.

Required Parameters

Name Type Since Description
outputDirectory String 1.0 The root directory to write reports to.
Default value is: ${project.build.outputDirectory}/META-INF/smartics-properties.
propertyReportRoot String 1.0 The path to the base directory to write property reports. Within the given output directory, if not specified by an absolute path.
Default value is: property-report.
propertySetReportRoot String 1.0 The path to the base directory to write property reports. Within the given output directory, if not specified by an absolute path.
Default value is: property-set-report.

Optional Parameters

Name Type Since Description
addMain boolean 1.0 Adds the main sources to the list of reports.
Default value is: true.
addTest boolean 1.0 Adds the test sources to the list of reports.
Default value is: false.
aggregate boolean 1.0 The flag to control the aggregation of reports. If set to true the report will be aggregated in the multi module POM. Otherwise it is generated for each sub module individually.
Default value is: false.
outputEncoding String 1.0 The encoding to use to write reports.
Default value is: ${project.reporting.outputEncoding}.
User property is: outputEncoding.
skip boolean 1.0 A simple flag to skip the generation of the reports. If set on the command line use -Dprojectdoc-properties.skip.
Default value is: false.
User property is: projectdoc-properties.skip.
sourceEncoding String 1.0 The encoding of the source files.
Default value is: ${project.build.sourceEncoding}.
User property is: sourceEncoding.

Parameter Details

addMain:

Adds the main sources to the list of reports.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: true

addTest:

Adds the test sources to the list of reports.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

aggregate:

The flag to control the aggregation of reports. If set to true the report will be aggregated in the multi module POM. Otherwise it is generated for each sub module individually.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • Default: false

outputDirectory:

The root directory to write reports to.
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • Default: ${project.build.outputDirectory}/META-INF/smartics-properties

outputEncoding:

The encoding to use to write reports.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: outputEncoding
  • Default: ${project.reporting.outputEncoding}

propertyReportRoot:

The path to the base directory to write property reports. Within the given output directory, if not specified by an absolute path.
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • Default: property-report

propertySetReportRoot:

The path to the base directory to write property reports. Within the given output directory, if not specified by an absolute path.
  • Type: java.lang.String
  • Since: 1.0
  • Required: Yes
  • Default: property-set-report

skip:

A simple flag to skip the generation of the reports. If set on the command line use -Dprojectdoc-properties.skip.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: projectdoc-properties.skip
  • Default: false

sourceEncoding:

The encoding of the source files.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: sourceEncoding
  • Default: ${project.build.sourceEncoding}