clirr:clirr

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

Full name:

org.codehaus.mojo:clirr-maven-plugin:2.4:clirr

Description:

Generate a report from the Clirr output.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile.
  • Invokes the execution of the lifecycle phase compile prior to executing itself.

Required Parameters

Name Type Since Description
outputDirectory File - Specifies the directory where the report will be generated.
Default value is: ${project.reporting.outputDirectory}.

Optional Parameters

Name Type Since Description
classesDirectory File - The classes of this project to compare the last release against.
Default value is: ${project.build.outputDirectory}.
comparisonArtifacts ArtifactSpecification[] - List of artifacts to compare the current code against. This overrides comparisonVersion, if present. Each comparisonArtifact is made of a groupId, an artifactId and a version number. Optionally it may have a classifier (default null) and a type (default "jar").
comparisonVersion String - Version to compare the current code against.
Default value is: (,${project.version}).
excludes String[] - A list of classes to exclude. These classes are excluded from the list of classes that are included. Values are specified in path pattern notation, e.g. org/codehaus/mojo/**.
htmlReport boolean - Whether to render the HTML report or not.
Default value is: true.
includes String[] - A list of classes to include. Anything not included is excluded. If omitted, all are assumed to be included. Values are specified in path pattern notation, e.g. org/codehaus/mojo/**.
linkXRef boolean - Link the violation line numbers to the source Xref. This will create links if the JXR Plugin is being used.
Default value is: true.
logResults boolean - Whether to log the results to the console or not.
Default value is: false.
minSeverity String - Show only messages of this severity or higher. Valid values are info, warning and error.
Default value is: warning.
showSummary boolean - Whether to show the summary of the number of errors, warnings and informational messages.
Default value is: true.
skip boolean - Flag to easily skip execution.
Default value is: false.
textOutputFile File - A text output file to render to. If omitted, no output is rendered to a text file.
xmlOutputFile File - An XML file to render to. If omitted, no output is rendered to an XML file.
xrefLocation File - Location of the Xrefs to link to.
Default value is: ${project.build.directory}/site/xref.

Parameter Details

classesDirectory:

The classes of this project to compare the last release against.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.outputDirectory}

comparisonArtifacts:

List of artifacts to compare the current code against. This overrides comparisonVersion, if present. Each comparisonArtifact is made of a groupId, an artifactId and a version number. Optionally it may have a classifier (default null) and a type (default "jar").
  • Type: org.codehaus.mojo.clirr.ArtifactSpecification[]
  • Required: No

comparisonVersion:

Version to compare the current code against.
  • Type: java.lang.String
  • Required: No
  • Expression: ${comparisonVersion}
  • Default: (,${project.version})

excludes:

A list of classes to exclude. These classes are excluded from the list of classes that are included. Values are specified in path pattern notation, e.g. org/codehaus/mojo/**.
  • Type: java.lang.String[]
  • Required: No

htmlReport:

Whether to render the HTML report or not.
  • Type: boolean
  • Required: No
  • Expression: ${htmlReport}
  • Default: true

includes:

A list of classes to include. Anything not included is excluded. If omitted, all are assumed to be included. Values are specified in path pattern notation, e.g. org/codehaus/mojo/**.
  • Type: java.lang.String[]
  • Required: No

linkXRef:

Link the violation line numbers to the source Xref. This will create links if the JXR Plugin is being used.
  • Type: boolean
  • Required: No
  • Expression: ${linkXRef}
  • Default: true

logResults:

Whether to log the results to the console or not.
  • Type: boolean
  • Required: No
  • Expression: ${logResults}
  • Default: false

minSeverity:

Show only messages of this severity or higher. Valid values are info, warning and error.
  • Type: java.lang.String
  • Required: No
  • Expression: ${minSeverity}
  • Default: warning

outputDirectory:

Specifies the directory where the report will be generated.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.reporting.outputDirectory}

showSummary:

Whether to show the summary of the number of errors, warnings and informational messages.
  • Type: boolean
  • Required: No
  • Expression: ${showSummary}
  • Default: true

skip:

Flag to easily skip execution.
  • Type: boolean
  • Required: No
  • Expression: ${clirr.skip}
  • Default: false

textOutputFile:

A text output file to render to. If omitted, no output is rendered to a text file.
  • Type: java.io.File
  • Required: No
  • Expression: ${textOutputFile}

xmlOutputFile:

An XML file to render to. If omitted, no output is rendered to an XML file.
  • Type: java.io.File
  • Required: No
  • Expression: ${xmlOutputFile}

xrefLocation:

Location of the Xrefs to link to.
  • Type: java.io.File
  • Required: No
  • Expression: ${xrefLocation}
  • Default: ${project.build.directory}/site/xref