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:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

CpdViolationCheckMojo, PmdViolationCheckMojo

public abstract class AbstractPmdViolationCheckMojo<D>
extends org.apache.maven.plugin.AbstractMojo

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

Version:

$Id: AbstractPmdViolationCheckMojo.java 1233066 2012-01-18 20:59:15Z rfscholte $

Author:

Brett Porter

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	aggregate Whether to build an aggregated report at the root, or build individual reports.
protected org.apache.maven.project.MavenProject	project The project to analyze.

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractPmdViolationCheckMojo()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	executeCheck(String filename, String tagName, String key, int failurePriority)
protected abstract List<D>	getErrorDetails(File analisysFile) Gets the attributes and text for the violation tag and puts them in a HashMap
protected abstract int	getPriority(D errorDetail)
protected abstract ViolationDetails<D>	newViolationDetailsInstance()
protected abstract void	printError(D item, String severity) Formats the failure details and prints them as an INFO message
protected void	printErrors(List<D> failures, List<D> warnings) Prints the warnings and failures

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.maven.plugin.Mojo

execute

Field Detail

aggregate

protected boolean aggregate

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

Since:

2.2

project

protected org.apache.maven.project.MavenProject project

The project to analyze.

Constructor Detail

AbstractPmdViolationCheckMojo

public AbstractPmdViolationCheckMojo()

Method Detail

executeCheck

protected void executeCheck(String filename,
                String tagName,
                String key,
                int failurePriority)
                     throws org.apache.maven.plugin.MojoFailureException,
                            org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.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 org.codehaus.plexus.util.xml.pull.XmlPullParserException,
                                           IOException

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

Parameters:

xpp -

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException

IOException