cathcart:check_pmd

Full name:

net.sf.cathcart:maven-cathcart-plugin:0.9.7:check_pmd

Description:

Checks the violations metric generated by pmd.

Attributes:

  • Is NOT inherited by default in multi-project builds.

Required Parameters

Name Type Since Description
pmd.report File - The xml report produced by pmd which contains the raw data for checking.
basedir File - The base directory from which to execute the Ant script.
Default value is: ${basedir}.

Optional Parameters

Name Type Since Description
check.pmd.violations.leeway Double - The allowed leeway in the value of violations when compaired to the given limit.
Default value is: 0.
check.pmd.violations.absolute Boolean - Is the leeway for violations given as an absolute value (true) or a percentage (false)?
Default value is: false.
check.pmd.violations.limit Double - Fails if violations is more than this value.
Default value is: 99999.
messageLevel String - The message-level used to tune the verbosity of Ant logging.
Default value is: info.

Parameter Details

pmd.report:

The xml report produced by pmd which contains the raw data for checking.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${pmd.report}

check.pmd.violations.leeway:

The allowed leeway in the value of violations when compaired to the given limit.
  • Type: java.lang.Double
  • Required: No
  • Expression: ${check.pmd.violations.leeway}
  • Default: 0

check.pmd.violations.absolute:

Is the leeway for violations given as an absolute value (true) or a percentage (false)?
  • Type: java.lang.Boolean
  • Required: No
  • Expression: ${check.pmd.violations.absolute}
  • Default: false

check.pmd.violations.limit:

Fails if violations is more than this value.
  • Type: java.lang.Double
  • Required: No
  • Expression: ${check.pmd.violations.limit}
  • Default: 99999

basedir:

The base directory from which to execute the Ant script.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${antBasedir}
  • Default: ${basedir}

messageLevel:

The message-level used to tune the verbosity of Ant logging.
  • Type: java.lang.String
  • Required: No
  • Expression: ${antMessageLevel}
  • Default: info