You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by ad...@apache.org on 2016/10/08 16:53:16 UTC
svn commit: r999063 [24/26] - in
/websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST:
./ apidocs/ apidocs/org/apache/maven/plugin/pmd/
apidocs/org/apache/maven/plugin/pmd/class-use/
apidocs/org/apache/maven/plugin/pmd/model/ ...
Added: websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugin/pmd/PmdCollectingRenderer.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugin/pmd/PmdCollectingRenderer.html (added)
+++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugin/pmd/PmdCollectingRenderer.html Sat Oct 8 16:53:12 2016
@@ -0,0 +1,165 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+<title>PmdCollectingRenderer xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugin/pmd/PmdCollectingRenderer.html">View Javadoc</a></div><pre>
+<a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugin.pmd;
+<a class="jxr_linenumber" name="L2" href="#L2">2</a>
+<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
+<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
+<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
+<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
+<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
+<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
+<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
+<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
+<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
+<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
+<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
+<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
+<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
+<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * under the License.</em>
+<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="L21" href="#L21">21</a>
+<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
+<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
+<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Collections;
+<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
+<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="L27" href="#L27">27</a>
+<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.Report;
+<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.Report.ProcessingError;
+<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.RuleViolation;
+<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.renderers.AbstractRenderer;
+<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> net.sourceforge.pmd.util.datasource.DataSource;
+<a class="jxr_linenumber" name="L33" href="#L33">33</a>
+<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils;
+<a class="jxr_linenumber" name="L35" href="#L35">35</a>
+<a class="jxr_linenumber" name="L36" href="#L36">36</a>
+<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * A PMD renderer, that collects all violations and processing errors</em>
+<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * from a pmd execution.</em>
+<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * </em>
+<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * @author Andreas Dangel</em>
+<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdCollectingRenderer.html">PmdCollectingRenderer</a> <strong class="jxr_keyword">extends</strong> AbstractRenderer
+<a class="jxr_linenumber" name="L44" href="#L44">44</a> {
+<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">private</strong> List<ProcessingError> errors = Collections.synchronizedList( <strong class="jxr_keyword">new</strong> ArrayList<ProcessingError>() );
+<a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">private</strong> List<RuleViolation> violations = Collections.synchronizedList( <strong class="jxr_keyword">new</strong> ArrayList<RuleViolation>() );
+<a class="jxr_linenumber" name="L47" href="#L47">47</a>
+<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * Collects all reports from all threads.</em>
+<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/plugin/pmd/PmdCollectingRenderer.html">PmdCollectingRenderer</a>()
+<a class="jxr_linenumber" name="L52" href="#L52">52</a> {
+<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">super</strong>( PmdCollectingRenderer.<strong class="jxr_keyword">class</strong>.getSimpleName(), <span class="jxr_string">"Collects all reports from all threads"</span> );
+<a class="jxr_linenumber" name="L54" href="#L54">54</a> }
+<a class="jxr_linenumber" name="L55" href="#L55">55</a>
+<a class="jxr_linenumber" name="L56" href="#L56">56</a> @Override
+<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> renderFileReport( Report report ) <strong class="jxr_keyword">throws</strong> IOException
+<a class="jxr_linenumber" name="L58" href="#L58">58</a> {
+<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">for</strong> ( RuleViolation v : report )
+<a class="jxr_linenumber" name="L60" href="#L60">60</a> {
+<a class="jxr_linenumber" name="L61" href="#L61">61</a> violations.add( v );
+<a class="jxr_linenumber" name="L62" href="#L62">62</a> }
+<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">for</strong> ( Iterator<ProcessingError> it = report.errors(); it.hasNext(); )
+<a class="jxr_linenumber" name="L64" href="#L64">64</a> {
+<a class="jxr_linenumber" name="L65" href="#L65">65</a> errors.add( it.next() );
+<a class="jxr_linenumber" name="L66" href="#L66">66</a> }
+<a class="jxr_linenumber" name="L67" href="#L67">67</a> }
+<a class="jxr_linenumber" name="L68" href="#L68">68</a>
+<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * Checks whether any violations have been found.</em>
+<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if at least one violations has been found</em>
+<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasViolations()
+<a class="jxr_linenumber" name="L74" href="#L74">74</a> {
+<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">return</strong> !violations.isEmpty();
+<a class="jxr_linenumber" name="L76" href="#L76">76</a> }
+<a class="jxr_linenumber" name="L77" href="#L77">77</a>
+<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * Gets the list of all found violations.</em>
+<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * @return the violations</em>
+<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">public</strong> List<RuleViolation> getViolations()
+<a class="jxr_linenumber" name="L83" href="#L83">83</a> {
+<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">return</strong> violations;
+<a class="jxr_linenumber" name="L85" href="#L85">85</a> }
+<a class="jxr_linenumber" name="L86" href="#L86">86</a>
+<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * Checks whether any processing errors have been found.</em>
+<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if any errors have been found</em>
+<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasErrors()
+<a class="jxr_linenumber" name="L92" href="#L92">92</a> {
+<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">return</strong> !errors.isEmpty();
+<a class="jxr_linenumber" name="L94" href="#L94">94</a> }
+<a class="jxr_linenumber" name="L95" href="#L95">95</a>
+<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * Gets all the processing errors.</em>
+<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * @return the errors</em>
+<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">public</strong> List<ProcessingError> getErrors()
+<a class="jxr_linenumber" name="L101" href="#L101">101</a> {
+<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">return</strong> errors;
+<a class="jxr_linenumber" name="L103" href="#L103">103</a> }
+<a class="jxr_linenumber" name="L104" href="#L104">104</a>
+<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * Gets the errors as a single string. Each error is in its own line.</em>
+<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * @return the errors as string</em>
+<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">public</strong> String getErrorsAsString()
+<a class="jxr_linenumber" name="L110" href="#L110">110</a> {
+<a class="jxr_linenumber" name="L111" href="#L111">111</a> List<String> errorsAsString = <strong class="jxr_keyword">new</strong> ArrayList<>( errors.size() );
+<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">for</strong> ( ProcessingError error : errors )
+<a class="jxr_linenumber" name="L113" href="#L113">113</a> {
+<a class="jxr_linenumber" name="L114" href="#L114">114</a> errorsAsString.add( error.getFile() + <span class="jxr_string">": "</span> + error.getMsg() );
+<a class="jxr_linenumber" name="L115" href="#L115">115</a> }
+<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">return</strong> StringUtils.join( errorsAsString.toArray(), System.getProperty( <span class="jxr_string">"line.separator"</span> ) );
+<a class="jxr_linenumber" name="L117" href="#L117">117</a> }
+<a class="jxr_linenumber" name="L118" href="#L118">118</a>
+<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * Create a new single report with all violations for further rendering into other formats than HTML.</em>
+<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> * @return the report</em>
+<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">public</strong> Report asReport()
+<a class="jxr_linenumber" name="L124" href="#L124">124</a> {
+<a class="jxr_linenumber" name="L125" href="#L125">125</a> Report report = <strong class="jxr_keyword">new</strong> Report();
+<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">for</strong> ( RuleViolation v : violations )
+<a class="jxr_linenumber" name="L127" href="#L127">127</a> {
+<a class="jxr_linenumber" name="L128" href="#L128">128</a> report.addRuleViolation( v );
+<a class="jxr_linenumber" name="L129" href="#L129">129</a> }
+<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">return</strong> report;
+<a class="jxr_linenumber" name="L131" href="#L131">131</a> }
+<a class="jxr_linenumber" name="L132" href="#L132">132</a>
+<a class="jxr_linenumber" name="L133" href="#L133">133</a>
+<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_comment">// stubs need to fulfill the Renderer interface</em>
+<a class="jxr_linenumber" name="L135" href="#L135">135</a> @Override
+<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">public</strong> String defaultFileExtension()
+<a class="jxr_linenumber" name="L137" href="#L137">137</a> {
+<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L139" href="#L139">139</a> }
+<a class="jxr_linenumber" name="L140" href="#L140">140</a> @Override
+<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> start() <strong class="jxr_keyword">throws</strong> IOException
+<a class="jxr_linenumber" name="L142" href="#L142">142</a> {
+<a class="jxr_linenumber" name="L143" href="#L143">143</a> }
+<a class="jxr_linenumber" name="L144" href="#L144">144</a> @Override
+<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> startFileAnalysis( DataSource dataSource )
+<a class="jxr_linenumber" name="L146" href="#L146">146</a> {
+<a class="jxr_linenumber" name="L147" href="#L147">147</a> }
+<a class="jxr_linenumber" name="L148" href="#L148">148</a> @Override
+<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> end() <strong class="jxr_keyword">throws</strong> IOException
+<a class="jxr_linenumber" name="L150" href="#L150">150</a> {
+<a class="jxr_linenumber" name="L151" href="#L151">151</a> }
+<a class="jxr_linenumber" name="L152" href="#L152">152</a> }
+</pre>
+<hr/>
+<div id="footer">Copyright © 2005–2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
+</body>
+</html>
\ No newline at end of file
Modified: websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugin/pmd/PmdFileInfo.html
==============================================================================
--- websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugin/pmd/PmdFileInfo.html (original)
+++ websites/production/maven/components/plugins-archives/maven-pmd-plugin-LATEST/xref/org/apache/maven/plugin/pmd/PmdFileInfo.html Sat Oct 8 16:53:12 2016
@@ -77,6 +77,6 @@
<a class="jxr_linenumber" name="L69" href="#L69">69</a> }
</pre>
<hr/>
-<div id="footer">Copyright © 2005–2015 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
+<div id="footer">Copyright © 2005–2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>
\ No newline at end of file