Package org.apache.maven.plugins.pmd

Class PmdViolationCheckMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo<Violation>

org.apache.maven.plugins.pmd.PmdViolationCheckMojo

All Implemented Interfaces:

ContextEnabled, Mojo

Direct Known Subclasses:

AggregatorPmdViolationCheckMojo

@Mojo(name="check",
      defaultPhase=VERIFY,
      threadSafe=true)
@Execute(goal="pmd")
public class PmdViolationCheckMojo
extends AbstractPmdViolationCheckMojo<Violation>

Fails the build if there were any PMD violations in the source code.

Since:

2.0

Version:

$Id$

Field Summary

Fields inherited from class org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo

aggregate, failOnViolation, project

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

ROLE

Constructor Summary

Constructors

Constructor	Description
PmdViolationCheckMojo()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	execute()
protected List<Violation>	getErrorDetails(File pmdFile)	Gets the attributes and text for the violation tag and puts them in a HashMap
protected int	getPriority(Violation errorDetail)
protected ViolationDetails<Violation>	newViolationDetailsInstance()
protected void	printError(Violation item, String severity)	Formats the failure details and prints them as an INFO message

Methods inherited from class org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo

executeCheck, getMaxAllowedViolations, isAggregator, isFailOnViolation, printErrors

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

Constructor Details

PmdViolationCheckMojo

public PmdViolationCheckMojo()

Default constructor. Initializes with the correct ExcludeViolationsFromFile.

Method Details

execute

public void execute()
             throws MojoExecutionException,
MojoFailureException

Throws:

MojoExecutionException

MojoFailureException

printError

protected void printError(Violation item,
 String severity)

Formats the failure details and prints them as an INFO message

Specified by:

printError in class AbstractPmdViolationCheckMojo<Violation>

Parameters:

item - either a Violation from PMD or a Duplication from CPD

severity - the found issue is prefixed with the given severity, usually "Warning" or "Failure".

getErrorDetails

protected List<Violation> getErrorDetails(File pmdFile)
                                   throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
IOException

Description copied from class: AbstractPmdViolationCheckMojo

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

Specified by:

getErrorDetails in class AbstractPmdViolationCheckMojo<Violation>

Parameters:

pmdFile - the xml output from PMD or CPD

Returns:

all PMD Violations or CPD Duplications.

Throws:

org.codehaus.plexus.util.xml.pull.XmlPullParserException - if the analysis file contains invalid XML

IOException - if the analysis file could be read

getPriority

protected int getPriority(Violation errorDetail)

Specified by:

getPriority in class AbstractPmdViolationCheckMojo<Violation>

newViolationDetailsInstance

protected ViolationDetails<Violation> newViolationDetailsInstance()

Specified by:

newViolationDetailsInstance in class AbstractPmdViolationCheckMojo<Violation>