plexus-component-metadata:generate-metadata

Full name:

org.codehaus.plexus:plexus-component-metadata:2.0.0:generate-metadata

Description:

Generates a Plexus components.xml component descriptor file from source (javadoc) or class annotations.

Attributes:

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

Required Parameters

Name Type Since Description
generatedMetadata File - The output location for the generated descriptor.
Default value is: ${project.build.outputDirectory}/META-INF/plexus/components.xml.
intermediaryMetadata File - The output location for the intermediary descriptor. This descriptors contains only the information extracted from the project's sources/classes.
Default value is: ${project.build.directory}/components.xml.
staticMetadataDirectory File - The location of manually crafted component descriptors. The contents of the descriptor files in this directory is merged with the information extracted from the project's sources/classes.
Default value is: ${basedir}/src/main/resources/META-INF/plexus.

Optional Parameters

Name Type Since Description
extractors List - The extractors to use. By default all available extractors will be used. Known extractors:
  • source
  • class
sourceEncoding String - The file encoding of the source files.
Default value is: ${project.build.sourceEncoding}.

Parameter Details

extractors:

The extractors to use. By default all available extractors will be used. Known extractors:
  • source
  • class
  • Type: java.util.List
  • Required: No

generatedMetadata:

The output location for the generated descriptor.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.outputDirectory}/META-INF/plexus/components.xml

intermediaryMetadata:

The output location for the intermediary descriptor. This descriptors contains only the information extracted from the project's sources/classes.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/components.xml

sourceEncoding:

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

staticMetadataDirectory:

The location of manually crafted component descriptors. The contents of the descriptor files in this directory is merged with the information extracted from the project's sources/classes.
  • Type: java.io.File
  • Required: Yes
  • Default: ${basedir}/src/main/resources/META-INF/plexus