Field Detail

• failOnViolation

  @Parameter(property="pmd.failOnViolation",
             defaultValue="true",
             required=true)
  protected boolean failOnViolation

  Whether to fail the build if the validation check fails.

• aggregate

  @Parameter(property="aggregate",
             defaultValue="false")
  protected boolean aggregate

  Whether to build an aggregated report at the root, or build individual reports.

  Since:

  2.2

• project

  @Parameter(defaultValue="${project}",
             readonly=true,
             required=true)
  protected org.apache.maven.project.MavenProject project

  The project to analyze.

Constructor Detail

• AbstractPmdViolationCheckMojo

  protected AbstractPmdViolationCheckMojo(ExcludeFromFile<D> excludeFromFile)

  Initialize this abstact check mojo by giving the correct ExcludeFromFile helper.

  Parameters:

  excludeFromFile - the needed helper, for the specific violation type

Method Detail

• executeCheck

  protected void executeCheck(String filename,
                  String tagName,
                  String key,
                  int failurePriority)
                       throws MojoFailureException,
                              MojoExecutionException

  Throws:

  MojoFailureException

  MojoExecutionException

• getPriority

  protected abstract int getPriority(D errorDetail)

• newViolationDetailsInstance

  protected abstract ViolationDetails<D> newViolationDetailsInstance()

• printErrors

  protected void printErrors(List<D> failures,
                 List<D> warnings)

  Prints the warnings and failures

  Parameters:

  failures - list of failures

  warnings - list of warnings

• printError

  protected abstract void printError(D item,
                String severity)

  Formats the failure details and prints them as an INFO message

  Parameters:

  item -

• getErrorDetails

  protected abstract List<D> getErrorDetails(File analisysFile)
                                      throws XmlPullParserException,
                                             IOException

  Gets the attributes and text for the violation tag and puts them in a HashMap

  Parameters:

  analisysFile -

  Throws:

  XmlPullParserException

  IOException

• isFailOnViolation

  public boolean isFailOnViolation()