Package org.apache.maven.plugins.pmd

Class CpdViolationCheckMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

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

org.apache.maven.plugins.pmd.CpdViolationCheckMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

AggregatorCpdViolationCheckMojo

@Mojo(name="cpd-check",
      defaultPhase=VERIFY,
      threadSafe=true)
@Execute(goal="cpd")
public class CpdViolationCheckMojo
extends AbstractPmdViolationCheckMojo<Duplication>

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

Since:

2.0

Version:

$Id$

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	failOnViolation	Whether to fail the build if the validation check fails.

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

aggregate, project

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

ROLE

Constructor Summary

Constructors

Constructor	Description
CpdViolationCheckMojo()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	execute()
protected List<Duplication>	getErrorDetails(File cpdFile)	Gets the attributes and text for the violation tag and puts them in a HashMap
protected int	getPriority(Duplication errorDetail)
boolean	isFailOnViolation()
protected ViolationDetails<Duplication>	newViolationDetailsInstance()
protected void	printError(Duplication 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, 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

Field Details

failOnViolation

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

Whether to fail the build if the validation check fails.

Since:

3.0

Constructor Details

CpdViolationCheckMojo

public CpdViolationCheckMojo()

Default constructor. Initializes with the correct ExcludeDuplicationsFromFile.

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

printError

protected void printError(Duplication item,
 String severity)

Formats the failure details and prints them as an INFO message

Specified by:

printError in class AbstractPmdViolationCheckMojo<Duplication>

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<Duplication> getErrorDetails(File cpdFile)
                                     throws org.codehaus.plexus.util.xml.pull.XmlPullParserException,
IOException

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

Specified by:

getErrorDetails in class AbstractPmdViolationCheckMojo<Duplication>

Parameters:

cpdFile - 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(Duplication errorDetail)

Specified by:

getPriority in class AbstractPmdViolationCheckMojo<Duplication>

newViolationDetailsInstance

protected ViolationDetails<Duplication> newViolationDetailsInstance()

Specified by:

newViolationDetailsInstance in class AbstractPmdViolationCheckMojo<Duplication>

isFailOnViolation

public boolean isFailOnViolation()

Overrides:

isFailOnViolation in class AbstractPmdViolationCheckMojo<Duplication>