metrics-plugin:metrics

Computed metrics for the resources in a project as specified by a metric set.

Mojo Attributes:

• Requires a Maven 2.0 project that is also configured as an Eclipse project in order to execute
• Automatically executes within the lifecycle phase: verify
• Optionally generates a stand-alone report of the metric results (see metrics-plugin:metricsReport to generate a metrics report as part of the project's site)

Required Parameters

There are no required parameters.

Optional Parameters

Parameter Details

metricSet

An element that specifies the metric set that should be used when computing the metrics. For a description of the children of this configuration parameter, see the documentation on the metricSet element.

• Type: container
• Required: No
• Default: The default metric set in the workspace

classpathVariables

An element that specifies the classpath variables that need to be defined. For a description of the children of this configuration parameter, see the documentation on the classpathVariable element. The following is an example of a valid list of classpath variables:

<classpathVariables>
  <classpathVariable>
    ...
  </classpathVariable>
</classpathVariables>

• Type: container
• Required: No
• Default: None

eclipse

An element that specifies the information necessary to run Eclipse. For a description of the children of this configuration parameter, see the documentation on the eclipse element.

• Type: container
• Required: Only if ${eclipse.home} is not set
• Default: The installation at ${eclipse.home}

filter

An element that specifies which of the resources in the project are to have metrics computed for them. If the parameter is not specified then all of the resources will have metrics computed for them. For a description of the children of this configuration parameter, see the documentation on the filter element.

• Type: container
• Required: No
• Default: None

jreDirectory

The installation directory for the JRE used to run Eclipse.

• Type: File
• Required: Only if ${java.home} is not set
• Default: ${java.home}

reports

A specification of the stand-alone metrics reports to be produced based on the results of the metrics computation. The list is represented by child tags named report, each of which describes a single report. For a description of the children of this configuration parameter, see the documentation on the report element. The following is an example of a valid list of metric reports:

<reports>
  <report>
    ...
  </report>
</reports>

Note that these reports are not part of the site built by Maven.

• Type: container
• Required: No
• Default: None

storageLocation

A designation of the storage location in which the metrics result set will be stored. It can be either workspace (the default) or project: followed by the name of a project. Storage locations are discussed here.

• Type: String
• Required: No
• Default: "workspace"

tempDirectory

The absolute path of the temporary directory that can be used by this goal.

• Type: File
• Required: No
• Default: ${java.io.tmpdir}