Package org.apache.maven.plugins.pmd

Klasse CpdViolationCheckMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

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

org.apache.maven.plugins.pmd.CpdViolationCheckMojo

Alle implementierten Schnittstellen:

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

Bekannte direkte Unterklassen:

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.

Seit:

2.0

Version:

$Id$

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected boolean	failOnViolation	Whether to fail the build if the validation check fails.

Von Klasse geerbte Felder org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo

aggregate, project

Von Schnittstelle geerbte Felder org.apache.maven.plugin.Mojo

ROLE

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
CpdViolationCheckMojo()	Default constructor.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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

Von Klasse geerbte Methoden org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo

executeCheck, getMaxAllowedViolations, isAggregator, printErrors

Von Klasse geerbte Methoden org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

failOnViolation

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

Whether to fail the build if the validation check fails.

Seit:

3.0

Konstruktordetails

CpdViolationCheckMojo

public CpdViolationCheckMojo()

Default constructor. Initializes with the correct ExcludeDuplicationsFromFile.

Methodendetails

execute

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

Löst aus:

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

Angegeben von:

printError in Klasse AbstractPmdViolationCheckMojo<Duplication>

Parameter:

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

Angegeben von:

getErrorDetails in Klasse AbstractPmdViolationCheckMojo<Duplication>

Parameter:

cpdFile - the xml output from PMD or CPD

Gibt zurück:

all PMD Violations or CPD Duplications.

Löst aus:

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)

Angegeben von:

getPriority in Klasse AbstractPmdViolationCheckMojo<Duplication>

newViolationDetailsInstance

protected ViolationDetails<Duplication> newViolationDetailsInstance()

Angegeben von:

newViolationDetailsInstance in Klasse AbstractPmdViolationCheckMojo<Duplication>

isFailOnViolation

public boolean isFailOnViolation()

Setzt außer Kraft:

isFailOnViolation in Klasse AbstractPmdViolationCheckMojo<Duplication>