Added: websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,340 @@ +<!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>ExcludeDuplicationsFromFile (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="ExcludeDuplicationsFromFile (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/ExcludeDuplicationsFromFile.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/CpdViolationCheckMojo.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/ExcludeFromFile.html" title="interface 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/ExcludeDuplicationsFromFile.html" target="_top">Frames</a></li> +<li><a href="ExcludeDuplicationsFromFile.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 ExcludeDuplicationsFromFile" class="title">Class ExcludeDuplicationsFromFile</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.ExcludeDuplicationsFromFile</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><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/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ExcludeDuplicationsFromFile</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> +implements <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/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</a>></pre> +<div class="block">This class contains utility methods to load property files which define which files + should be excluded from the CPD duplication results. + See property <code>pmd.excludeFromFailureFile</code>.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Andreas Dangel</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/ExcludeDuplicationsFromFile.html#ExcludeDuplicationsFromFile()">ExcludeDuplicationsFromFile</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>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html#countExclusions()">countExclusions</a></strong>()</code> +<div class="block">Determines how many exclusions are considered.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html#isExcludedFromFailure(org.apache.maven.plugins.pmd.model.Duplication)">isExcludedFromFailure</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> +<div class="block">Checks whether the given violation is excluded.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html#isExcludedFromFailure(net.sourceforge.pmd.cpd.Match)">isExcludedFromFailure</a></strong>(net.sourceforge.pmd.cpd.Match errorDetail)</code> +<div class="block">Checks whether the given <code>Match</code> is excluded.</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/ExcludeDuplicationsFromFile.html#loadExcludeFromFailuresData(java.lang.String)">loadExcludeFromFailuresData</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> excludeFromFailureFile)</code> +<div class="block">Loads the exclude definitions from the given file.</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="ExcludeDuplicationsFromFile()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ExcludeDuplicationsFromFile</h4> +<pre>public ExcludeDuplicationsFromFile()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isExcludedFromFailure(org.apache.maven.plugins.pmd.model.Duplication)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isExcludedFromFailure</h4> +<pre>public boolean isExcludedFromFailure(<a href="../../../../../org/apache/maven/plugins/pmd/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</a> errorDetail)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#isExcludedFromFailure(D)">ExcludeFromFile</a></code></strong></div> +<div class="block">Checks whether the given violation is excluded. Note: the exclusions must have been + loaded before via <a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#loadExcludeFromFailuresData(java.lang.String)"><code>ExcludeFromFile.loadExcludeFromFailuresData(String)</code></a>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#isExcludedFromFailure(D)">isExcludedFromFailure</a></code> in interface <code><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/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>errorDetail</code> - the violation to check</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the violation should be excluded, <code>false</code> otherwise.</dd></dl> +</li> +</ul> +<a name="isExcludedFromFailure(net.sourceforge.pmd.cpd.Match)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isExcludedFromFailure</h4> +<pre>public boolean isExcludedFromFailure(net.sourceforge.pmd.cpd.Match errorDetail)</pre> +<div class="block">Checks whether the given <code>Match</code> is excluded. + Note: The exclusion must have been loaded before via <a href="../../../../../org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html#loadExcludeFromFailuresData(java.lang.String)"><code>loadExcludeFromFailuresData(String)</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>errorDetail</code> - the duplication to check</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the given duplication should be excluded, <code>false</code> otherwise.</dd></dl> +</li> +</ul> +<a name="loadExcludeFromFailuresData(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadExcludeFromFailuresData</h4> +<pre>public void loadExcludeFromFailuresData(<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) + 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></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#loadExcludeFromFailuresData(java.lang.String)">ExcludeFromFile</a></code></strong></div> +<div class="block">Loads the exclude definitions from the given file.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#loadExcludeFromFailuresData(java.lang.String)">loadExcludeFromFailuresData</a></code> in interface <code><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/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>excludeFromFailureFile</code> - the path to the properties file</dd> +<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> - if the properties file couldn't be loaded</dd></dl> +</li> +</ul> +<a name="countExclusions()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>countExclusions</h4> +<pre>public int countExclusions()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#countExclusions()">ExcludeFromFile</a></code></strong></div> +<div class="block">Determines how many exclusions are considered.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#countExclusions()">countExclusions</a></code> in interface <code><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/model/Duplication.html" title="class in org.apache.maven.plugins.pmd.model">Duplication</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the number of active exclusions</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/ExcludeDuplicationsFromFile.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/CpdViolationCheckMojo.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/ExcludeFromFile.html" title="interface 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/ExcludeDuplicationsFromFile.html" target="_top">Frames</a></li> +<li><a href="ExcludeDuplicationsFromFile.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/ExcludeFromFile.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/ExcludeFromFile.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/ExcludeFromFile.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,259 @@ +<!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>ExcludeFromFile (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="ExcludeFromFile (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/ExcludeFromFile.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/ExcludeDuplicationsFromFile.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/ExcludeViolationsFromFile.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/ExcludeFromFile.html" target="_top">Frames</a></li> +<li><a href="ExcludeFromFile.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface ExcludeFromFile" class="title">Interface ExcludeFromFile<D></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>D</code> - type of violation to exclude, 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 Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeDuplicationsFromFile.html" title="class in org.apache.maven.plugins.pmd">ExcludeDuplicationsFromFile</a>, <a href="../../../../../org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html" title="class in org.apache.maven.plugins.pmd">ExcludeViolationsFromFile</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">ExcludeFromFile<D></span></pre> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Andreas Dangel</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#countExclusions()">countExclusions</a></strong>()</code> +<div class="block">Determines how many exclusions are considered.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#isExcludedFromFailure(D)">isExcludedFromFailure</a></strong>(<a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html" title="type parameter in ExcludeFromFile">D</a> errorDetail)</code> +<div class="block">Checks whether the given violation is excluded.</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/ExcludeFromFile.html#loadExcludeFromFailuresData(java.lang.String)">loadExcludeFromFailuresData</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> excludeFromFailureFile)</code> +<div class="block">Loads the exclude definitions from the given file.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="loadExcludeFromFailuresData(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadExcludeFromFailuresData</h4> +<pre>void loadExcludeFromFailuresData(<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) + 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></pre> +<div class="block">Loads the exclude definitions from the given file.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>excludeFromFailureFile</code> - the path to the properties file</dd> +<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> - if the properties file couldn't be loaded</dd></dl> +</li> +</ul> +<a name="countExclusions()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>countExclusions</h4> +<pre>int countExclusions()</pre> +<div class="block">Determines how many exclusions are considered.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the number of active exclusions</dd></dl> +</li> +</ul> +<a name="isExcludedFromFailure(java.lang.Object)"> +<!-- --> +</a><a name="isExcludedFromFailure(D)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isExcludedFromFailure</h4> +<pre>boolean isExcludedFromFailure(<a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html" title="type parameter in ExcludeFromFile">D</a> errorDetail)</pre> +<div class="block">Checks whether the given violation is excluded. Note: the exclusions must have been + loaded before via <a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#loadExcludeFromFailuresData(java.lang.String)"><code>loadExcludeFromFailuresData(String)</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>errorDetail</code> - the violation to check</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the violation should be excluded, <code>false</code> otherwise.</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/ExcludeFromFile.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/ExcludeDuplicationsFromFile.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/ExcludeViolationsFromFile.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/ExcludeFromFile.html" target="_top">Frames</a></li> +<li><a href="ExcludeFromFile.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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/ExcludeViolationsFromFile.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,340 @@ +<!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>ExcludeViolationsFromFile (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="ExcludeViolationsFromFile (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/ExcludeViolationsFromFile.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/ExcludeFromFile.html" title="interface in org.apache.maven.plugins.pmd"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/maven/plugins/pmd/HelpMojo.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/ExcludeViolationsFromFile.html" target="_top">Frames</a></li> +<li><a href="ExcludeViolationsFromFile.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 ExcludeViolationsFromFile" class="title">Class ExcludeViolationsFromFile</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.ExcludeViolationsFromFile</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><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/model/Violation.html" title="class in org.apache.maven.plugins.pmd.model">Violation</a>></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ExcludeViolationsFromFile</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> +implements <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/model/Violation.html" title="class in org.apache.maven.plugins.pmd.model">Violation</a>></pre> +<div class="block">This class contains utility for loading property files, which define which PMD violations + from which classes should be ignored and not cause a failure. + See property <code>pmd.excludeFromFailureFile</code>.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>Andreas Dangel</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/ExcludeViolationsFromFile.html#ExcludeViolationsFromFile()">ExcludeViolationsFromFile</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>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html#countExclusions()">countExclusions</a></strong>()</code> +<div class="block">Determines how many exclusions are considered.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html#isExcludedFromFailure(net.sourceforge.pmd.RuleViolation)">isExcludedFromFailure</a></strong>(net.sourceforge.pmd.RuleViolation errorDetail)</code> +<div class="block">Checks whether the given <code>RuleViolation</code> is excluded.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html#isExcludedFromFailure(org.apache.maven.plugins.pmd.model.Violation)">isExcludedFromFailure</a></strong>(<a href="../../../../../org/apache/maven/plugins/pmd/model/Violation.html" title="class in org.apache.maven.plugins.pmd.model">Violation</a> errorDetail)</code> +<div class="block">Checks whether the given violation is excluded.</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/ExcludeViolationsFromFile.html#loadExcludeFromFailuresData(java.lang.String)">loadExcludeFromFailuresData</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> excludeFromFailureFile)</code> +<div class="block">Loads the exclude definitions from the given file.</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="ExcludeViolationsFromFile()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ExcludeViolationsFromFile</h4> +<pre>public ExcludeViolationsFromFile()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="loadExcludeFromFailuresData(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>loadExcludeFromFailuresData</h4> +<pre>public void loadExcludeFromFailuresData(<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) + 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></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#loadExcludeFromFailuresData(java.lang.String)">ExcludeFromFile</a></code></strong></div> +<div class="block">Loads the exclude definitions from the given file.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#loadExcludeFromFailuresData(java.lang.String)">loadExcludeFromFailuresData</a></code> in interface <code><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/model/Violation.html" title="class in org.apache.maven.plugins.pmd.model">Violation</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>excludeFromFailureFile</code> - the path to the properties file</dd> +<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> - if the properties file couldn't be loaded</dd></dl> +</li> +</ul> +<a name="isExcludedFromFailure(org.apache.maven.plugins.pmd.model.Violation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isExcludedFromFailure</h4> +<pre>public boolean isExcludedFromFailure(<a href="../../../../../org/apache/maven/plugins/pmd/model/Violation.html" title="class in org.apache.maven.plugins.pmd.model">Violation</a> errorDetail)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#isExcludedFromFailure(D)">ExcludeFromFile</a></code></strong></div> +<div class="block">Checks whether the given violation is excluded. Note: the exclusions must have been + loaded before via <a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#loadExcludeFromFailuresData(java.lang.String)"><code>ExcludeFromFile.loadExcludeFromFailuresData(String)</code></a>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#isExcludedFromFailure(D)">isExcludedFromFailure</a></code> in interface <code><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/model/Violation.html" title="class in org.apache.maven.plugins.pmd.model">Violation</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>errorDetail</code> - the violation to check</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the violation should be excluded, <code>false</code> otherwise.</dd></dl> +</li> +</ul> +<a name="isExcludedFromFailure(net.sourceforge.pmd.RuleViolation)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isExcludedFromFailure</h4> +<pre>public boolean isExcludedFromFailure(net.sourceforge.pmd.RuleViolation errorDetail)</pre> +<div class="block">Checks whether the given <code>RuleViolation</code> is excluded. Note: the exclusions must have been + loaded before via <a href="../../../../../org/apache/maven/plugins/pmd/ExcludeViolationsFromFile.html#loadExcludeFromFailuresData(java.lang.String)"><code>loadExcludeFromFailuresData(String)</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>errorDetail</code> - the violation to check</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the violation should be excluded, <code>false</code> otherwise.</dd></dl> +</li> +</ul> +<a name="countExclusions()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>countExclusions</h4> +<pre>public int countExclusions()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#countExclusions()">ExcludeFromFile</a></code></strong></div> +<div class="block">Determines how many exclusions are considered.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/maven/plugins/pmd/ExcludeFromFile.html#countExclusions()">countExclusions</a></code> in interface <code><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/model/Violation.html" title="class in org.apache.maven.plugins.pmd.model">Violation</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the number of active exclusions</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/ExcludeViolationsFromFile.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/ExcludeFromFile.html" title="interface in org.apache.maven.plugins.pmd"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/maven/plugins/pmd/HelpMojo.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/ExcludeViolationsFromFile.html" target="_top">Frames</a></li> +<li><a href="ExcludeViolationsFromFile.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/HelpMojo.html ============================================================================== --- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/HelpMojo.html (added) +++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/apidocs/org/apache/maven/plugins/pmd/HelpMojo.html Sun Jan 21 17:23:18 2018 @@ -0,0 +1,297 @@ +<!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>HelpMojo (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="HelpMojo (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/HelpMojo.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/ExcludeViolationsFromFile.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/PmdCollectingRenderer.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/HelpMojo.html" target="_top">Frames</a></li> +<li><a href="HelpMojo.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 HelpMojo" class="title">Class HelpMojo</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.HelpMojo</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>="help", + <a href="http://maven.apache.org/plugin-tools/maven-plugin-annotations/apidocs/org/apache/maven/plugins/annotations/Mojo.html?is-external=true#requiresProject()" title="class or interface in org.apache.maven.plugins.annotations">requiresProject</a>=false, + <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">HelpMojo</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">Display help information on maven-pmd-plugin.<br> + Call <code>mvn pmd:help -Ddetail=true -Dgoal=<goal-name></code> to display parameter details.</div> +<dl><dt><span class="strong">Author:</span></dt> + <dd>maven-plugin-tools</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.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/HelpMojo.html#HelpMojo()">HelpMojo</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/maven/plugins/pmd/HelpMojo.html#execute()">execute</a></strong>()</code></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> +</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="HelpMojo()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HelpMojo</h4> +<pre>public HelpMojo()</pre> +</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="blockListLast"> +<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></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></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/HelpMojo.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/ExcludeViolationsFromFile.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/PmdCollectingRenderer.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/HelpMojo.html" target="_top">Frames</a></li> +<li><a href="HelpMojo.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