javancss:report

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

Full name:

org.codehaus.mojo:javancss-maven-plugin:2.0:report

Description:

Generates a JavaNCSS report based on this module's source code.

Attributes:

  • Requires a Maven 2.0 project to be executed.

Required Parameters

Name Type Since Description
lineThreshold int - Specifies the maximum number of lines to take into account into the reports.
Default value is: 30.
tempFileName String - Specified the name of the temporary file generated by JavaNCSS prior report generation.
Default value is: javancss-raw-report.xml.
xmlOutputDirectory File - Specifies the directory where the XML report will be generated.
Default value is: ${project.build.directory}.

Optional Parameters

Name Type Since Description
excludes String[] - List of ant-style patterns used to specify the java sources that should be excluded when running JavaNCSS. If this is not specified, no files in the project source directories are excluded.
includes String[] - List of ant-style patterns used to specify the java sources that should be included when running JavaNCSS. If this is not specified, all .java files in the project source directories are included.
linkXRef boolean - Link the violation line numbers to the source xref. Defaults to true and will link automatically if jxr plugin is being used.
Default value is: true.
sourceEncoding String - Specifies the encoding of the source files.
Default value is: ${project.build.sourceEncoding}.
xrefLocation File - Location of the Xrefs to link to.
Default value is: ${project.build.directory}/site/xref.

Parameter Details

excludes:

List of ant-style patterns used to specify the java sources that should be excluded when running JavaNCSS. If this is not specified, no files in the project source directories are excluded.
  • Type: java.lang.String[]
  • Required: No

includes:

List of ant-style patterns used to specify the java sources that should be included when running JavaNCSS. If this is not specified, all .java files in the project source directories are included.
  • Type: java.lang.String[]
  • Required: No

lineThreshold:

Specifies the maximum number of lines to take into account into the reports.
  • Type: int
  • Required: Yes
  • Default: 30

linkXRef:

Link the violation line numbers to the source xref. Defaults to true and will link automatically if jxr plugin is being used.
  • Type: boolean
  • Required: No
  • Expression: ${linkXRef}
  • Default: true

sourceEncoding:

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

tempFileName:

Specified the name of the temporary file generated by JavaNCSS prior report generation.
  • Type: java.lang.String
  • Required: Yes
  • Default: javancss-raw-report.xml

xmlOutputDirectory:

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

xrefLocation:

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