cathcart:check_generic

Full name:

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

Description:

Checks the downward and upward metrics generated by generic.

Attributes:

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

Required Parameters

Name Type Since Description
generic.report File - The xml report produced by generic 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.generic.downward.leeway Double - The allowed leeway in the value of downward when compaired to the given limit.
Default value is: 0.
check.generic.downward.absolute Boolean - Is the leeway for downward given as an absolute value (true) or a percentage (false)?
Default value is: false.
check.generic.downward.limit Double - Fails if downward is more than this value.
Default value is: 99999.
check.generic.upward.leeway Double - The allowed leeway in the value of upward when compaired to the given limit.
Default value is: 0.
check.generic.upward.absolute Boolean - Is the leeway for upward given as an absolute value (true) or a percentage (false)?
Default value is: false.
check.generic.upward.limit Double - Fails if upward is less than this value.
Default value is: 0.
messageLevel String - The message-level used to tune the verbosity of Ant logging.
Default value is: info.

Parameter Details

generic.report:

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

check.generic.downward.leeway:

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

check.generic.downward.absolute:

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

check.generic.downward.limit:

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

check.generic.upward.leeway:

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

check.generic.upward.absolute:

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

check.generic.upward.limit:

Fails if upward is less than this value.
  • Type: java.lang.Double
  • Required: No
  • Expression: ${check.generic.upward.limit}
  • Default: 0

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