org.apache.maven.plugin.pmd
Class AbstractPmdViolationCheckMojo<D>

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugin.pmd.AbstractPmdViolationCheckMojo<D>

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

CpdViolationCheckMojo, PmdViolationCheckMojo

public abstract class AbstractPmdViolationCheckMojo<D>
extends AbstractMojo

Base class for mojos that check if there were any PMD violations.

Version:

$Id: AbstractPmdViolationCheckMojo.html 853015 2013-03-04 21:10:54Z olamy $

Author:

Brett Porter

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

@Component
protected MavenProject project

The project to analyze.

AbstractPmdViolationCheckMojo

public AbstractPmdViolationCheckMojo()

executeCheck

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

Throws:

MojoFailureException

MojoExecutionException

loadExcludeFromFailuresData

protected abstract void loadExcludeFromFailuresData(String excludeFromFailureFile)
                                             throws MojoExecutionException

Throws:

MojoExecutionException

getPriority

protected abstract int getPriority(D errorDetail)

isExcludedFromFailure

protected abstract boolean isExcludedFromFailure(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()