org.apache.maven.plugin.pmd

Class CpdViolationCheckMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

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

org.apache.maven.plugin.pmd.CpdViolationCheckMojo

All Implemented Interfaces:

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

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

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

Since:

2.0

Version:

$Id: CpdViolationCheckMojo.java 1576478 2014-03-11 19:20:27Z dennisl $

Field Summary

Fields

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

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

aggregate, project

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

ROLE

Constructor Summary

Constructors

Constructor and Description
CpdViolationCheckMojo()

Method Summary

Methods

Modifier and Type	Method and 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)
protected boolean	isExcludedFromFailure(Duplication errorDetail)
boolean	isFailOnViolation()
protected void	loadExcludeFromFailuresData(String excludeFromFailureFile)
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.plugin.pmd.AbstractPmdViolationCheckMojo

executeCheck, 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 Detail

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 Detail

CpdViolationCheckMojo

public CpdViolationCheckMojo()

Method Detail

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>

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>

Throws:

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

IOException

isExcludedFromFailure

protected boolean isExcludedFromFailure(Duplication errorDetail)

Specified by:

isExcludedFromFailure in class AbstractPmdViolationCheckMojo<Duplication>

loadExcludeFromFailuresData

protected void loadExcludeFromFailuresData(String excludeFromFailureFile)
                                    throws org.apache.maven.plugin.MojoExecutionException

Specified by:

loadExcludeFromFailuresData in class AbstractPmdViolationCheckMojo<Duplication>

Throws:

org.apache.maven.plugin.MojoExecutionException

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>