D
- type of the check, e.g. Violation
or Duplication
.ContextEnabled
, Mojo
CpdViolationCheckMojo
, PmdViolationCheckMojo
public abstract class AbstractPmdViolationCheckMojo<D> extends AbstractMojo
Modifier and Type | Field | Description |
---|---|---|
protected boolean |
aggregate |
Whether to build an aggregated report at the root, or build individual reports.
|
protected boolean |
failOnViolation |
Whether to fail the build if the validation check fails.
|
protected MavenProject |
project |
The project to analyze.
|
Modifier | Constructor | Description |
---|---|---|
protected |
AbstractPmdViolationCheckMojo(ExcludeFromFile<D> excludeFromFile) |
Initialize this abstact check mojo by giving the correct ExcludeFromFile helper.
|
Modifier and Type | Method | Description |
---|---|---|
protected void |
executeCheck(java.lang.String filename,
java.lang.String tagName,
java.lang.String key,
int failurePriority) |
|
protected abstract java.util.List<D> |
getErrorDetails(java.io.File analysisFile) |
Gets the attributes and text for the violation tag and puts them in a HashMap
|
java.lang.Integer |
getMaxAllowedViolations() |
|
protected abstract int |
getPriority(D errorDetail) |
|
boolean |
isFailOnViolation() |
|
protected abstract ViolationDetails<D> |
newViolationDetailsInstance() |
|
protected abstract void |
printError(D item,
java.lang.String severity) |
Formats the failure details and prints them as an INFO message
|
protected void |
printErrors(java.util.List<D> failures,
java.util.List<D> warnings) |
Prints the warnings and failures
|
getLog, getPluginContext, setLog, setPluginContext
@Parameter(property="pmd.failOnViolation", defaultValue="true", required=true) protected boolean failOnViolation
@Parameter(property="aggregate", defaultValue="false") protected boolean aggregate
@Parameter(defaultValue="${project}", readonly=true, required=true) protected MavenProject project
protected AbstractPmdViolationCheckMojo(ExcludeFromFile<D> excludeFromFile)
excludeFromFile
- the needed helper, for the specific violation typeprotected void executeCheck(java.lang.String filename, java.lang.String tagName, java.lang.String key, int failurePriority) throws MojoFailureException, MojoExecutionException
protected abstract int getPriority(D errorDetail)
protected abstract ViolationDetails<D> newViolationDetailsInstance()
protected void printErrors(java.util.List<D> failures, java.util.List<D> warnings)
failures
- list of failureswarnings
- list of warningsprotected abstract void printError(D item, java.lang.String severity)
item
- either a Violation
from PMD
or a Duplication
from CPDseverity
- the found issue is prefixed with the given severity, usually "Warning" or "Failure".protected abstract java.util.List<D> getErrorDetails(java.io.File analysisFile) throws XmlPullParserException, java.io.IOException
analysisFile
- the xml output from PMD or CPDViolation
s
or CPD Duplication
s.XmlPullParserException
- if the analysis file contains invalid XMLjava.io.IOException
- if the analysis file could be readpublic boolean isFailOnViolation()
public java.lang.Integer getMaxAllowedViolations()
Copyright © 2005–2018 The Apache Software Foundation. All rights reserved.