Modified: websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/index.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/index.html (original) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/index.html Sun Jan 21 17:23:18 2018 @@ -3,7 +3,7 @@ <html lang="de"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Apache Maven PMD Plugin 3.8 API</title> +<title>Apache Maven PMD Plugin 3.9.0 API</title> <script type="text/javascript"> targetPage = "" + window.location.search; if (targetPage != "" && targetPage != "undefined")
Added: websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/AbstractPmdReport.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/AbstractPmdReport.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/AbstractPmdReport.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,737 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="de"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>AbstractPmdReport (Apache Maven PMD Plugin 3.9.0 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="AbstractPmdReport (Apache Maven PMD Plugin 3.9.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractPmdReport.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="class in org.apache.maven.plugins.pmd"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/maven/plugins/pmd/AbstractPmdReport.html" target="_top">Frames</a></li> +<li><a href="AbstractPmdReport.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.maven.plugins.pmd</div> +<h2 title="Class AbstractPmdReport" class="title">Class AbstractPmdReport</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">org.apache.maven.plugin.AbstractMojo</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">org.apache.maven.reporting.AbstractMavenReport</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.maven.plugins.pmd.AbstractPmdReport</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/ContextEnabled.html?is-external=true" title="class or interface in org.apache.maven.plugin">ContextEnabled</a>, <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">Mojo</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenMultiPageReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenMultiPageReport</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReport</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/maven/plugins/pmd/CpdReport.html" title="class in org.apache.maven.plugins.pmd">CpdReport</a>, <a href="../../../../../org/apache/maven/plugins/pmd/PmdReport.html" title="class in org.apache.maven.plugins.pmd">PmdReport</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractPmdReport</span> +extends <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">AbstractMavenReport</a></pre> +<div class="block">Base class for the PMD reports.</div> +<dl><dt><span class="strong">Version:</span></dt> + <dd>$Id$</dd> +<dt><span class="strong">Author:</span></dt> + <dd><a href="mailto:br...@apache.org">Brett Porter</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#aggregate">aggregate</a></strong></code> +<div class="block">Whether to build an aggregated report at the root, or build individual reports.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#excludeFromFailureFile">excludeFromFailureFile</a></strong></code> +<div class="block">File that lists classes and rules to be excluded from failures.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>,<a href="../../../../../org/apache/maven/plugins/pmd/PmdFileInfo.html" title="class in org.apache.maven.plugins.pmd">PmdFileInfo</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#filesToProcess">filesToProcess</a></strong></code> +<div class="block">The files that are being analyzed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#format">format</a></strong></code> +<div class="block">Set the output format type, in addition to the HTML report.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#includeTests">includeTests</a></strong></code> +<div class="block">Run PMD on the tests.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#includeXmlInSite">includeXmlInSite</a></strong></code> +<div class="block">Whether to include the xml files generated by PMD/CPD in the site.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#outputDirectory">outputDirectory</a></strong></code> +<div class="block">The output directory for the final HTML report.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://maven.apache.org/maven-compat/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#project">project</a></strong></code> +<div class="block">The project to analyse.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-compat/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#reactorProjects">reactorProjects</a></strong></code> +<div class="block">The projects in the reactor for aggregation report.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#showPmdLog">showPmdLog</a></strong></code> +<div class="block">Redirect PMD log into maven log out.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#skipEmptyReport">skipEmptyReport</a></strong></code> +<div class="block">Skip the PMD/CPD report generation if there are no violations or duplications found.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#targetDirectory">targetDirectory</a></strong></code> +<div class="block">The output directory for the intermediate XML report.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.maven.reporting.MavenReport"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.maven.reporting.<a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReport</a></h3> +<code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#CATEGORY_PROJECT_INFORMATION" title="class or interface in org.apache.maven.reporting">CATEGORY_PROJECT_INFORMATION</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#CATEGORY_PROJECT_REPORTS" title="class or interface in org.apache.maven.reporting">CATEGORY_PROJECT_REPORTS</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#ROLE" title="class or interface in org.apache.maven.reporting">ROLE</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.maven.plugin.Mojo"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.maven.plugin.<a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">Mojo</a></h3> +<code><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true#ROLE" title="class or interface in org.apache.maven.plugin">ROLE</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#AbstractPmdReport()">AbstractPmdReport</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#canGenerateReport()">canGenerateReport</a></strong>()</code></td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#constructXRefLocation(boolean)">constructXRefLocation</a></strong>(boolean test)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>,<a href="../../../../../org/apache/maven/plugins/pmd/PmdFileInfo.html" title="class in org.apache.maven.plugins.pmd">PmdFileInfo</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#getFilesToProcess()">getFilesToProcess</a></strong>()</code> +<div class="block">Convenience method to get the list of files where the PMD tool will be executed</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#getOutputDirectory()">getOutputDirectory</a></strong>()</code></td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#getOutputEncoding()">getOutputEncoding</a></strong>()</code> +<div class="block">Gets the effective reporting output files encoding.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://maven.apache.org/maven-compat/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#getProject()">getProject</a></strong>()</code></td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/apidocs/org/apache/maven/doxia/siterenderer/Renderer.html?is-external=true" title="class or interface in org.apache.maven.doxia.siterenderer">Renderer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#getSiteRenderer()">getSiteRenderer</a></strong>()</code></td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#getSourceEncoding()">getSourceEncoding</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#isHtml()">isHtml</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#isXml()">isXml</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#setupPmdLogging()">setupPmdLogging</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.maven.reporting.AbstractMavenReport"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.maven.reporting.<a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">AbstractMavenReport</a></h3> +<code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#closeReport()" title="class or interface in org.apache.maven.reporting">closeReport</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#execute()" title="class or interface in org.apache.maven.reporting">execute</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#executeReport(java.util.Locale)" title="class or interface in org.apache.maven.reporting">executeReport</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#generate(org.codehaus.doxia.sink.Sink,%20java.util.Locale)" title="class or interface in org.apache.maven.reporting">generate</a>, <a href="http://maven.apache.org/ shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#generate(org.apache.maven.doxia.sink.Sink,%20java.util.Locale)" title="class or interface in org.apache.maven.reporting">generate</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#generate(org.apache.maven.doxia.sink.Sink,%20org.apache.maven.doxia.sink.SinkFactory,%20java.util.Locale)" title="class or interface in org.apache.maven.reporting">generate</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#getCategoryName()" title="class or interface in org.apache.maven.reporting">getCategoryName</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#getInputEncoding()" title="class or interface in org.apache.maven.report ing">getInputEncoding</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#getReportOutputDirectory()" title="class or interface in org.apache.maven.reporting">getReportOutputDirectory</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#getSink()" title="class or interface in org.apache.maven.reporting">getSink</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#getSinkFactory()" title="class or interface in org.apache.maven.reporting">getSinkFactory</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#isExternalReport()" title="class or interface in org.apache.maven.reporting">isExternalReport</a>, <a href="http://maven.apache.org /shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#setReportOutputDirectory(java.io.File)" title="class or interface in org.apache.maven.reporting">setReportOutputDirectory</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.maven.plugin.AbstractMojo"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.maven.plugin.<a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">AbstractMojo</a></h3> +<code><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#getLog()" title="class or interface in org.apache.maven.plugin">getLog</a>, <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#getPluginContext()" title="class or interface in org.apache.maven.plugin">getPluginContext</a>, <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#setLog(org.apache.maven.plugin.logging.Log)" title="class or interface in org.apache.maven.plugin">setLog</a>, <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#setPluginContext(java.util.Map)" title="class or interface in org.apache.maven.plugin">setPluginContext</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.maven.reporting.MavenReport"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.maven.reporting.<a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReport</a></h3> +<code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#getDescription(java.util.Locale)" title="class or interface in org.apache.maven.reporting">getDescription</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#getName(java.util.Locale)" title="class or interface in org.apache.maven.reporting">getName</a>, <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#getOutputName()" title="class or interface in org.apache.maven.reporting">getOutputName</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="targetDirectory"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>targetDirectory</h4> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Parameter</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#property()" title="class or interface in org.apache.maven.plugins.annotations">property</a>="project.build.directory", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#required()" title="class or interface in org.apache.maven.plugins.annotations">required</a>=true) +protected <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> targetDirectory</pre> +<div class="block">The output directory for the intermediate XML report.</div> +</li> +</ul> +<a name="outputDirectory"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>outputDirectory</h4> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Parameter</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#property()" title="class or interface in org.apache.maven.plugins.annotations">property</a>="project.reporting.outputDirectory", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#required()" title="class or interface in org.apache.maven.plugins.annotations">required</a>=true) +protected <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> outputDirectory</pre> +<div class="block">The output directory for the final HTML report. Note that this parameter is only evaluated if the goal is run + directly from the command line or during the default lifecycle. If the goal is run indirectly as part of a site + generation, the output directory configured in the Maven Site Plugin is used instead.</div> +</li> +</ul> +<a name="project"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>project</h4> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Parameter</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#defaultValue()" title="class or interface in org.apache.maven.plugins.annotations">defaultValue</a>="${project}", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#readonly()" title="class or interface in org.apache.maven.plugins.annotations">readonly</a>=true, + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#required()" title="class or interface in org.apache.maven.plugins.annotations">required</a>=true) +protected <a href="http://maven.apache.org/maven-compat/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> project</pre> +<div class="block">The project to analyse.</div> +</li> +</ul> +<a name="format"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>format</h4> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Parameter</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#property()" title="class or interface in org.apache.maven.plugins.annotations">property</a>="format", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#defaultValue()" title="class or interface in org.apache.maven.plugins.annotations">defaultValue</a>="xml") +protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> format</pre> +<div class="block">Set the output format type, in addition to the HTML report. Must be one of: "none", "csv", "xml", "txt" or the + full class name of the PMD renderer to use. See the net.sourceforge.pmd.renderers package javadoc for available + renderers. XML is required if the pmd:check goal is being used.</div> +</li> +</ul> +<a name="includeTests"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>includeTests</h4> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Parameter</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#defaultValue()" title="class or interface in org.apache.maven.plugins.annotations">defaultValue</a>="false") +protected boolean includeTests</pre> +<div class="block">Run PMD on the tests.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.2</dd></dl> +</li> +</ul> +<a name="aggregate"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>aggregate</h4> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Parameter</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#property()" title="class or interface in org.apache.maven.plugins.annotations">property</a>="aggregate", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#defaultValue()" title="class or interface in org.apache.maven.plugins.annotations">defaultValue</a>="false") +protected boolean aggregate</pre> +<div class="block">Whether to build an aggregated report at the root, or build individual reports.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.2</dd></dl> +</li> +</ul> +<a name="reactorProjects"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reactorProjects</h4> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Parameter</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#property()" title="class or interface in org.apache.maven.plugins.annotations">property</a>="reactorProjects", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#readonly()" title="class or interface in org.apache.maven.plugins.annotations">readonly</a>=true) +protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://maven.apache.org/maven-compat/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a>> reactorProjects</pre> +<div class="block">The projects in the reactor for aggregation report.</div> +</li> +</ul> +<a name="includeXmlInSite"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>includeXmlInSite</h4> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Parameter</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#defaultValue()" title="class or interface in org.apache.maven.plugins.annotations">defaultValue</a>="false") +protected boolean includeXmlInSite</pre> +<div class="block">Whether to include the xml files generated by PMD/CPD in the site.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>3.0</dd></dl> +</li> +</ul> +<a name="skipEmptyReport"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>skipEmptyReport</h4> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Parameter</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#defaultValue()" title="class or interface in org.apache.maven.plugins.annotations">defaultValue</a>="true") +protected boolean skipEmptyReport</pre> +<div class="block">Skip the PMD/CPD report generation if there are no violations or duplications found. Defaults to + <code>true</code>.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>3.1</dd></dl> +</li> +</ul> +<a name="excludeFromFailureFile"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>excludeFromFailureFile</h4> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Parameter</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#property()" title="class or interface in org.apache.maven.plugins.annotations">property</a>="pmd.excludeFromFailureFile", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#defaultValue()" title="class or interface in org.apache.maven.plugins.annotations">defaultValue</a>="") +protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> excludeFromFailureFile</pre> +<div class="block">File that lists classes and rules to be excluded from failures. + For PMD, this is a properties file. For CPD, this + is a text file that contains comma-separated lists of classes + that are allowed to duplicate.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>3.7</dd></dl> +</li> +</ul> +<a name="showPmdLog"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>showPmdLog</h4> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Parameter</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#defaultValue()" title="class or interface in org.apache.maven.plugins.annotations">defaultValue</a>="true", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#property()" title="class or interface in org.apache.maven.plugins.annotations">property</a>="pmd.showPmdLog") +protected boolean showPmdLog</pre> +<div class="block">Redirect PMD log into maven log out. + When enabled, the PMD log output is redirected to maven, so that + it is visible in the console together with all the other log output. + Also, if maven is started with the debug flag (<code>-X</code> or <code>--debug</code>), + the PMD logger is also configured for debug.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>3.9.0</dd></dl> +</li> +</ul> +<a name="filesToProcess"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>filesToProcess</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>,<a href="../../../../../org/apache/maven/plugins/pmd/PmdFileInfo.html" title="class in org.apache.maven.plugins.pmd">PmdFileInfo</a>> filesToProcess</pre> +<div class="block">The files that are being analyzed.</div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AbstractPmdReport()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractPmdReport</h4> +<pre>public AbstractPmdReport()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getProject()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getProject</h4> +<pre>protected <a href="http://maven.apache.org/maven-compat/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> getProject()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#getProject()" title="class or interface in org.apache.maven.reporting">getProject</a></code> in class <code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">AbstractMavenReport</a></code></dd> +</dl> +</li> +</ul> +<a name="getSiteRenderer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSiteRenderer</h4> +<pre>protected <a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-site-renderer/apidocs/org/apache/maven/doxia/siterenderer/Renderer.html?is-external=true" title="class or interface in org.apache.maven.doxia.siterenderer">Renderer</a> getSiteRenderer()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#getSiteRenderer()" title="class or interface in org.apache.maven.reporting">getSiteRenderer</a></code> in class <code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">AbstractMavenReport</a></code></dd> +</dl> +</li> +</ul> +<a name="constructXRefLocation(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>constructXRefLocation</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> constructXRefLocation(boolean test)</pre> +</li> +</ul> +<a name="getFilesToProcess()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFilesToProcess</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>,<a href="../../../../../org/apache/maven/plugins/pmd/PmdFileInfo.html" title="class in org.apache.maven.plugins.pmd">PmdFileInfo</a>> getFilesToProcess() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Convenience method to get the list of files where the PMD tool will be executed</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a List of the files where the PMD tool will be executed</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an I/O error occurs during construction of the + canonical pathnames of the files</dd></dl> +</li> +</ul> +<a name="isHtml()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isHtml</h4> +<pre>protected boolean isHtml()</pre> +</li> +</ul> +<a name="isXml()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isXml</h4> +<pre>protected boolean isXml()</pre> +</li> +</ul> +<a name="canGenerateReport()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canGenerateReport</h4> +<pre>public boolean canGenerateReport()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true#canGenerateReport()" title="class or interface in org.apache.maven.reporting">canGenerateReport</a></code> in interface <code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReport</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#canGenerateReport()" title="class or interface in org.apache.maven.reporting">canGenerateReport</a></code> in class <code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">AbstractMavenReport</a></code></dd> +</dl> +</li> +</ul> +<a name="getOutputDirectory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOutputDirectory</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getOutputDirectory()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#getOutputDirectory()" title="class or interface in org.apache.maven.reporting">getOutputDirectory</a></code> in class <code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">AbstractMavenReport</a></code></dd> +</dl> +</li> +</ul> +<a name="getSourceEncoding()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSourceEncoding</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSourceEncoding()</pre> +</li> +</ul> +<a name="getOutputEncoding()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOutputEncoding</h4> +<pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getOutputEncoding()</pre> +<div class="block">Gets the effective reporting output files encoding.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true#getOutputEncoding()" title="class or interface in org.apache.maven.reporting">getOutputEncoding</a></code> in class <code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/AbstractMavenReport.html?is-external=true" title="class or interface in org.apache.maven.reporting">AbstractMavenReport</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>The effective reporting output file encoding, never <code>null</code>.</dd><dt><span class="strong">Since:</span></dt> + <dd>2.5</dd></dl> +</li> +</ul> +<a name="setupPmdLogging()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setupPmdLogging</h4> +<pre>protected void setupPmdLogging()</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractPmdReport.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li>Prev Class</li> +<li><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="class in org.apache.maven.plugins.pmd"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/maven/plugins/pmd/AbstractPmdReport.html" target="_top">Frames</a></li> +<li><a href="AbstractPmdReport.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2005–2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> \ No newline at end of file Added: websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,501 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="de"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>AbstractPmdViolationCheckMojo (Apache Maven PMD Plugin 3.9.0 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="AbstractPmdViolationCheckMojo (Apache Maven PMD Plugin 3.9.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractPmdViolationCheckMojo.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html" title="class in org.apache.maven.plugins.pmd"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/maven/plugins/pmd/CpdReport.html" title="class in org.apache.maven.plugins.pmd"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" target="_top">Frames</a></li> +<li><a href="AbstractPmdViolationCheckMojo.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.maven.plugins.pmd</div> +<h2 title="Class AbstractPmdViolationCheckMojo" class="title">Class AbstractPmdViolationCheckMojo<D></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">org.apache.maven.plugin.AbstractMojo</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo<D></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>D</code> - type of the check, e.g. <a href="../../../../../org/apache/maven/plugins/pmd/model/Violation.html" title="class in org.apache.maven.plugins.pmd.model"><code>Violation</code></a> + or <a href="../../../../../org/apache/maven/plugins/pmd/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model"><code>Duplication</code></a>.</dd></dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/ContextEnabled.html?is-external=true" title="class or interface in org.apache.maven.plugin">ContextEnabled</a>, <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">Mojo</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html" title="class in org.apache.maven.plugins.pmd">CpdViolationCheckMojo</a>, <a href="../../../../../org/apache/maven/plugins/pmd/PmdViolationCheckMojo.html" title="class in org.apache.maven.plugins.pmd">PmdViolationCheckMojo</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">AbstractPmdViolationCheckMojo<D></span> +extends <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">AbstractMojo</a></pre> +<div class="block">Base class for mojos that check if there were any PMD violations.</div> +<dl><dt><span class="strong">Version:</span></dt> + <dd>$Id$</dd> +<dt><span class="strong">Author:</span></dt> + <dd><a href="mailto:br...@apache.org">Brett Porter</a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#aggregate">aggregate</a></strong></code> +<div class="block">Whether to build an aggregated report at the root, or build individual reports.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#failOnViolation">failOnViolation</a></strong></code> +<div class="block">Whether to fail the build if the validation check fails.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <a href="http://maven.apache.org/maven-compat/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#project">project</a></strong></code> +<div class="block">The project to analyze.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.maven.plugin.Mojo"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.maven.plugin.<a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">Mojo</a></h3> +<code><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true#ROLE" title="class or interface in org.apache.maven.plugin">ROLE</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#AbstractPmdViolationCheckMojo(org.apache.maven.plugins.pmd.ExcludeFromFile)">AbstractPmdViolationCheckMojo</a></strong>(<a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html" title="interface in org.apache.maven.plugins.pmd">ExcludeFromFile</a><<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="type parameter in AbstractPmdViolationCheckMojo">D</a>> excludeFromFile)</code> +<div class="block">Initialize this abstact check mojo by giving the correct ExcludeFromFile helper.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#executeCheck(java.lang.String,%20java.lang.String,%20java.lang.String,%20int)">executeCheck</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tagName, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, + int failurePriority)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="type parameter in AbstractPmdViolationCheckMojo">D</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#getErrorDetails(java.io.File)">getErrorDetails</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> analysisFile)</code> +<div class="block">Gets the attributes and text for the violation tag and puts them in a HashMap</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#getPriority(D)">getPriority</a></strong>(<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="type parameter in AbstractPmdViolationCheckMojo">D</a> errorDetail)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#isFailOnViolation()">isFailOnViolation</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected abstract <a href="../../../../../org/apache/maven/plugins/pmd/ViolationDetails.html" title="class in org.apache.maven.plugins.pmd">ViolationDetails</a><<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="type parameter in AbstractPmdViolationCheckMojo">D</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#newViolationDetailsInstance()">newViolationDetailsInstance</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#printError(D,%20java.lang.String)">printError</a></strong>(<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="type parameter in AbstractPmdViolationCheckMojo">D</a> item, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> severity)</code> +<div class="block">Formats the failure details and prints them as an INFO message</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#printErrors(java.util.List,%20java.util.List)">printErrors</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="type parameter in AbstractPmdViolationCheckMojo">D</a>> failures, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="type parameter in AbstractPmdViolationCheckMojo">D</a>> warnings)</code> +<div class="block">Prints the warnings and failures</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.maven.plugin.AbstractMojo"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.maven.plugin.<a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">AbstractMojo</a></h3> +<code><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#getLog()" title="class or interface in org.apache.maven.plugin">getLog</a>, <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#getPluginContext()" title="class or interface in org.apache.maven.plugin">getPluginContext</a>, <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#setLog(org.apache.maven.plugin.logging.Log)" title="class or interface in org.apache.maven.plugin">setLog</a>, <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/AbstractMojo.html?is-external=true#setPluginContext(java.util.Map)" title="class or interface in org.apache.maven.plugin">setPluginContext</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.maven.plugin.Mojo"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.maven.plugin.<a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true" title="class or interface in org.apache.maven.plugin">Mojo</a></h3> +<code><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/Mojo.html?is-external=true#execute()" title="class or interface in org.apache.maven.plugin">execute</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="failOnViolation"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failOnViolation</h4> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Parameter</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#property()" title="class or interface in org.apache.maven.plugins.annotations">property</a>="pmd.failOnViolation", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#defaultValue()" title="class or interface in org.apache.maven.plugins.annotations">defaultValue</a>="true", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#required()" title="class or interface in org.apache.maven.plugins.annotations">required</a>=true) +protected boolean failOnViolation</pre> +<div class="block">Whether to fail the build if the validation check fails.</div> +</li> +</ul> +<a name="aggregate"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>aggregate</h4> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Parameter</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#property()" title="class or interface in org.apache.maven.plugins.annotations">property</a>="aggregate", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#defaultValue()" title="class or interface in org.apache.maven.plugins.annotations">defaultValue</a>="false") +protected boolean aggregate</pre> +<div class="block">Whether to build an aggregated report at the root, or build individual reports.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.2</dd></dl> +</li> +</ul> +<a name="project"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>project</h4> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Parameter</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#defaultValue()" title="class or interface in org.apache.maven.plugins.annotations">defaultValue</a>="${project}", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#readonly()" title="class or interface in org.apache.maven.plugins.annotations">readonly</a>=true, + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Parameter.html?is-external=true#required()" title="class or interface in org.apache.maven.plugins.annotations">required</a>=true) +protected <a href="http://maven.apache.org/maven-compat/apidocs/org/apache/maven/project/MavenProject.html?is-external=true" title="class or interface in org.apache.maven.project">MavenProject</a> project</pre> +<div class="block">The project to analyze.</div> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="AbstractPmdViolationCheckMojo(org.apache.maven.plugins.pmd.ExcludeFromFile)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>AbstractPmdViolationCheckMojo</h4> +<pre>protected AbstractPmdViolationCheckMojo(<a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html" title="interface in org.apache.maven.plugins.pmd">ExcludeFromFile</a><<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="type parameter in AbstractPmdViolationCheckMojo">D</a>> excludeFromFile)</pre> +<div class="block">Initialize this abstact check mojo by giving the correct ExcludeFromFile helper.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>excludeFromFile</code> - the needed helper, for the specific violation type</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="executeCheck(java.lang.String, java.lang.String, java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>executeCheck</h4> +<pre>protected void executeCheck(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> filename, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tagName, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, + int failurePriority) + throws <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/MojoFailureException.html?is-external=true" title="class or interface in org.apache.maven.plugin">MojoFailureException</a>, + <a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/MojoExecutionException.html?is-external=true" title="class or interface in org.apache.maven.plugin">MojoExecutionException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/MojoFailureException.html?is-external=true" title="class or interface in org.apache.maven.plugin">MojoFailureException</a></code></dd> +<dd><code><a href="http://maven.apache.org/maven-plugin-api/apidocs/org/apache/maven/plugin/MojoExecutionException.html?is-external=true" title="class or interface in org.apache.maven.plugin">MojoExecutionException</a></code></dd></dl> +</li> +</ul> +<a name="getPriority(java.lang.Object)"> +<!-- --> +</a><a name="getPriority(D)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPriority</h4> +<pre>protected abstract int getPriority(<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="type parameter in AbstractPmdViolationCheckMojo">D</a> errorDetail)</pre> +</li> +</ul> +<a name="newViolationDetailsInstance()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newViolationDetailsInstance</h4> +<pre>protected abstract <a href="../../../../../org/apache/maven/plugins/pmd/ViolationDetails.html" title="class in org.apache.maven.plugins.pmd">ViolationDetails</a><<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="type parameter in AbstractPmdViolationCheckMojo">D</a>> newViolationDetailsInstance()</pre> +</li> +</ul> +<a name="printErrors(java.util.List, java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printErrors</h4> +<pre>protected void printErrors(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="type parameter in AbstractPmdViolationCheckMojo">D</a>> failures, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="type parameter in AbstractPmdViolationCheckMojo">D</a>> warnings)</pre> +<div class="block">Prints the warnings and failures</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>failures</code> - list of failures</dd><dd><code>warnings</code> - list of warnings</dd></dl> +</li> +</ul> +<a name="printError(java.lang.Object,java.lang.String)"> +<!-- --> +</a><a name="printError(D, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printError</h4> +<pre>protected abstract void printError(<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="type parameter in AbstractPmdViolationCheckMojo">D</a> item, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> severity)</pre> +<div class="block">Formats the failure details and prints them as an INFO message</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>item</code> - either a <a href="../../../../../org/apache/maven/plugins/pmd/model/Violation.html" title="class in org.apache.maven.plugins.pmd.model"><code>Violation</code></a> from PMD + or a <a href="../../../../../org/apache/maven/plugins/pmd/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model"><code>Duplication</code></a> from CPD</dd><dd><code>severity</code> - the found issue is prefixed with the given severity, usually "Warning" or "Failure".</dd></dl> +</li> +</ul> +<a name="getErrorDetails(java.io.File)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getErrorDetails</h4> +<pre>protected abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="type parameter in AbstractPmdViolationCheckMojo">D</a>> getErrorDetails(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> analysisFile) + throws <a href="http://codehaus-plexus.github.io/plexus-utils/apidocs/org/codehaus/plexus/util/xml/pull/XmlPullParserException.html?is-external=true" title="class or interface in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a>, + <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> +<div class="block">Gets the attributes and text for the violation tag and puts them in a HashMap</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>analysisFile</code> - the xml output from PMD or CPD</dd> +<dt><span class="strong">Returns:</span></dt><dd>all PMD <a href="../../../../../org/apache/maven/plugins/pmd/model/Violation.html" title="class in org.apache.maven.plugins.pmd.model"><code>Violation</code></a>s + or CPD <a href="../../../../../org/apache/maven/plugins/pmd/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model"><code>Duplication</code></a>s.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://codehaus-plexus.github.io/plexus-utils/apidocs/org/codehaus/plexus/util/xml/pull/XmlPullParserException.html?is-external=true" title="class or interface in org.codehaus.plexus.util.xml.pull">XmlPullParserException</a></code> - if the analysis file contains invalid XML</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if the analysis file could be read</dd></dl> +</li> +</ul> +<a name="isFailOnViolation()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isFailOnViolation</h4> +<pre>public boolean isFailOnViolation()</pre> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/AbstractPmdViolationCheckMojo.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../../index-all.html">Index</a></li> +<li><a href="../../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html" title="class in org.apache.maven.plugins.pmd"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/maven/plugins/pmd/CpdReport.html" title="class in org.apache.maven.plugins.pmd"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" target="_top">Frames</a></li> +<li><a href="AbstractPmdViolationCheckMojo.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field_summary">Field</a> | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2005–2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> \ No newline at end of file