| <!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>XMLConfigurationWriter xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/rat/configuration/XMLConfigurationWriter.html">View Javadoc</a></div><pre> |
| <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"> * 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.rat.configuration; |
| <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.IOException; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.Writer; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.lang.reflect.InvocationTargetException; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Arrays; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.Collection; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.HashSet; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.Optional; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.Set; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> java.util.SortedSet; |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> java.util.UUID; |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> java.util.function.Predicate; |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.StringUtils; |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.rat.ImplementationException; |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">import</strong> org.apache.rat.ReportConfiguration; |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">import</strong> org.apache.rat.analysis.IHeaderMatcher; |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">import</strong> org.apache.rat.api.RatException; |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">import</strong> org.apache.rat.config.parameters.ComponentType; |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">import</strong> org.apache.rat.config.parameters.Description; |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">import</strong> org.apache.rat.configuration.builders.MatcherRefBuilder; |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">import</strong> org.apache.rat.license.ILicense; |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">import</strong> org.apache.rat.license.ILicenseFamily; |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">import</strong> org.apache.rat.license.LicenseSetFactory.LicenseFilter; |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">import</strong> org.apache.rat.report.xml.writer.IXmlWriter; |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">import</strong> org.apache.rat.report.xml.writer.impl.base.XmlWriter; |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * A class that writes the XML configuration file format.</em> |
| <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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="XMLConfigurationWriter" href="../../../../org/apache/rat/configuration/XMLConfigurationWriter.html#XMLConfigurationWriter">XMLConfigurationWriter</a> { |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">private</strong> <a name="ReportConfiguration" href="../../../../org/apache/rat/ReportConfiguration.html#ReportConfiguration">ReportConfiguration</a> configuration; |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">private</strong> Set<String> matchers; |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">private</strong> Set<String> licenseChildren; |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> * Constructor</em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * @param configuration the configuration to write.</em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">public</strong> <a name="XMLConfigurationWriter" href="../../../../org/apache/rat/configuration/XMLConfigurationWriter.html#XMLConfigurationWriter">XMLConfigurationWriter</a>(<a name="ReportConfiguration" href="../../../../org/apache/rat/ReportConfiguration.html#ReportConfiguration">ReportConfiguration</a> configuration) { |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">this</strong>.configuration = configuration; |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">this</strong>.matchers = <strong class="jxr_keyword">new</strong> HashSet<>(); |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> licenseChildren = <strong class="jxr_keyword">new</strong> HashSet<>(Arrays.asList(XMLConfig.LICENSE_CHILDREN)); |
| <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> <strong class="jxr_keyword">private</strong> Predicate<Description> attributeFilter(<a name="Description" href="../../../../org/apache/rat/config/parameters/Description.html#Description">Description</a> parent) { |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">return</strong> d -> { |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">if</strong> (d.getType() == ComponentType.PARAMETER) { |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">switch</strong> (parent.getType()) { |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">case</strong> MATCHER: |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">return</strong> !XMLConfig.isInlineNode(parent.getCommonName(), d.getCommonName()); |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">case</strong> LICENSE: |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">return</strong> !licenseChildren.contains(d.getCommonName()); |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">default</strong>: |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>; |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> } |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> } |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">return</strong> false; |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> }; |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> } |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> |
| <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> <em class="jxr_javadoccomment"> * Writes the configuration to the specified writer.</em> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * @param plainWriter a writer to write the XML to.</em> |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * @throws RatException on error.</em> |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> write(Writer plainWriter) <strong class="jxr_keyword">throws</strong> <a name="RatException" href="../../../../org/apache/rat/api/RatException.html#RatException">RatException</a> { |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> write(<strong class="jxr_keyword">new</strong> <a name="XmlWriter" href="../../../../org/apache/rat/report/xml/writer/impl/base/XmlWriter.html#XmlWriter">XmlWriter</a>(plainWriter)); |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> } |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> |
| <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"> * Writes the configuration to an IXmlWriter instance.</em> |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * @param writer the IXmlWriter to write to.</em> |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * @throws RatException on error.</em> |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> write(<a name="IXmlWriter" href="../../../../org/apache/rat/report/xml/writer/IXmlWriter.html#IXmlWriter">IXmlWriter</a> writer) <strong class="jxr_keyword">throws</strong> <a name="RatException" href="../../../../org/apache/rat/api/RatException.html#RatException">RatException</a> { |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">if</strong> (configuration.listFamilies() != LicenseFilter.NONE || configuration.listLicenses() != LicenseFilter.NONE) { |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> writer.openElement(XMLConfig.ROOT); |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_comment">// write Families section</em> |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> SortedSet<ILicenseFamily> families = configuration.getLicenseFamilies(configuration.listFamilies()); |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">if</strong> (!families.isEmpty()) { |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> writer.openElement(XMLConfig.FAMILIES); |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">for</strong> (<a name="ILicenseFamily" href="../../../../org/apache/rat/license/ILicenseFamily.html#ILicenseFamily">ILicenseFamily</a> family : families) { |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> writeFamily(writer, family); |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> } |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> writer.closeElement(); <em class="jxr_comment">// FAMILIES</em> |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> } |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_comment">// write licenses section</em> |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> SortedSet<ILicense> licenses = configuration.getLicenses(configuration.listLicenses()); |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">if</strong> (!licenses.isEmpty()) { |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> writer.openElement(XMLConfig.LICENSES); |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> <strong class="jxr_keyword">for</strong> (<a name="ILicense" href="../../../../org/apache/rat/license/ILicense.html#ILicense">ILicense</a> license : licenses) { |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> writeDescription(writer, license.getDescription(), license); |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> } |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> writer.closeElement();<em class="jxr_comment">// LICENSES</em> |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> } |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_comment">// write approved section</em> |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> writer.openElement(XMLConfig.APPROVED); |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">for</strong> (String family : configuration.getApprovedLicenseCategories()) { |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> writer.openElement(XMLConfig.APPROVED).attribute(XMLConfig.ATT_LICENSE_REF, family.trim()) |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> .closeElement(); |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> } |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> writer.closeElement(); <em class="jxr_comment">// APPROVED</em> |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_comment">// write matchers section</em> |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> <a name="MatcherBuilderTracker" href="../../../../org/apache/rat/configuration/MatcherBuilderTracker.html#MatcherBuilderTracker">MatcherBuilderTracker</a> tracker = MatcherBuilderTracker.INSTANCE; |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> writer.openElement(XMLConfig.MATCHERS); |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">for</strong> (Class<?> clazz : tracker.getClasses()) { |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> writer.openElement(XMLConfig.MATCHER).attribute(XMLConfig.ATT_CLASS_NAME, clazz.getCanonicalName()) |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> .closeElement(); |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> } |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> writer.closeElement(); <em class="jxr_comment">// MATCHERS</em> |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> writer.closeElement(); <em class="jxr_comment">// ROOT</em> |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="RatException" href="../../../../org/apache/rat/api/RatException.html#RatException">RatException</a>(e); |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> } |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> } |
| <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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeFamily(<a name="IXmlWriter" href="../../../../org/apache/rat/report/xml/writer/IXmlWriter.html#IXmlWriter">IXmlWriter</a> writer, <a name="ILicenseFamily" href="../../../../org/apache/rat/license/ILicenseFamily.html#ILicenseFamily">ILicenseFamily</a> family) <strong class="jxr_keyword">throws</strong> <a name="RatException" href="../../../../org/apache/rat/api/RatException.html#RatException">RatException</a> { |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> writer.openElement(XMLConfig.FAMILY).attribute(XMLConfig.ATT_ID, family.getFamilyCategory().trim()) |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> .attribute(XMLConfig.ATT_NAME, family.getFamilyName()); |
| <a class="jxr_linenumber" name="L148" href="#L148">148</a> writer.closeElement(); |
| <a class="jxr_linenumber" name="L149" href="#L149">149</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="RatException" href="../../../../org/apache/rat/api/RatException.html#RatException">RatException</a>(e); |
| <a class="jxr_linenumber" name="L151" href="#L151">151</a> } |
| <a class="jxr_linenumber" name="L152" href="#L152">152</a> } |
| <a class="jxr_linenumber" name="L153" href="#L153">153</a> |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeDescriptions(<a name="IXmlWriter" href="../../../../org/apache/rat/report/xml/writer/IXmlWriter.html#IXmlWriter">IXmlWriter</a> writer, Collection<Description> descriptions, <a name="IHeaderMatcher" href="../../../../org/apache/rat/analysis/IHeaderMatcher.html#IHeaderMatcher">IHeaderMatcher</a> component) |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">throws</strong> <a name="RatException" href="../../../../org/apache/rat/api/RatException.html#RatException">RatException</a> { |
| <a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">for</strong> (<a name="Description" href="../../../../org/apache/rat/config/parameters/Description.html#Description">Description</a> description : descriptions) { |
| <a class="jxr_linenumber" name="L157" href="#L157">157</a> writeDescription(writer, description, component); |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> } |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> } |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeChildren(<a name="IXmlWriter" href="../../../../org/apache/rat/report/xml/writer/IXmlWriter.html#IXmlWriter">IXmlWriter</a> writer, <a name="Description" href="../../../../org/apache/rat/config/parameters/Description.html#Description">Description</a> description, <a name="IHeaderMatcher" href="../../../../org/apache/rat/analysis/IHeaderMatcher.html#IHeaderMatcher">IHeaderMatcher</a> component) |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">throws</strong> <a name="RatException" href="../../../../org/apache/rat/api/RatException.html#RatException">RatException</a> { |
| <a class="jxr_linenumber" name="L163" href="#L163">163</a> writeAttributes(writer, description.filterChildren(attributeFilter(component.getDescription())), component); |
| <a class="jxr_linenumber" name="L164" href="#L164">164</a> writeDescriptions(writer, description.filterChildren(attributeFilter(component.getDescription()).negate()), |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> component); |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> } |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeAttributes(<a name="IXmlWriter" href="../../../../org/apache/rat/report/xml/writer/IXmlWriter.html#IXmlWriter">IXmlWriter</a> writer, Collection<Description> descriptions, <a name="IHeaderMatcher" href="../../../../org/apache/rat/analysis/IHeaderMatcher.html#IHeaderMatcher">IHeaderMatcher</a> component) |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">throws</strong> <a name="RatException" href="../../../../org/apache/rat/api/RatException.html#RatException">RatException</a> { |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">for</strong> (<a name="Description" href="../../../../org/apache/rat/config/parameters/Description.html#Description">Description</a> d : descriptions) { |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> writeAttribute(writer, d, component); |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="RatException" href="../../../../org/apache/rat/api/RatException.html#RatException">RatException</a>(e); |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> } |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> } |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> } |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeComment(<a name="IXmlWriter" href="../../../../org/apache/rat/report/xml/writer/IXmlWriter.html#IXmlWriter">IXmlWriter</a> writer, <a name="Description" href="../../../../org/apache/rat/config/parameters/Description.html#Description">Description</a> description) <strong class="jxr_keyword">throws</strong> IOException { |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotBlank(description.getDescription())) { |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> writer.comment(description.getDescription()); |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> } |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> } |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> writeAttribute(<a name="IXmlWriter" href="../../../../org/apache/rat/report/xml/writer/IXmlWriter.html#IXmlWriter">IXmlWriter</a> writer, <a name="Description" href="../../../../org/apache/rat/config/parameters/Description.html#Description">Description</a> description, <a name="IHeaderMatcher" href="../../../../org/apache/rat/analysis/IHeaderMatcher.html#IHeaderMatcher">IHeaderMatcher</a> component) |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">throws</strong> IOException { |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> String paramValue = description.getParamValue(configuration.getLog(), component); |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">if</strong> (paramValue != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> writer.attribute(description.getCommonName(), paramValue); |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> } |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> } |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> <em class="jxr_comment">/* package private for testing */</em> |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> @SuppressWarnings(<span class="jxr_string">"unchecked"</span>) |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> <strong class="jxr_keyword">void</strong> writeDescription(<a name="IXmlWriter" href="../../../../org/apache/rat/report/xml/writer/IXmlWriter.html#IXmlWriter">IXmlWriter</a> writer, <a name="Description" href="../../../../org/apache/rat/config/parameters/Description.html#Description">Description</a> description, <a name="IHeaderMatcher" href="../../../../org/apache/rat/analysis/IHeaderMatcher.html#IHeaderMatcher">IHeaderMatcher</a> component) <strong class="jxr_keyword">throws</strong> <a name="RatException" href="../../../../org/apache/rat/api/RatException.html#RatException">RatException</a> { |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong class="jxr_keyword">switch</strong> (description.getType()) { |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong class="jxr_keyword">case</strong> MATCHER: |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_comment">// see if id was registered</em> |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> Optional<Description> id = description.childrenOfType(ComponentType.PARAMETER).stream() |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> .filter(i -> XMLConfig.ATT_ID.equals(i.getCommonName())).findFirst(); |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_comment">// id will not be present in matcherRef</em> |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> <strong class="jxr_keyword">if</strong> (id.isPresent()) { |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> String matcherId = id.get().getParamValue(configuration.getLog(), component); |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_comment">// if we have seen the ID before just put a reference to the other one.</em> |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> <strong class="jxr_keyword">if</strong> (matchers.contains(matcherId.toString())) { |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> component = <strong class="jxr_keyword">new</strong> MatcherRefBuilder.IHeaderMatcherProxy(matcherId.toString(), <strong class="jxr_keyword">null</strong>); |
| <a class="jxr_linenumber" name="L209" href="#L209">209</a> description = component.getDescription(); |
| <a class="jxr_linenumber" name="L210" href="#L210">210</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L211" href="#L211">211</a> matchers.add(matcherId.toString()); |
| <a class="jxr_linenumber" name="L212" href="#L212">212</a> } |
| <a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_comment">// remove the matcher id if it is a UUID</em> |
| <a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> UUID.fromString(matcherId); |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> description.getChildren().remove(XMLConfig.ATT_ID); |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> } <strong class="jxr_keyword">catch</strong> (IllegalArgumentException expected) { |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> <strong class="jxr_keyword">if</strong> (description.getCommonName().equals(<span class="jxr_string">"spdx"</span>)) { |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> description.getChildren().remove(XMLConfig.ATT_ID); |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> } |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> } |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> } |
| <a class="jxr_linenumber" name="L223" href="#L223">223</a> |
| <a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_comment">// if resource only list the resource not the contents of the matcher</em> |
| <a class="jxr_linenumber" name="L225" href="#L225">225</a> Optional<Description> resource = description.childrenOfType(ComponentType.PARAMETER).stream() |
| <a class="jxr_linenumber" name="L226" href="#L226">226</a> .filter(i -> XMLConfig.ATT_RESOURCE.equals(i.getCommonName())).findFirst(); |
| <a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong class="jxr_keyword">if</strong> (resource.isPresent()) { |
| <a class="jxr_linenumber" name="L228" href="#L228">228</a> String resourceStr = resource.get().getParamValue(configuration.getLog(), component); |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotBlank(resourceStr)) { |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> description.getChildren().remove(<span class="jxr_string">"enclosed"</span>); |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> } |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> } |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> writeComment(writer, description); |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> writer.openElement(description.getCommonName()); |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> writeChildren(writer, description, component); |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> writer.closeElement(); |
| <a class="jxr_linenumber" name="L237" href="#L237">237</a> <strong class="jxr_keyword">break</strong>; |
| <a class="jxr_linenumber" name="L238" href="#L238">238</a> <strong class="jxr_keyword">case</strong> LICENSE: |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> writer.openElement(XMLConfig.LICENSE); |
| <a class="jxr_linenumber" name="L240" href="#L240">240</a> writeChildren(writer, description, component); |
| <a class="jxr_linenumber" name="L241" href="#L241">241</a> writer.closeElement(); |
| <a class="jxr_linenumber" name="L242" href="#L242">242</a> <strong class="jxr_keyword">break</strong>; |
| <a class="jxr_linenumber" name="L243" href="#L243">243</a> <strong class="jxr_keyword">case</strong> PARAMETER: |
| <a class="jxr_linenumber" name="L244" href="#L244">244</a> <strong class="jxr_keyword">if</strong> (<span class="jxr_string">"id"</span>.equals(description.getCommonName())) { |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L246" href="#L246">246</a> String paramId = description.getParamValue(configuration.getLog(), component); |
| <a class="jxr_linenumber" name="L247" href="#L247">247</a> <em class="jxr_comment">// if a UUID skip it.</em> |
| <a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">if</strong> (paramId != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L249" href="#L249">249</a> UUID.fromString(paramId.toString()); |
| <a class="jxr_linenumber" name="L250" href="#L250">250</a> <strong class="jxr_keyword">return</strong>; |
| <a class="jxr_linenumber" name="L251" href="#L251">251</a> } |
| <a class="jxr_linenumber" name="L252" href="#L252">252</a> } <strong class="jxr_keyword">catch</strong> (IllegalArgumentException expected) { |
| <a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_comment">// do nothing.</em> |
| <a class="jxr_linenumber" name="L254" href="#L254">254</a> } |
| <a class="jxr_linenumber" name="L255" href="#L255">255</a> } |
| <a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong class="jxr_keyword">if</strong> (description.getChildType() == String.<strong class="jxr_keyword">class</strong>) { |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> <strong class="jxr_keyword">boolean</strong> inline = XMLConfig.isInlineNode(component.getDescription().getCommonName(), |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> description.getCommonName()); |
| <a class="jxr_linenumber" name="L260" href="#L260">260</a> String s = description.getParamValue(configuration.getLog(), component); |
| <a class="jxr_linenumber" name="L261" href="#L261">261</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotBlank(s)) { |
| <a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong class="jxr_keyword">if</strong> (!inline) { |
| <a class="jxr_linenumber" name="L263" href="#L263">263</a> writer.openElement(description.getCommonName()); |
| <a class="jxr_linenumber" name="L264" href="#L264">264</a> } |
| <a class="jxr_linenumber" name="L265" href="#L265">265</a> writer.content(description.getParamValue(configuration.getLog(), component)); |
| <a class="jxr_linenumber" name="L266" href="#L266">266</a> <strong class="jxr_keyword">if</strong> (!inline) { |
| <a class="jxr_linenumber" name="L267" href="#L267">267</a> writer.closeElement(); |
| <a class="jxr_linenumber" name="L268" href="#L268">268</a> } |
| <a class="jxr_linenumber" name="L269" href="#L269">269</a> } |
| <a class="jxr_linenumber" name="L270" href="#L270">270</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">if</strong> (description.isCollection()) { |
| <a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">for</strong> (<a name="IHeaderMatcher" href="../../../../org/apache/rat/analysis/IHeaderMatcher.html#IHeaderMatcher">IHeaderMatcher</a> matcher : (Collection<IHeaderMatcher>) description |
| <a class="jxr_linenumber" name="L274" href="#L274">274</a> .getter(component.getClass()).invoke(component)) { |
| <a class="jxr_linenumber" name="L275" href="#L275">275</a> writeDescription(writer, matcher.getDescription(), matcher); |
| <a class="jxr_linenumber" name="L276" href="#L276">276</a> } |
| <a class="jxr_linenumber" name="L277" href="#L277">277</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L278" href="#L278">278</a> <a name="IHeaderMatcher" href="../../../../org/apache/rat/analysis/IHeaderMatcher.html#IHeaderMatcher">IHeaderMatcher</a> matcher = (<a name="IHeaderMatcher" href="../../../../org/apache/rat/analysis/IHeaderMatcher.html#IHeaderMatcher">IHeaderMatcher</a>) description.getter(component.getClass()) |
| <a class="jxr_linenumber" name="L279" href="#L279">279</a> .invoke(component); |
| <a class="jxr_linenumber" name="L280" href="#L280">280</a> writeDescription(writer, matcher.getDescription(), matcher); |
| <a class="jxr_linenumber" name="L281" href="#L281">281</a> } |
| <a class="jxr_linenumber" name="L282" href="#L282">282</a> } <strong class="jxr_keyword">catch</strong> (IllegalAccessException | IllegalArgumentException | InvocationTargetException |
| <a class="jxr_linenumber" name="L283" href="#L283">283</a> | NoSuchMethodException | SecurityException | <a name="RatException" href="../../../../org/apache/rat/api/RatException.html#RatException">RatException</a> e) { |
| <a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="ImplementationException" href="../../../../org/apache/rat/ImplementationException.html#ImplementationException">ImplementationException</a>(e); |
| <a class="jxr_linenumber" name="L285" href="#L285">285</a> } |
| <a class="jxr_linenumber" name="L286" href="#L286">286</a> } |
| <a class="jxr_linenumber" name="L287" href="#L287">287</a> <strong class="jxr_keyword">break</strong>; |
| <a class="jxr_linenumber" name="L288" href="#L288">288</a> <strong class="jxr_keyword">case</strong> BUILD_PARAMETER: |
| <a class="jxr_linenumber" name="L289" href="#L289">289</a> <em class="jxr_comment">// ignore;</em> |
| <a class="jxr_linenumber" name="L290" href="#L290">290</a> <strong class="jxr_keyword">break</strong>; |
| <a class="jxr_linenumber" name="L291" href="#L291">291</a> } |
| <a class="jxr_linenumber" name="L292" href="#L292">292</a> } <strong class="jxr_keyword">catch</strong> (IOException e) { |
| <a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="RatException" href="../../../../org/apache/rat/api/RatException.html#RatException">RatException</a>(e); |
| <a class="jxr_linenumber" name="L294" href="#L294">294</a> } |
| <a class="jxr_linenumber" name="L295" href="#L295">295</a> } |
| <a class="jxr_linenumber" name="L296" href="#L296">296</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2006–2024 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
