Added: websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/CpdReport.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/CpdReport.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/CpdReport.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,421 @@ +<!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>CpdReport (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="CpdReport (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/CpdReport.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/AbstractPmdViolationCheckMojo.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/CpdReportGenerator.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/CpdReport.html" target="_top">Frames</a></li> +<li><a href="CpdReport.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="#fields_inherited_from_class_org.apache.maven.plugins.pmd.AbstractPmdReport">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>Field | </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 CpdReport" class="title">Class CpdReport</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><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html" title="class in org.apache.maven.plugins.pmd">org.apache.maven.plugins.pmd.AbstractPmdReport</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.maven.plugins.pmd.CpdReport</li> +</ul> +</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> +<hr> +<br> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Mojo.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Mojo</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Mojo.html?is-external=true#name()" title="class or interface in org.apache.maven.plugins.annotations">name</a>="cpd", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Mojo.html?is-external=true#threadSafe()" title="class or interface in org.apache.maven.plugins.annotations">threadSafe</a>=true) +public class <span class="strong">CpdReport</span> +extends <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html" title="class in org.apache.maven.plugins.pmd">AbstractPmdReport</a></pre> +<div class="block">Creates a report for PMD's CPD tool. See + <a href="https://pmd.github.io/latest/pmd_userdocs_cpd.html">Finding duplicated code</a> + for more details.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd> +<dt><span class="strong">Version:</span></dt> + <dd>$Id$</dd> +<dt><span class="strong">Author:</span></dt> + <dd>Mike Perham</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> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.maven.plugins.pmd.AbstractPmdReport"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.maven.plugins.pmd.<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html" title="class in org.apache.maven.plugins.pmd">AbstractPmdReport</a></h3> +<code><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#aggregate">aggregate</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#excludeFromFailureFile">excludeFromFailureFile</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#filesToProcess">filesToProcess</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#format">format</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#includeTests">includeTests</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#includeXmlInSite">includeXmlInSite</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#outputDirectory">outputDirectory</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#project">project</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#reactorProjects">reactorProjects</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#showPmdLog">showPmdLog</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#skipEmptyReport">skipEmptyReport</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#targetDirectory">targetDirectory</a></code></li> +</ul> +<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/CpdReport.html#CpdReport()">CpdReport</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/CpdReport.html#canGenerateReport()">canGenerateReport</a></strong>()</code></td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>net.sourceforge.pmd.cpd.Renderer</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/CpdReport.html#createRenderer()">createRenderer</a></strong>()</code> +<div class="block">Create and return the correct renderer for the output type.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/CpdReport.html#executeReport(java.util.Locale)">executeReport</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</code></td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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/CpdReport.html#getDescription(java.util.Locale)">getDescription</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</code></td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><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/CpdReport.html#getName(java.util.Locale)">getName</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</code></td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><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/CpdReport.html#getOutputName()">getOutputName</a></strong>()</code></td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.maven.plugins.pmd.AbstractPmdReport"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.maven.plugins.pmd.<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html" title="class in org.apache.maven.plugins.pmd">AbstractPmdReport</a></h3> +<code><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#constructXRefLocation(boolean)">constructXRefLocation</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#getFilesToProcess()">getFilesToProcess</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#getOutputDirectory()">getOutputDirectory</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#getOutputEncoding()">getOutputEncoding</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#getProject()">getProject</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#getSiteRenderer()">getSiteRenderer</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#getSourceEncoding()">getSourceEncoding</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#isHtml()">isHtml</a>, <a href="../../../../../org/apache/maven/plugins/pmd/A bstractPmdReport.html#isXml()">isXml</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#setupPmdLogging()">setupPmdLogging</a></code></li> +</ul> +<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#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.reporting">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.reportin g">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> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CpdReport()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CpdReport</h4> +<pre>public CpdReport()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getName(java.util.Locale)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public <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> getName(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</pre> +</li> +</ul> +<a name="getDescription(java.util.Locale)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDescription</h4> +<pre>public <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> getDescription(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</pre> +</li> +</ul> +<a name="executeReport(java.util.Locale)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>executeReport</h4> +<pre>public void executeReport(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale) + throws <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReportException.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReportException</a></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/AbstractMavenReport.html?is-external=true#executeReport(java.util.Locale)" title="class or interface in org.apache.maven.reporting">executeReport</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">Throws:</span></dt> +<dd><code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReportException.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReportException</a></code></dd></dl> +</li> +</ul> +<a name="canGenerateReport()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>canGenerateReport</h4> +<pre>public boolean canGenerateReport()</pre> +<div class="block"><strong>Description copied from class: <code><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#canGenerateReport()">AbstractPmdReport</a></code></strong></div> +<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="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html#canGenerateReport()">canGenerateReport</a></code> in class <code><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReport.html" title="class in org.apache.maven.plugins.pmd">AbstractPmdReport</a></code></dd> +</dl> +</li> +</ul> +<a name="getOutputName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOutputName</h4> +<pre>public <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> getOutputName()</pre> +</li> +</ul> +<a name="createRenderer()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createRenderer</h4> +<pre>public net.sourceforge.pmd.cpd.Renderer createRenderer() + throws <a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReportException.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReportException</a></pre> +<div class="block">Create and return the correct renderer for the output type.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the renderer based on the configured output</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://maven.apache.org/shared/maven-reporting-api/apidocs/org/apache/maven/reporting/MavenReportException.html?is-external=true" title="class or interface in org.apache.maven.reporting">MavenReportException</a></code> - if no renderer found for the output type</dd></dl> +</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/CpdReport.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/AbstractPmdViolationCheckMojo.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/CpdReportGenerator.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/CpdReport.html" target="_top">Frames</a></li> +<li><a href="CpdReport.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="#fields_inherited_from_class_org.apache.maven.plugins.pmd.AbstractPmdReport">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>Field | </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/CpdReportGenerator.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/CpdReportGenerator.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/CpdReportGenerator.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,287 @@ +<!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>CpdReportGenerator (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="CpdReportGenerator (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/CpdReportGenerator.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/CpdReport.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/CpdViolationCheckMojo.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/CpdReportGenerator.html" target="_top">Frames</a></li> +<li><a href="CpdReportGenerator.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>Field | </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>Field | </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 CpdReportGenerator" class="title">Class CpdReportGenerator</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>org.apache.maven.plugins.pmd.CpdReportGenerator</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="strong">CpdReportGenerator</span> +extends <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></pre> +<div class="block">Class that generated the CPD report.</div> +<dl><dt><span class="strong">Version:</span></dt> + <dd>$Id$</dd> +<dt><span class="strong">Author:</span></dt> + <dd>mperham</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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/CpdReportGenerator.html#CpdReportGenerator(org.apache.maven.doxia.sink.Sink,%20java.util.Map,%20java.util.ResourceBundle,%20boolean)">CpdReportGenerator</a></strong>(<a href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html?is-external=true" title="class or interface in org.apache.maven.doxia.sink">Sink</a> sink, + <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>> fileMap, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util">ResourceBundle</a> bundle, + boolean aggregate)</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/CpdReportGenerator.html#beginDocument()">beginDocument</a></strong>()</code> +<div class="block">Method that generates the start of the CPD report.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/CpdReportGenerator.html#generate(java.util.Iterator)">generate</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><net.sourceforge.pmd.cpd.Match> matches)</code> +<div class="block">Method that generates the contents of the CPD report</div> +</td> +</tr> +</table> +<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> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CpdReportGenerator(org.apache.maven.doxia.sink.Sink, java.util.Map, java.util.ResourceBundle, boolean)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CpdReportGenerator</h4> +<pre>public CpdReportGenerator(<a href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html?is-external=true" title="class or interface in org.apache.maven.doxia.sink">Sink</a> sink, + <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>> fileMap, + <a href="http://docs.oracle.com/javase/7/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util">ResourceBundle</a> bundle, + boolean aggregate)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="beginDocument()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>beginDocument</h4> +<pre>public void beginDocument()</pre> +<div class="block">Method that generates the start of the CPD report.</div> +</li> +</ul> +<a name="generate(java.util.Iterator)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>generate</h4> +<pre>public void generate(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><net.sourceforge.pmd.cpd.Match> matches)</pre> +<div class="block">Method that generates the contents of the CPD report</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>matches</code> - the found duplications</dd></dl> +</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/CpdReportGenerator.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/CpdReport.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/CpdViolationCheckMojo.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/CpdReportGenerator.html" target="_top">Frames</a></li> +<li><a href="CpdReportGenerator.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>Field | </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>Field | </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/CpdViolationCheckMojo.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,460 @@ +<!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>CpdViolationCheckMojo (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="CpdViolationCheckMojo (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/CpdViolationCheckMojo.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/CpdReportGenerator.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/ExcludeDuplicationsFromFile.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/CpdViolationCheckMojo.html" target="_top">Frames</a></li> +<li><a href="CpdViolationCheckMojo.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 CpdViolationCheckMojo" class="title">Class CpdViolationCheckMojo</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="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="class in org.apache.maven.plugins.pmd">org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo</a><<a href="../../../../../org/apache/maven/plugins/pmd/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.maven.plugins.pmd.CpdViolationCheckMojo</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></dd> +</dl> +<hr> +<br> +<pre><a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Mojo.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Mojo</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Mojo.html?is-external=true#name()" title="class or interface in org.apache.maven.plugins.annotations">name</a>="cpd-check", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Mojo.html?is-external=true#defaultPhase()" title="class or interface in org.apache.maven.plugins.annotations">defaultPhase</a>=<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/LifecyclePhase.html?is-external=true#VERIFY" title="class or interface in org.apache.maven.plugins.annotations">VERIFY</a>, + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Mojo.html?is-external=true#threadSafe()" title="class or interface in org.apache.maven.plugins.annotations">threadSafe</a>=true) +<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Execute.html?is-external=true" title="class or interface in org.apache.maven.plugins.annotations">@Execute</a>(<a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Execute.html?is-external=true#goal()" title="class or interface in org.apache.maven.plugins.annotations">goal</a>="cpd") +public class <span class="strong">CpdViolationCheckMojo</span> +extends <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="class in org.apache.maven.plugins.pmd">AbstractPmdViolationCheckMojo</a><<a href="../../../../../org/apache/maven/plugins/pmd/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</a>></pre> +<div class="block">Fail the build if there were any CPD violations in the source code.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd> +<dt><span class="strong">Version:</span></dt> + <dd>$Id$</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/CpdViolationCheckMojo.html#failOnViolation">failOnViolation</a></strong></code> +<div class="block">Whether to fail the build if the validation check fails.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.maven.plugins.pmd.<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="class in org.apache.maven.plugins.pmd">AbstractPmdViolationCheckMojo</a></h3> +<code><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#aggregate">aggregate</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#project">project</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/CpdViolationCheckMojo.html#CpdViolationCheckMojo()">CpdViolationCheckMojo</a></strong>()</code> +<div class="block">Default constructor.</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html#execute()">execute</a></strong>()</code></td> +</tr> +<tr class="rowColor"> +<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="../../../../../org/apache/maven/plugins/pmd/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/CpdViolationCheckMojo.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> cpdFile)</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 int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html#getPriority(org.apache.maven.plugins.pmd.model.Duplication)">getPriority</a></strong>(<a href="../../../../../org/apache/maven/plugins/pmd/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</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/CpdViolationCheckMojo.html#isFailOnViolation()">isFailOnViolation</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected <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/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html#newViolationDetailsInstance()">newViolationDetailsInstance</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/CpdViolationCheckMojo.html#printError(org.apache.maven.plugins.pmd.model.Duplication,%20java.lang.String)">printError</a></strong>(<a href="../../../../../org/apache/maven/plugins/pmd/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</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> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.maven.plugins.pmd.AbstractPmdViolationCheckMojo"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.maven.plugins.pmd.<a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="class in org.apache.maven.plugins.pmd">AbstractPmdViolationCheckMojo</a></h3> +<code><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#executeCheck(java.lang.String,%20java.lang.String,%20java.lang.String,%20int)">executeCheck</a>, <a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#printErrors(java.util.List,%20java.util.List)">printErrors</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> +</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="blockListLast"> +<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>="cpd.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> +<dl><dt><span class="strong">Since:</span></dt> + <dd>3.0</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CpdViolationCheckMojo()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CpdViolationCheckMojo</h4> +<pre>public CpdViolationCheckMojo()</pre> +<div class="block">Default constructor. Initializes with the correct <a href="../../../../../org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html" title="class in org.apache.maven.plugins.pmd"><code>ExcludeDuplicationsFromFile</code></a>.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="execute()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>execute</h4> +<pre>public void execute() + throws <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>, + <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></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/MojoExecutionException.html?is-external=true" title="class or interface in org.apache.maven.plugin">MojoExecutionException</a></code></dd> +<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></dl> +</li> +</ul> +<a name="printError(org.apache.maven.plugins.pmd.model.Duplication, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printError</h4> +<pre>protected void printError(<a href="../../../../../org/apache/maven/plugins/pmd/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#printError(D,%20java.lang.String)">printError</a></code> in class <code><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="class in org.apache.maven.plugins.pmd">AbstractPmdViolationCheckMojo</a><<a href="../../../../../org/apache/maven/plugins/pmd/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</a>></code></dd> +<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 <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/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</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> cpdFile) + 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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#getErrorDetails(java.io.File)">getErrorDetails</a></code> in class <code><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="class in org.apache.maven.plugins.pmd">AbstractPmdViolationCheckMojo</a><<a href="../../../../../org/apache/maven/plugins/pmd/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>cpdFile</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="getPriority(org.apache.maven.plugins.pmd.model.Duplication)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPriority</h4> +<pre>protected int getPriority(<a href="../../../../../org/apache/maven/plugins/pmd/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</a> errorDetail)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#getPriority(D)">getPriority</a></code> in class <code><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="class in org.apache.maven.plugins.pmd">AbstractPmdViolationCheckMojo</a><<a href="../../../../../org/apache/maven/plugins/pmd/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</a>></code></dd> +</dl> +</li> +</ul> +<a name="newViolationDetailsInstance()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>newViolationDetailsInstance</h4> +<pre>protected <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/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</a>> newViolationDetailsInstance()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#newViolationDetailsInstance()">newViolationDetailsInstance</a></code> in class <code><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="class in org.apache.maven.plugins.pmd">AbstractPmdViolationCheckMojo</a><<a href="../../../../../org/apache/maven/plugins/pmd/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</a>></code></dd> +</dl> +</li> +</ul> +<a name="isFailOnViolation()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isFailOnViolation</h4> +<pre>public boolean isFailOnViolation()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html#isFailOnViolation()">isFailOnViolation</a></code> in class <code><a href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdViolationCheckMojo.html" title="class in org.apache.maven.plugins.pmd">AbstractPmdViolationCheckMojo</a><<a href="../../../../../org/apache/maven/plugins/pmd/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</a>></code></dd> +</dl> +</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/CpdViolationCheckMojo.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/CpdReportGenerator.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/ExcludeDuplicationsFromFile.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/CpdViolationCheckMojo.html" target="_top">Frames</a></li> +<li><a href="CpdViolationCheckMojo.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