plexus:descriptor

Full name:

org.codehaus.plexus:plexus-maven-plugin:1.3.9-SNAPSHOT:descriptor

Description:

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

Attributes:

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

Required Parameters

Name Type Since Description
containerDescriptor boolean 1.3.4 Whether to generate a Plexus Container descriptor instead of a component descriptor.
Default value is: false.
fileName String 1.3.4 The relative path to the output file for the generated descriptor.
Default value is: META-INF/plexus/components.xml.
outputDirectory File 1.3.4 The directory where the descriptor is written.
Default value is: ${project.build.outputDirectory}.

Optional Parameters

Name Type Since Description
encoding String 1.3.9 The file encoding to use when reading the source files.
Default value is: ${project.build.sourceEncoding}.
extractors ComponentDescriptorExtractor[] 1.3.4 (no description)
roleDefaults ComponentDescriptor[] 1.3.4 (no description)

Parameter Details

containerDescriptor:

Whether to generate a Plexus Container descriptor instead of a component descriptor.
  • Type: boolean
  • Since: 1.3.4
  • Required: Yes
  • Default: false

encoding:

The file encoding to use when reading the source files.
  • Type: java.lang.String
  • Since: 1.3.9
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

extractors:

(no description)
  • Type: org.codehaus.plexus.maven.plugin.ComponentDescriptorExtractor[]
  • Since: 1.3.4
  • Required: No

fileName:

The relative path to the output file for the generated descriptor.
  • Type: java.lang.String
  • Since: 1.3.4
  • Required: Yes
  • Default: META-INF/plexus/components.xml

outputDirectory:

The directory where the descriptor is written.
  • Type: java.io.File
  • Since: 1.3.4
  • Required: Yes
  • Default: ${project.build.outputDirectory}

roleDefaults:

(no description)
  • Type: org.codehaus.plexus.component.repository.cdc.ComponentDescriptor[]
  • Since: 1.3.4
  • Required: No