Modified: maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref-test/org/apache/maven/plugins/pmd/AbstractPmdReportTestCase.html ============================================================================== --- maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref-test/org/apache/maven/plugins/pmd/AbstractPmdReportTestCase.html (original) +++ maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref-test/org/apache/maven/plugins/pmd/AbstractPmdReportTestCase.html Fri May 12 20:25:56 2023 @@ -6,174 +6,158 @@ </head> <body> <div id="overview"><a href="../../../../../../testapidocs/org/apache/maven/plugins/pmd/AbstractPmdReportTestCase.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.plugins.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="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></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.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></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.File; -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.nio.file.Files; -<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.Locale; -<a class="jxr_linenumber" name="L26" href="#L26">26</a> -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.LegacySupport; -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.testing.AbstractMojoTestCase; -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.testing.ArtifactStubFactory; -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.testing.stubs.MavenProjectStub; -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.DefaultProjectBuildingRequest; -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.ProjectBuilder; -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.ProjectBuildingRequest; -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.DefaultRepositorySystemSession; -<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.internal.impl.SimpleLocalRepositoryManagerFactory; -<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.repository.LocalRepository; -<a class="jxr_linenumber" name="L38" href="#L38">38</a> -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:vincent.sive...@gmail.com"; target="alexandria_uri">mailto:vincent.sive...@gmail.com</a>">Vincent Siveton</a></em> -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * @version $Id$</em> -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * @since 2.5</em> -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractPmdReportTestCase" href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReportTestCase.html#AbstractPmdReportTestCase">AbstractPmdReportTestCase</a> -<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">extends</strong> AbstractMojoTestCase -<a class="jxr_linenumber" name="L46" href="#L46">46</a> { -<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">private</strong> ArtifactStubFactory artifactStubFactory; -<a class="jxr_linenumber" name="L48" href="#L48">48</a> -<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> * The current project to be test.</em> -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">private</strong> MavenProject testMavenProject; -<a class="jxr_linenumber" name="L53" href="#L53">53</a> -<a class="jxr_linenumber" name="L54" href="#L54">54</a> @Override -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setUp() -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">throws</strong> Exception -<a class="jxr_linenumber" name="L57" href="#L57">57</a> { -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">super</strong>.setUp(); -<a class="jxr_linenumber" name="L59" href="#L59">59</a> CapturingPrintStream.init( <strong class="jxr_keyword">true</strong> ); -<a class="jxr_linenumber" name="L60" href="#L60">60</a> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> artifactStubFactory = <strong class="jxr_keyword">new</strong> <a name="DependencyArtifactStubFactory" href="../../../../../org/apache/maven/plugins/pmd/DependencyArtifactStubFactory.html#DependencyArtifactStubFactory">DependencyArtifactStubFactory</a>( getTestFile( <span class="jxr_string">"target"</span> ), <strong class="jxr_keyword">true</strong>, false ); -<a class="jxr_linenumber" name="L62" href="#L62">62</a> artifactStubFactory.getWorkingDir().mkdirs(); -<a class="jxr_linenumber" name="L63" href="#L63">63</a> } -<a class="jxr_linenumber" name="L64" href="#L64">64</a> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * Get the current Maven project</em> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> * @return the maven project</em> -<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> <strong class="jxr_keyword">protected</strong> MavenProject getTestMavenProject() -<a class="jxr_linenumber" name="L71" href="#L71">71</a> { -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">return</strong> testMavenProject; -<a class="jxr_linenumber" name="L73" href="#L73">73</a> } -<a class="jxr_linenumber" name="L74" href="#L74">74</a> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * Get the generated report as file in the test maven project.</em> -<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * @param name the name of the report.</em> -<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @return the generated report as file</em> -<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * @throws IOException if the return file doesnt exist</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">protected</strong> File getGeneratedReport( String name ) -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">throws</strong> IOException -<a class="jxr_linenumber" name="L84" href="#L84">84</a> { -<a class="jxr_linenumber" name="L85" href="#L85">85</a> String outputDirectory = getBasedir() + <span class="jxr_string">"/target/test/unit/"</span> + getTestMavenProject().getArtifactId(); -<a class="jxr_linenumber" name="L86" href="#L86">86</a> -<a class="jxr_linenumber" name="L87" href="#L87">87</a> File report = <strong class="jxr_keyword">new</strong> File( outputDirectory, name ); -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">if</strong> ( !report.exists() ) -<a class="jxr_linenumber" name="L89" href="#L89">89</a> { -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException( <span class="jxr_string">"File not found. Attempted: "</span> + report ); -<a class="jxr_linenumber" name="L91" href="#L91">91</a> } -<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> report; -<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"> * Generate the report and return the generated file</em> -<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * @param goal the mojo goal.</em> -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * @param pluginXml the name of the xml file in "src/test/resources/plugin-configs/".</em> -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * @return the generated HTML file</em> -<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * @throws Exception if any</em> -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">protected</strong> File generateReport( String goal, String pluginXml ) -<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">throws</strong> Exception -<a class="jxr_linenumber" name="L106" href="#L106">106</a> { -<a class="jxr_linenumber" name="L107" href="#L107">107</a> File pluginXmlFile = <strong class="jxr_keyword">new</strong> File( getBasedir(), <span class="jxr_string">"src/test/resources/unit/"</span> + pluginXml ); -<a class="jxr_linenumber" name="L108" href="#L108">108</a> AbstractPmdReport mojo = createReportMojo( goal, pluginXmlFile ); -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">return</strong> generateReport( mojo, pluginXmlFile ); -<a class="jxr_linenumber" name="L110" href="#L110">110</a> } -<a class="jxr_linenumber" name="L111" href="#L111">111</a> -<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">protected</strong> AbstractPmdReport createReportMojo( String goal, File pluginXmlFile ) -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">throws</strong> Exception -<a class="jxr_linenumber" name="L114" href="#L114">114</a> { -<a class="jxr_linenumber" name="L115" href="#L115">115</a> AbstractPmdReport mojo = (AbstractPmdReport) lookupMojo( goal, pluginXmlFile ); -<a class="jxr_linenumber" name="L116" href="#L116">116</a> assertNotNull( <span class="jxr_string">"Mojo not found."</span>, mojo ); +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.pmd; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.File; +<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.nio.file.Files; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Locale; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.LegacySupport; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.testing.AbstractMojoTestCase; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.testing.ArtifactStubFactory; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.testing.stubs.MavenProjectStub; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.DefaultProjectBuildingRequest; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.ProjectBuilder; +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.ProjectBuildingRequest; +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.DefaultRepositorySystemSession; +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.internal.impl.SimpleLocalRepositoryManagerFactory; +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.eclipse.aether.repository.LocalRepository; +<a class="jxr_linenumber" name="L37" href="#L37">37</a> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:vincent.sive...@gmail.com"; target="alexandria_uri">mailto:vincent.sive...@gmail.com</a>">Vincent Siveton</a></em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * @version $Id$</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * @since 2.5</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">abstract</strong> <strong class="jxr_keyword">class</strong> <a name="AbstractPmdReportTestCase" href="../../../../../org/apache/maven/plugins/pmd/AbstractPmdReportTestCase.html#AbstractPmdReportTestCase">AbstractPmdReportTestCase</a> <strong class="jxr_keyword">extends</strong> AbstractMojoTestCase { +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">private</strong> ArtifactStubFactory artifactStubFactory; +<a class="jxr_linenumber" name="L45" href="#L45">45</a> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * The current project to be test.</em> +<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> <strong class="jxr_keyword">private</strong> MavenProject testMavenProject; +<a class="jxr_linenumber" name="L50" href="#L50">50</a> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> @Override +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setUp() <strong class="jxr_keyword">throws</strong> Exception { +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">super</strong>.setUp(); +<a class="jxr_linenumber" name="L54" href="#L54">54</a> CapturingPrintStream.init(<strong class="jxr_keyword">true</strong>); +<a class="jxr_linenumber" name="L55" href="#L55">55</a> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> artifactStubFactory = <strong class="jxr_keyword">new</strong> <a name="DependencyArtifactStubFactory" href="../../../../../org/apache/maven/plugins/pmd/DependencyArtifactStubFactory.html#DependencyArtifactStubFactory">DependencyArtifactStubFactory</a>(getTestFile(<span class="jxr_string">"target"</span>), <strong class="jxr_keyword">true</strong>, false); +<a class="jxr_linenumber" name="L57" href="#L57">57</a> artifactStubFactory.getWorkingDir().mkdirs(); +<a class="jxr_linenumber" name="L58" href="#L58">58</a> } +<a class="jxr_linenumber" name="L59" href="#L59">59</a> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> * Get the current Maven project</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * @return the maven project</em> +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">protected</strong> MavenProject getTestMavenProject() { +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">return</strong> testMavenProject; +<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"> * Get the generated report as file in the test maven project.</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * @param name the name of the report.</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * @return the generated report as file</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * @throws IOException if the return file doesnt exist</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">protected</strong> File getGeneratedReport(String name) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L77" href="#L77">77</a> String outputDirectory = +<a class="jxr_linenumber" name="L78" href="#L78">78</a> getBasedir() + <span class="jxr_string">"/target/test/unit/"</span> + getTestMavenProject().getArtifactId(); +<a class="jxr_linenumber" name="L79" href="#L79">79</a> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> File report = <strong class="jxr_keyword">new</strong> File(outputDirectory, name); +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">if</strong> (!report.exists()) { +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(<span class="jxr_string">"File not found. Attempted: "</span> + report); +<a class="jxr_linenumber" name="L83" href="#L83">83</a> } +<a class="jxr_linenumber" name="L84" href="#L84">84</a> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">return</strong> report; +<a class="jxr_linenumber" name="L86" href="#L86">86</a> } +<a class="jxr_linenumber" name="L87" href="#L87">87</a> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * Generate the report and return the generated file</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> <em class="jxr_javadoccomment"> * @param goal the mojo goal.</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * @param pluginXml the name of the xml file in "src/test/resources/plugin-configs/".</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * @return the generated HTML file</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @throws Exception if any</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">protected</strong> File generateReport(String goal, String pluginXml) <strong class="jxr_keyword">throws</strong> Exception { +<a class="jxr_linenumber" name="L97" href="#L97">97</a> File pluginXmlFile = <strong class="jxr_keyword">new</strong> File(getBasedir(), <span class="jxr_string">"src/test/resources/unit/"</span> + pluginXml); +<a class="jxr_linenumber" name="L98" href="#L98">98</a> AbstractPmdReport mojo = createReportMojo(goal, pluginXmlFile); +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">return</strong> generateReport(mojo, pluginXmlFile); +<a class="jxr_linenumber" name="L100" href="#L100">100</a> } +<a class="jxr_linenumber" name="L101" href="#L101">101</a> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">protected</strong> AbstractPmdReport createReportMojo(String goal, File pluginXmlFile) <strong class="jxr_keyword">throws</strong> Exception { +<a class="jxr_linenumber" name="L103" href="#L103">103</a> AbstractPmdReport mojo = (AbstractPmdReport) lookupMojo(goal, pluginXmlFile); +<a class="jxr_linenumber" name="L104" href="#L104">104</a> assertNotNull(<span class="jxr_string">"Mojo not found."</span>, mojo); +<a class="jxr_linenumber" name="L105" href="#L105">105</a> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> LegacySupport legacySupport = lookup(LegacySupport.<strong class="jxr_keyword">class</strong>); +<a class="jxr_linenumber" name="L107" href="#L107">107</a> legacySupport.setSession(newMavenSession(<strong class="jxr_keyword">new</strong> MavenProjectStub())); +<a class="jxr_linenumber" name="L108" href="#L108">108</a> DefaultRepositorySystemSession repoSession = +<a class="jxr_linenumber" name="L109" href="#L109">109</a> (DefaultRepositorySystemSession) legacySupport.getRepositorySession(); +<a class="jxr_linenumber" name="L110" href="#L110">110</a> repoSession.setLocalRepositoryManager(<strong class="jxr_keyword">new</strong> SimpleLocalRepositoryManagerFactory() +<a class="jxr_linenumber" name="L111" href="#L111">111</a> .newInstance(repoSession, <strong class="jxr_keyword">new</strong> LocalRepository(artifactStubFactory.getWorkingDir()))); +<a class="jxr_linenumber" name="L112" href="#L112">112</a> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> setVariableValueToObject(mojo, <span class="jxr_string">"session"</span>, legacySupport.getSession()); +<a class="jxr_linenumber" name="L114" href="#L114">114</a> setVariableValueToObject(mojo, <span class="jxr_string">"remoteRepositories"</span>, mojo.getProject().getRemoteArtifactRepositories()); +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">return</strong> mojo; +<a class="jxr_linenumber" name="L116" href="#L116">116</a> } <a class="jxr_linenumber" name="L117" href="#L117">117</a> -<a class="jxr_linenumber" name="L118" href="#L118">118</a> LegacySupport legacySupport = lookup( LegacySupport.<strong class="jxr_keyword">class</strong> ); -<a class="jxr_linenumber" name="L119" href="#L119">119</a> legacySupport.setSession( newMavenSession( <strong class="jxr_keyword">new</strong> MavenProjectStub() ) ); -<a class="jxr_linenumber" name="L120" href="#L120">120</a> DefaultRepositorySystemSession repoSession = -<a class="jxr_linenumber" name="L121" href="#L121">121</a> (DefaultRepositorySystemSession) legacySupport.getRepositorySession(); -<a class="jxr_linenumber" name="L122" href="#L122">122</a> repoSession.setLocalRepositoryManager( <strong class="jxr_keyword">new</strong> SimpleLocalRepositoryManagerFactory().newInstance( repoSession, <strong class="jxr_keyword">new</strong> LocalRepository( artifactStubFactory.getWorkingDir() ) ) ); -<a class="jxr_linenumber" name="L123" href="#L123">123</a> -<a class="jxr_linenumber" name="L124" href="#L124">124</a> setVariableValueToObject( mojo, <span class="jxr_string">"session"</span>, legacySupport.getSession() ); -<a class="jxr_linenumber" name="L125" href="#L125">125</a> setVariableValueToObject( mojo, <span class="jxr_string">"remoteRepositories"</span>, mojo.getProject().getRemoteArtifactRepositories() ); -<a class="jxr_linenumber" name="L126" href="#L126">126</a> <strong class="jxr_keyword">return</strong> mojo; -<a class="jxr_linenumber" name="L127" href="#L127">127</a> } -<a class="jxr_linenumber" name="L128" href="#L128">128</a> -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">protected</strong> File generateReport( AbstractPmdReport mojo, File pluginXmlFile ) -<a class="jxr_linenumber" name="L130" href="#L130">130</a> <strong class="jxr_keyword">throws</strong> Exception -<a class="jxr_linenumber" name="L131" href="#L131">131</a> { -<a class="jxr_linenumber" name="L132" href="#L132">132</a> mojo.execute(); +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">protected</strong> File generateReport(AbstractPmdReport mojo, File pluginXmlFile) <strong class="jxr_keyword">throws</strong> Exception { +<a class="jxr_linenumber" name="L119" href="#L119">119</a> mojo.execute(); +<a class="jxr_linenumber" name="L120" href="#L120">120</a> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> ProjectBuilder builder = lookup(ProjectBuilder.<strong class="jxr_keyword">class</strong>); +<a class="jxr_linenumber" name="L122" href="#L122">122</a> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> ProjectBuildingRequest buildingRequest = <strong class="jxr_keyword">new</strong> DefaultProjectBuildingRequest(); +<a class="jxr_linenumber" name="L124" href="#L124">124</a> buildingRequest.setRepositorySession(lookup(LegacySupport.<strong class="jxr_keyword">class</strong>).getRepositorySession()); +<a class="jxr_linenumber" name="L125" href="#L125">125</a> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> testMavenProject = builder.build(pluginXmlFile, buildingRequest).getProject(); +<a class="jxr_linenumber" name="L127" href="#L127">127</a> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> File outputDir = mojo.getReportOutputDirectory(); +<a class="jxr_linenumber" name="L129" href="#L129">129</a> String filename = mojo.getOutputName() + <span class="jxr_string">".html"</span>; +<a class="jxr_linenumber" name="L130" href="#L130">130</a> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> File(outputDir, filename); +<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> ProjectBuilder builder = lookup( ProjectBuilder.<strong class="jxr_keyword">class</strong> ); -<a class="jxr_linenumber" name="L135" href="#L135">135</a> -<a class="jxr_linenumber" name="L136" href="#L136">136</a> ProjectBuildingRequest buildingRequest = <strong class="jxr_keyword">new</strong> DefaultProjectBuildingRequest(); -<a class="jxr_linenumber" name="L137" href="#L137">137</a> buildingRequest.setRepositorySession( lookup( LegacySupport.<strong class="jxr_keyword">class</strong> ).getRepositorySession() ); -<a class="jxr_linenumber" name="L138" href="#L138">138</a> -<a class="jxr_linenumber" name="L139" href="#L139">139</a> testMavenProject = builder.build( pluginXmlFile, buildingRequest ).getProject(); +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment"> * Read the contents of the specified file object into a string</em> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">protected</strong> String readFile(File pmdTestDir, String fileName) <strong class="jxr_keyword">throws</strong> IOException { +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> String(Files.readAllBytes(pmdTestDir.toPath().resolve(fileName))); +<a class="jxr_linenumber" name="L139" href="#L139">139</a> } <a class="jxr_linenumber" name="L140" href="#L140">140</a> -<a class="jxr_linenumber" name="L141" href="#L141">141</a> File outputDir = mojo.getReportOutputDirectory(); -<a class="jxr_linenumber" name="L142" href="#L142">142</a> String filename = mojo.getOutputName() + <span class="jxr_string">".html"</span>; -<a class="jxr_linenumber" name="L143" href="#L143">143</a> -<a class="jxr_linenumber" name="L144" href="#L144">144</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> File( outputDir, filename ); -<a class="jxr_linenumber" name="L145" href="#L145">145</a> } -<a class="jxr_linenumber" name="L146" href="#L146">146</a> -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> * Read the contents of the specified file object into a string</em> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">protected</strong> String readFile( File pmdTestDir, String fileName ) <strong class="jxr_keyword">throws</strong> IOException -<a class="jxr_linenumber" name="L151" href="#L151">151</a> { -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> String( Files.readAllBytes( pmdTestDir.toPath().resolve( fileName ) ) ); -<a class="jxr_linenumber" name="L153" href="#L153">153</a> } -<a class="jxr_linenumber" name="L154" href="#L154">154</a> -<a class="jxr_linenumber" name="L155" href="#L155">155</a> -<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment"> * Checks, whether the string <code>contained</code> is contained in</em> -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * the given <code>text</code> ignoring case.</em> -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> * @param text the string in which the search is executed</em> -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * @param contains the string, the should be searched</em> -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the string is contained, otherwise <code>false</code>.</em> -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> lowerCaseContains( String text, String contains ) -<a class="jxr_linenumber" name="L165" href="#L165">165</a> { -<a class="jxr_linenumber" name="L166" href="#L166">166</a> <strong class="jxr_keyword">return</strong> text.toLowerCase( Locale.ROOT ).contains( contains.toLowerCase( Locale.ROOT ) ); -<a class="jxr_linenumber" name="L167" href="#L167">167</a> } -<a class="jxr_linenumber" name="L168" href="#L168">168</a> } +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> * Checks, whether the string <code>contained</code> is contained in</em> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * the given <code>text</code> ignoring case.</em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * @param text the string in which the search is executed</em> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * @param contains the string, the should be searched</em> +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the string is contained, otherwise <code>false</code>.</em> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> lowerCaseContains(String text, String contains) { +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">return</strong> text.toLowerCase(Locale.ROOT).contains(contains.toLowerCase(Locale.ROOT)); +<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–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div>
Modified: maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref-test/org/apache/maven/plugins/pmd/CapturingPrintStream.html ============================================================================== --- maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref-test/org/apache/maven/plugins/pmd/CapturingPrintStream.html (original) +++ maven/website/components/plugins-archives/maven-pmd-plugin-LATEST/xref-test/org/apache/maven/plugins/pmd/CapturingPrintStream.html Fri May 12 20:25:56 2023 @@ -6,89 +6,78 @@ </head> <body> <div id="overview"><a href="../../../../../../testapidocs/org/apache/maven/plugins/pmd/CapturingPrintStream.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.plugins.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="L1" href="#L1">1</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></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.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></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.PrintStream; -<a class="jxr_linenumber" name="L23" href="#L23">23</a> -<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.slf4j.impl.MavenSlf4jSimpleFriend; -<a class="jxr_linenumber" name="L25" href="#L25">25</a> -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * Captures log output from simple slf4j for asserting in unit tests.</em> -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">class</strong> <a name="CapturingPrintStream" href="../../../../../org/apache/maven/plugins/pmd/CapturingPrintStream.html#CapturingPrintStream">CapturingPrintStream</a> <strong class="jxr_keyword">extends</strong> PrintStream { -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> quiet; -<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">private</strong> StringBuilder buffer = <strong class="jxr_keyword">new</strong> StringBuilder(); -<a class="jxr_linenumber" name="L32" href="#L32">32</a> -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">private</strong> <a name="CapturingPrintStream" href="../../../../../org/apache/maven/plugins/pmd/CapturingPrintStream.html#CapturingPrintStream">CapturingPrintStream</a>( <strong class="jxr_keyword">boolean</strong> quiet ) { -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">super</strong>( System.out, <strong class="jxr_keyword">true</strong> ); -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">this</strong>.quiet = quiet; -<a class="jxr_linenumber" name="L36" href="#L36">36</a> } -<a class="jxr_linenumber" name="L37" href="#L37">37</a> -<a class="jxr_linenumber" name="L38" href="#L38">38</a> @Override -<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> println( String x ) -<a class="jxr_linenumber" name="L40" href="#L40">40</a> { -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">if</strong> ( !quiet ) -<a class="jxr_linenumber" name="L42" href="#L42">42</a> { -<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">super</strong>.println( x ); -<a class="jxr_linenumber" name="L44" href="#L44">44</a> } -<a class="jxr_linenumber" name="L45" href="#L45">45</a> buffer.append( x ).append( System.lineSeparator() ); -<a class="jxr_linenumber" name="L46" href="#L46">46</a> } -<a class="jxr_linenumber" name="L47" href="#L47">47</a> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> init( <strong class="jxr_keyword">boolean</strong> quiet ) -<a class="jxr_linenumber" name="L49" href="#L49">49</a> { -<a class="jxr_linenumber" name="L50" href="#L50">50</a> <a name="CapturingPrintStream" href="../../../../../org/apache/maven/plugins/pmd/CapturingPrintStream.html#CapturingPrintStream">CapturingPrintStream</a> capture = get(); -<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">if</strong> ( capture != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L52" href="#L52">52</a> { -<a class="jxr_linenumber" name="L53" href="#L53">53</a> capture.buffer.setLength( 0 ); -<a class="jxr_linenumber" name="L54" href="#L54">54</a> capture.quiet = quiet; -<a class="jxr_linenumber" name="L55" href="#L55">55</a> } -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">else</strong> -<a class="jxr_linenumber" name="L57" href="#L57">57</a> { -<a class="jxr_linenumber" name="L58" href="#L58">58</a> capture = <strong class="jxr_keyword">new</strong> <a name="CapturingPrintStream" href="../../../../../org/apache/maven/plugins/pmd/CapturingPrintStream.html#CapturingPrintStream">CapturingPrintStream</a>( quiet ); -<a class="jxr_linenumber" name="L59" href="#L59">59</a> System.setOut( capture ); -<a class="jxr_linenumber" name="L60" href="#L60">60</a> MavenSlf4jSimpleFriend.init(); -<a class="jxr_linenumber" name="L61" href="#L61">61</a> } +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugins.pmd; +<a class="jxr_linenumber" name="L20" href="#L20">20</a> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.io.PrintStream; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.slf4j.impl.MavenSlf4jSimpleFriend; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * Captures log output from simple slf4j for asserting in unit tests.</em> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">class</strong> <a name="CapturingPrintStream" href="../../../../../org/apache/maven/plugins/pmd/CapturingPrintStream.html#CapturingPrintStream">CapturingPrintStream</a> <strong class="jxr_keyword">extends</strong> PrintStream { +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> quiet; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">private</strong> StringBuilder buffer = <strong class="jxr_keyword">new</strong> StringBuilder(); +<a class="jxr_linenumber" name="L31" href="#L31">31</a> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">private</strong> <a name="CapturingPrintStream" href="../../../../../org/apache/maven/plugins/pmd/CapturingPrintStream.html#CapturingPrintStream">CapturingPrintStream</a>(<strong class="jxr_keyword">boolean</strong> quiet) { +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">super</strong>(System.out, <strong class="jxr_keyword">true</strong>); +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">this</strong>.quiet = quiet; +<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> @Override +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> println(String x) { +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">if</strong> (!quiet) { +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">super</strong>.println(x); +<a class="jxr_linenumber" name="L41" href="#L41">41</a> } +<a class="jxr_linenumber" name="L42" href="#L42">42</a> buffer.append(x).append(System.lineSeparator()); +<a class="jxr_linenumber" name="L43" href="#L43">43</a> } +<a class="jxr_linenumber" name="L44" href="#L44">44</a> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> init(<strong class="jxr_keyword">boolean</strong> quiet) { +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <a name="CapturingPrintStream" href="../../../../../org/apache/maven/plugins/pmd/CapturingPrintStream.html#CapturingPrintStream">CapturingPrintStream</a> capture = get(); +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">if</strong> (capture != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L48" href="#L48">48</a> capture.buffer.setLength(0); +<a class="jxr_linenumber" name="L49" href="#L49">49</a> capture.quiet = quiet; +<a class="jxr_linenumber" name="L50" href="#L50">50</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L51" href="#L51">51</a> capture = <strong class="jxr_keyword">new</strong> <a name="CapturingPrintStream" href="../../../../../org/apache/maven/plugins/pmd/CapturingPrintStream.html#CapturingPrintStream">CapturingPrintStream</a>(quiet); +<a class="jxr_linenumber" name="L52" href="#L52">52</a> System.setOut(capture); +<a class="jxr_linenumber" name="L53" href="#L53">53</a> MavenSlf4jSimpleFriend.init(); +<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> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a name="CapturingPrintStream" href="../../../../../org/apache/maven/plugins/pmd/CapturingPrintStream.html#CapturingPrintStream">CapturingPrintStream</a> get() { +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">if</strong> (System.out instanceof <a name="CapturingPrintStream" href="../../../../../org/apache/maven/plugins/pmd/CapturingPrintStream.html#CapturingPrintStream">CapturingPrintStream</a>) { +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">return</strong> (<a name="CapturingPrintStream" href="../../../../../org/apache/maven/plugins/pmd/CapturingPrintStream.html#CapturingPrintStream">CapturingPrintStream</a>) System.out; +<a class="jxr_linenumber" name="L60" href="#L60">60</a> } +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; <a class="jxr_linenumber" name="L62" href="#L62">62</a> } <a class="jxr_linenumber" name="L63" href="#L63">63</a> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a name="CapturingPrintStream" href="../../../../../org/apache/maven/plugins/pmd/CapturingPrintStream.html#CapturingPrintStream">CapturingPrintStream</a> get() -<a class="jxr_linenumber" name="L65" href="#L65">65</a> { -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">if</strong> ( System.out instanceof <a name="CapturingPrintStream" href="../../../../../org/apache/maven/plugins/pmd/CapturingPrintStream.html#CapturingPrintStream">CapturingPrintStream</a> ) -<a class="jxr_linenumber" name="L67" href="#L67">67</a> { -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">return</strong> (<a name="CapturingPrintStream" href="../../../../../org/apache/maven/plugins/pmd/CapturingPrintStream.html#CapturingPrintStream">CapturingPrintStream</a>) System.out; +<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getOutput() { +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <a name="CapturingPrintStream" href="../../../../../org/apache/maven/plugins/pmd/CapturingPrintStream.html#CapturingPrintStream">CapturingPrintStream</a> stream = get(); +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">if</strong> (stream != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L67" href="#L67">67</a> stream.flush(); +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">return</strong> stream.buffer.toString(); <a class="jxr_linenumber" name="L69" href="#L69">69</a> } -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">""</span>; <a class="jxr_linenumber" name="L71" href="#L71">71</a> } -<a class="jxr_linenumber" name="L72" href="#L72">72</a> -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String getOutput() -<a class="jxr_linenumber" name="L74" href="#L74">74</a> { -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <a name="CapturingPrintStream" href="../../../../../org/apache/maven/plugins/pmd/CapturingPrintStream.html#CapturingPrintStream">CapturingPrintStream</a> stream = get(); -<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">if</strong> ( stream != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="L77" href="#L77">77</a> { -<a class="jxr_linenumber" name="L78" href="#L78">78</a> stream.flush(); -<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">return</strong> stream.buffer.toString(); -<a class="jxr_linenumber" name="L80" href="#L80">80</a> } -<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">""</span>; -<a class="jxr_linenumber" name="L82" href="#L82">82</a> } -<a class="jxr_linenumber" name="L83" href="#L83">83</a> } +<a class="jxr_linenumber" name="L72" href="#L72">72</a> } </pre> <hr/> <div id="footer">Copyright © 2005–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div>
