| <!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>Description xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/rat/config/parameters/Description.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.config.parameters; |
| <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.lang.reflect.InvocationTargetException; |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.lang.reflect.Method; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.Arrays; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Collection; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.TreeMap; |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.function.Predicate; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.stream.Collectors; |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang3.StringUtils; |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.rat.BuilderParams; |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">import</strong> org.apache.rat.ConfigurationException; |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">import</strong> org.apache.rat.analysis.IHeaderMatcher; |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">import</strong> org.apache.rat.utils.Log; |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * A description of a component.</em> |
| <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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="Description" href="../../../../../org/apache/rat/config/parameters/Description.html#Description">Description</a> { |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment">/** The type of component this describes */</em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a name="ComponentType" href="../../../../../org/apache/rat/config/parameters/ComponentType.html#ComponentType">ComponentType</a> type; |
| <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> <em class="jxr_javadoccomment"> * The common name for the component. Set by ConfigComponent.name() or</em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * class/field name.</em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String name; |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment">/** The description for the component */</em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String desc; |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment">/** The class of the getter/setter parameter */</em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Class<?> childClass; |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment">/** True if the getter/setter expects a collection of childClass objects */</em> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> isCollection; |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment">/** True if this component is required. */</em> |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> required; |
| <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"> * A map of name to Description for all the components that are children of the</em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * described component.</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">private</strong> <strong class="jxr_keyword">final</strong> Map<String, Description> children; |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> Predicate<Description> typePredicate(<a name="ComponentType" href="../../../../../org/apache/rat/config/parameters/ComponentType.html#ComponentType">ComponentType</a> type) { |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">return</strong> (d) -> d.getType() == type; |
| <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"> * Constructor.</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"> * @param type the type of the component.</em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment"> * @param name the name of the component.</em> |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * @param desc the description of the component.</em> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * @param isCollection true if the getter/setter expects a collection</em> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * @param childClass the class for expected for the getter/setter.</em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * @param children the collection of descriptions for all the components that</em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * are children of the described component.</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">public</strong> <a name="Description" href="../../../../../org/apache/rat/config/parameters/Description.html#Description">Description</a>(<a name="ComponentType" href="../../../../../org/apache/rat/config/parameters/ComponentType.html#ComponentType">ComponentType</a> type, String name, String desc, <strong class="jxr_keyword">boolean</strong> isCollection, Class<?> childClass, |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> Collection<Description> children, <strong class="jxr_keyword">boolean</strong> required) { |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">this</strong>.type = type; |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">this</strong>.name = name; |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">this</strong>.desc = desc; |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">this</strong>.isCollection = isCollection; |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">this</strong>.required = required; |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">if</strong> (type == ComponentType.BUILD_PARAMETER) { |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> Method m; |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> m = BuilderParams.<strong class="jxr_keyword">class</strong>.getMethod(name); |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> } <strong class="jxr_keyword">catch</strong> (NoSuchMethodException | SecurityException e) { |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="ConfigurationException" href="../../../../../org/apache/rat/ConfigurationException.html#ConfigurationException">ConfigurationException</a>(String.format(<span class="jxr_string">"'%s' is not a valid BuildParams method"</span>, name)); |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> } |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">this</strong>.childClass = m.getReturnType(); |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">this</strong>.childClass = childClass; |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> } |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <strong class="jxr_keyword">this</strong>.children = <strong class="jxr_keyword">new</strong> TreeMap<>(); |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">if</strong> (children != <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> children.forEach(d -> { |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">this</strong>.children.put(d.name, d); |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> }); |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> } |
| <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> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * Constructor</em> |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> * @param configComponent the configuration component</em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * @param isCollection the collection flag.</em> |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * @param childClass the type of object that the method getter/setter expects.</em> |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * @param children the collection of descriptions for all the components that</em> |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * are children the described component.</em> |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">public</strong> <a name="Description" href="../../../../../org/apache/rat/config/parameters/Description.html#Description">Description</a>(ConfigComponent configComponent, <strong class="jxr_keyword">boolean</strong> isCollection, Class<?> childClass, |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> Collection<Description> children) { |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">this</strong>(configComponent.type(), configComponent.name(), configComponent.desc(), isCollection, childClass, children, |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> configComponent.required()); |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> } |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> |
| <a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> * Get the canBeChild flag.</em> |
| <a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * @return {@code true} if this item can be a child of the containing item.</em> |
| <a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isRequired() { |
| <a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">return</strong> required; |
| <a class="jxr_linenumber" name="L124" href="#L124">124</a> } |
| <a class="jxr_linenumber" name="L125" href="#L125">125</a> |
| <a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment"> * Gets the type of the component.</em> |
| <a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * @return the component type.</em> |
| <a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">public</strong> <a name="ComponentType" href="../../../../../org/apache/rat/config/parameters/ComponentType.html#ComponentType">ComponentType</a> getType() { |
| <a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">return</strong> type; |
| <a class="jxr_linenumber" name="L133" href="#L133">133</a> } |
| <a class="jxr_linenumber" name="L134" href="#L134">134</a> |
| <a class="jxr_linenumber" name="L135" href="#L135">135</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L136" href="#L136">136</a> <em class="jxr_javadoccomment"> * Get the isCollection flag.</em> |
| <a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment"> * @return true if this is a collection.</em> |
| <a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isCollection() { |
| <a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">return</strong> isCollection; |
| <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> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> * Get the class of the objects for the getter/setter methods.</em> |
| <a class="jxr_linenumber" name="L146" href="#L146">146</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L147" href="#L147">147</a> <em class="jxr_javadoccomment"> * @return the getter/setter param class.</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> Class<?> getChildType() { |
| <a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">return</strong> childClass; |
| <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> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * Gets the common name for the matcher. (e.g. 'text', 'spdx', etc.) May not be</em> |
| <a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> * null.</em> |
| <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"> * @return The common name for the item being inspected.</em> |
| <a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">public</strong> String getCommonName() { |
| <a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">return</strong> name; |
| <a class="jxr_linenumber" name="L161" href="#L161">161</a> } |
| <a class="jxr_linenumber" name="L162" href="#L162">162</a> |
| <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> <em class="jxr_javadoccomment"> * Gets the description of descriptive text for the component. May be an empty</em> |
| <a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * string or null.</em> |
| <a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L167" href="#L167">167</a> <em class="jxr_javadoccomment"> * @return the descriptive text;</em> |
| <a class="jxr_linenumber" name="L168" href="#L168">168</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">public</strong> String getDescription() { |
| <a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">return</strong> desc; |
| <a class="jxr_linenumber" name="L171" href="#L171">171</a> } |
| <a class="jxr_linenumber" name="L172" href="#L172">172</a> |
| <a class="jxr_linenumber" name="L173" href="#L173">173</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L174" href="#L174">174</a> <em class="jxr_javadoccomment"> * Retrieve the value of a the described parameter from the specified object.</em> |
| <a class="jxr_linenumber" name="L175" href="#L175">175</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L176" href="#L176">176</a> <em class="jxr_javadoccomment"> * If the parameter is a collection return {@code null}.</em> |
| <a class="jxr_linenumber" name="L177" href="#L177">177</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L178" href="#L178">178</a> <em class="jxr_javadoccomment"> * @param log the Log to log issues to.</em> |
| <a class="jxr_linenumber" name="L179" href="#L179">179</a> <em class="jxr_javadoccomment"> * @param object the object that contains the value.</em> |
| <a class="jxr_linenumber" name="L180" href="#L180">180</a> <em class="jxr_javadoccomment"> * @return the string value.</em> |
| <a class="jxr_linenumber" name="L181" href="#L181">181</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong class="jxr_keyword">public</strong> String getParamValue(<a name="Log" href="../../../../../org/apache/rat/utils/Log.html#Log">Log</a> log, Object object) { |
| <a class="jxr_linenumber" name="L183" href="#L183">183</a> <strong class="jxr_keyword">if</strong> (isCollection) { |
| <a class="jxr_linenumber" name="L184" href="#L184">184</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L185" href="#L185">185</a> } |
| <a class="jxr_linenumber" name="L186" href="#L186">186</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L187" href="#L187">187</a> Object val = getter(object.getClass()).invoke(object); |
| <a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">return</strong> val == <strong class="jxr_keyword">null</strong> ? <strong class="jxr_keyword">null</strong> : val.toString(); |
| <a class="jxr_linenumber" name="L189" href="#L189">189</a> } <strong class="jxr_keyword">catch</strong> (IllegalArgumentException | IllegalAccessException | InvocationTargetException | NoSuchMethodException |
| <a class="jxr_linenumber" name="L190" href="#L190">190</a> | SecurityException e) { |
| <a class="jxr_linenumber" name="L191" href="#L191">191</a> log.error(System.err.format(<span class="jxr_string">"Can not retrieve value for '%s' from %s%n"</span>, name, object.getClass().getName()), |
| <a class="jxr_linenumber" name="L192" href="#L192">192</a> e); |
| <a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L194" href="#L194">194</a> } |
| <a class="jxr_linenumber" name="L195" href="#L195">195</a> } |
| <a class="jxr_linenumber" name="L196" href="#L196">196</a> |
| <a class="jxr_linenumber" name="L197" href="#L197">197</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L198" href="#L198">198</a> <em class="jxr_javadoccomment"> * Gets a map of the parameters that the object contains. For example Copyright</em> |
| <a class="jxr_linenumber" name="L199" href="#L199">199</a> <em class="jxr_javadoccomment"> * has 'start', 'stop', and 'owner' parameters. Some IHeaderMatchers have simple</em> |
| <a class="jxr_linenumber" name="L200" href="#L200">200</a> <em class="jxr_javadoccomment"> * text values (e.g. 'regex' or 'text' types) these should list an unnamed</em> |
| <a class="jxr_linenumber" name="L201" href="#L201">201</a> <em class="jxr_javadoccomment"> * parameter (empty string) with the text value.</em> |
| <a class="jxr_linenumber" name="L202" href="#L202">202</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L203" href="#L203">203</a> <em class="jxr_javadoccomment"> * @return the map of parameters to the objects that represent them.</em> |
| <a class="jxr_linenumber" name="L204" href="#L204">204</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L205" href="#L205">205</a> <strong class="jxr_keyword">public</strong> Map<String, Description> getChildren() { |
| <a class="jxr_linenumber" name="L206" href="#L206">206</a> <strong class="jxr_keyword">return</strong> children; |
| <a class="jxr_linenumber" name="L207" href="#L207">207</a> } |
| <a class="jxr_linenumber" name="L208" href="#L208">208</a> |
| <a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> * Get all the children of a specific type</em> |
| <a class="jxr_linenumber" name="L211" href="#L211">211</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L212" href="#L212">212</a> <em class="jxr_javadoccomment"> * @param type the type to return</em> |
| <a class="jxr_linenumber" name="L213" href="#L213">213</a> <em class="jxr_javadoccomment"> * @return the collection of children of the specified type.</em> |
| <a class="jxr_linenumber" name="L214" href="#L214">214</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L215" href="#L215">215</a> <strong class="jxr_keyword">public</strong> Collection<Description> childrenOfType(<a name="ComponentType" href="../../../../../org/apache/rat/config/parameters/ComponentType.html#ComponentType">ComponentType</a> type) { |
| <a class="jxr_linenumber" name="L216" href="#L216">216</a> <strong class="jxr_keyword">return</strong> filterChildren(d -> d.getType() == type); |
| <a class="jxr_linenumber" name="L217" href="#L217">217</a> } |
| <a class="jxr_linenumber" name="L218" href="#L218">218</a> |
| <a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> * Get a filtered collection of the child descriptions.</em> |
| <a class="jxr_linenumber" name="L221" href="#L221">221</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L222" href="#L222">222</a> <em class="jxr_javadoccomment"> * @param filter the filter to apply to the child descriptions.</em> |
| <a class="jxr_linenumber" name="L223" href="#L223">223</a> <em class="jxr_javadoccomment"> * @return the collection of children that matche the filter..</em> |
| <a class="jxr_linenumber" name="L224" href="#L224">224</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L225" href="#L225">225</a> <strong class="jxr_keyword">public</strong> Collection<Description> filterChildren(Predicate<Description> filter) { |
| <a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong class="jxr_keyword">return</strong> children.values().stream().filter(filter).collect(Collectors.toList()); |
| <a class="jxr_linenumber" name="L227" href="#L227">227</a> } |
| <a class="jxr_linenumber" name="L228" href="#L228">228</a> |
| <a class="jxr_linenumber" name="L229" href="#L229">229</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L230" href="#L230">230</a> <em class="jxr_javadoccomment"> * Generate a method name for this description.</em> |
| <a class="jxr_linenumber" name="L231" href="#L231">231</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L232" href="#L232">232</a> <em class="jxr_javadoccomment"> * @param prefix the start of the method name (e.g. "set", "get" )</em> |
| <a class="jxr_linenumber" name="L233" href="#L233">233</a> <em class="jxr_javadoccomment"> * @return the method name.</em> |
| <a class="jxr_linenumber" name="L234" href="#L234">234</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L235" href="#L235">235</a> <strong class="jxr_keyword">public</strong> String methodName(String prefix) { |
| <a class="jxr_linenumber" name="L236" href="#L236">236</a> <strong class="jxr_keyword">return</strong> prefix + StringUtils.capitalize(name); |
| <a class="jxr_linenumber" name="L237" href="#L237">237</a> } |
| <a class="jxr_linenumber" name="L238" href="#L238">238</a> |
| <a class="jxr_linenumber" name="L239" href="#L239">239</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L240" href="#L240">240</a> <em class="jxr_javadoccomment"> * Returns the getter for the component in the specified class.</em> |
| <a class="jxr_linenumber" name="L241" href="#L241">241</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L242" href="#L242">242</a> <em class="jxr_javadoccomment"> * @param clazz the Class to get the getter from.</em> |
| <a class="jxr_linenumber" name="L243" href="#L243">243</a> <em class="jxr_javadoccomment"> * @return the getter Method.</em> |
| <a class="jxr_linenumber" name="L244" href="#L244">244</a> <em class="jxr_javadoccomment"> * @throws NoSuchMethodException if the class does not have the getter.</em> |
| <a class="jxr_linenumber" name="L245" href="#L245">245</a> <em class="jxr_javadoccomment"> * @throws SecurityException if the getter can not be accessed.</em> |
| <a class="jxr_linenumber" name="L246" href="#L246">246</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong class="jxr_keyword">public</strong> Method getter(Class<?> clazz) <strong class="jxr_keyword">throws</strong> NoSuchMethodException, SecurityException { |
| <a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong class="jxr_keyword">return</strong> clazz.getMethod(methodName(<span class="jxr_string">"get"</span>)); |
| <a class="jxr_linenumber" name="L249" href="#L249">249</a> } |
| <a class="jxr_linenumber" name="L250" href="#L250">250</a> |
| <a class="jxr_linenumber" name="L251" href="#L251">251</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L252" href="#L252">252</a> <em class="jxr_javadoccomment"> * Returns the setter for the component in the specified class. Notes:</em> |
| <a class="jxr_linenumber" name="L253" href="#L253">253</a> <em class="jxr_javadoccomment"> * <ul></em> |
| <a class="jxr_linenumber" name="L254" href="#L254">254</a> <em class="jxr_javadoccomment"> * <li>License can not be set in components. They are top level components.</li></em> |
| <a class="jxr_linenumber" name="L255" href="#L255">255</a> <em class="jxr_javadoccomment"> * <li>Matcher expects an "add" method that accepts an</em> |
| <a class="jxr_linenumber" name="L256" href="#L256">256</a> <em class="jxr_javadoccomment"> * IHeaderMatcher.Builder.</li></em> |
| <a class="jxr_linenumber" name="L257" href="#L257">257</a> <em class="jxr_javadoccomment"> * <li>Parameter expects a {@code set(String)} method.</li></em> |
| <a class="jxr_linenumber" name="L258" href="#L258">258</a> <em class="jxr_javadoccomment"> * <li>Unlabeled expects a {@code set(String)} method.</li></em> |
| <a class="jxr_linenumber" name="L259" href="#L259">259</a> <em class="jxr_javadoccomment"> * <li>BuilderParam expects a {@code set} method that takes a</em> |
| <a class="jxr_linenumber" name="L260" href="#L260">260</a> <em class="jxr_javadoccomment"> * {@code childeClass} argument.</li></em> |
| <a class="jxr_linenumber" name="L261" href="#L261">261</a> <em class="jxr_javadoccomment"> * </ul></em> |
| <a class="jxr_linenumber" name="L262" href="#L262">262</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L263" href="#L263">263</a> <em class="jxr_javadoccomment"> * @param clazz the Class to get the getter from, generally a Builder class..</em> |
| <a class="jxr_linenumber" name="L264" href="#L264">264</a> <em class="jxr_javadoccomment"> * @return the getter Method.</em> |
| <a class="jxr_linenumber" name="L265" href="#L265">265</a> <em class="jxr_javadoccomment"> * @throws NoSuchMethodException if the class does not have the getter.</em> |
| <a class="jxr_linenumber" name="L266" href="#L266">266</a> <em class="jxr_javadoccomment"> * @throws SecurityException if the getter can not be accessed.</em> |
| <a class="jxr_linenumber" name="L267" href="#L267">267</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L268" href="#L268">268</a> <strong class="jxr_keyword">public</strong> Method setter(Class<?> clazz) <strong class="jxr_keyword">throws</strong> NoSuchMethodException, SecurityException { |
| <a class="jxr_linenumber" name="L269" href="#L269">269</a> String methodName = methodName(isCollection ? <span class="jxr_string">"add"</span> : <span class="jxr_string">"set"</span>); |
| <a class="jxr_linenumber" name="L270" href="#L270">270</a> <strong class="jxr_keyword">switch</strong> (type) { |
| <a class="jxr_linenumber" name="L271" href="#L271">271</a> <strong class="jxr_keyword">case</strong> LICENSE: |
| <a class="jxr_linenumber" name="L272" href="#L272">272</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NoSuchMethodException(<span class="jxr_string">"Can not set a License as a child"</span>); |
| <a class="jxr_linenumber" name="L273" href="#L273">273</a> <strong class="jxr_keyword">case</strong> MATCHER: |
| <a class="jxr_linenumber" name="L274" href="#L274">274</a> <strong class="jxr_keyword">return</strong> clazz.getMethod(methodName, IHeaderMatcher.Builder.<strong class="jxr_keyword">class</strong>); |
| <a class="jxr_linenumber" name="L275" href="#L275">275</a> <strong class="jxr_keyword">case</strong> PARAMETER: |
| <a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong class="jxr_keyword">return</strong> clazz.getMethod(methodName, |
| <a class="jxr_linenumber" name="L277" href="#L277">277</a> IHeaderMatcher.<strong class="jxr_keyword">class</strong>.isAssignableFrom(childClass) ? IHeaderMatcher.Builder.<strong class="jxr_keyword">class</strong> : childClass); |
| <a class="jxr_linenumber" name="L278" href="#L278">278</a> <strong class="jxr_keyword">case</strong> BUILD_PARAMETER: |
| <a class="jxr_linenumber" name="L279" href="#L279">279</a> <strong class="jxr_keyword">return</strong> clazz.getMethod(methodName, childClass); |
| <a class="jxr_linenumber" name="L280" href="#L280">280</a> } |
| <a class="jxr_linenumber" name="L281" href="#L281">281</a> <em class="jxr_comment">// should not happen</em> |
| <a class="jxr_linenumber" name="L282" href="#L282">282</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Type "</span> + type + <span class="jxr_string">" not valid."</span>); |
| <a class="jxr_linenumber" name="L283" href="#L283">283</a> } |
| <a class="jxr_linenumber" name="L284" href="#L284">284</a> |
| <a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> callSetter(<a name="Log" href="../../../../../org/apache/rat/utils/Log.html#Log">Log</a> log, <a name="Description" href="../../../../../org/apache/rat/config/parameters/Description.html#Description">Description</a> description, IHeaderMatcher.Builder builder, String value) { |
| <a class="jxr_linenumber" name="L286" href="#L286">286</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L287" href="#L287">287</a> description.setter(builder.getClass()).invoke(builder, value); |
| <a class="jxr_linenumber" name="L288" href="#L288">288</a> } <strong class="jxr_keyword">catch</strong> (NoSuchMethodException e) { |
| <a class="jxr_linenumber" name="L289" href="#L289">289</a> String msg = String.format(<span class="jxr_string">"No setter for '%s' on %s"</span>, description.getCommonName(), |
| <a class="jxr_linenumber" name="L290" href="#L290">290</a> builder.getClass().getCanonicalName()); |
| <a class="jxr_linenumber" name="L291" href="#L291">291</a> log.error(msg); |
| <a class="jxr_linenumber" name="L292" href="#L292">292</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="ConfigurationException" href="../../../../../org/apache/rat/ConfigurationException.html#ConfigurationException">ConfigurationException</a>(msg); |
| <a class="jxr_linenumber" name="L293" href="#L293">293</a> } <strong class="jxr_keyword">catch</strong> (IllegalAccessException | IllegalArgumentException | InvocationTargetException | SecurityException e) { |
| <a class="jxr_linenumber" name="L294" href="#L294">294</a> String msg = String.format(<span class="jxr_string">"Unable to call setter for '%s' on %s"</span>, description.getCommonName(), |
| <a class="jxr_linenumber" name="L295" href="#L295">295</a> builder.getClass().getCanonicalName()); |
| <a class="jxr_linenumber" name="L296" href="#L296">296</a> log.error(msg, e); |
| <a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a name="ConfigurationException" href="../../../../../org/apache/rat/ConfigurationException.html#ConfigurationException">ConfigurationException</a>(msg, e); |
| <a class="jxr_linenumber" name="L298" href="#L298">298</a> } |
| <a class="jxr_linenumber" name="L299" href="#L299">299</a> } |
| <a class="jxr_linenumber" name="L300" href="#L300">300</a> |
| <a class="jxr_linenumber" name="L301" href="#L301">301</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L302" href="#L302">302</a> <em class="jxr_javadoccomment"> * Sets the children of values in the builder. Sets the parameters to the values</em> |
| <a class="jxr_linenumber" name="L303" href="#L303">303</a> <em class="jxr_javadoccomment"> * specified in the map. Only children that accept string arguments should be</em> |
| <a class="jxr_linenumber" name="L304" href="#L304">304</a> <em class="jxr_javadoccomment"> * specified.</em> |
| <a class="jxr_linenumber" name="L305" href="#L305">305</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L306" href="#L306">306</a> <em class="jxr_javadoccomment"> * @param log The log to write messages to.</em> |
| <a class="jxr_linenumber" name="L307" href="#L307">307</a> <em class="jxr_javadoccomment"> * @param builder The Matcher builder to set the values in.</em> |
| <a class="jxr_linenumber" name="L308" href="#L308">308</a> <em class="jxr_javadoccomment"> * @param attributes a Map of parameter names to values.</em> |
| <a class="jxr_linenumber" name="L309" href="#L309">309</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L310" href="#L310">310</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setChildren(<a name="Log" href="../../../../../org/apache/rat/utils/Log.html#Log">Log</a> log, IHeaderMatcher.Builder builder, Map<String, String> attributes) { |
| <a class="jxr_linenumber" name="L311" href="#L311">311</a> attributes.entrySet().forEach(entry -> setChild(log, builder, entry.getKey(), entry.getValue())); |
| <a class="jxr_linenumber" name="L312" href="#L312">312</a> } |
| <a class="jxr_linenumber" name="L313" href="#L313">313</a> |
| <a class="jxr_linenumber" name="L314" href="#L314">314</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L315" href="#L315">315</a> <em class="jxr_javadoccomment"> * Sets the child value in the builder.</em> |
| <a class="jxr_linenumber" name="L316" href="#L316">316</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L317" href="#L317">317</a> <em class="jxr_javadoccomment"> * @param log The log to write messages to.</em> |
| <a class="jxr_linenumber" name="L318" href="#L318">318</a> <em class="jxr_javadoccomment"> * @param builder The Matcher builder to set the values in.</em> |
| <a class="jxr_linenumber" name="L319" href="#L319">319</a> <em class="jxr_javadoccomment"> * @param name the name of the child to set</em> |
| <a class="jxr_linenumber" name="L320" href="#L320">320</a> <em class="jxr_javadoccomment"> * @param value the value of the parameter.</em> |
| <a class="jxr_linenumber" name="L321" href="#L321">321</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L322" href="#L322">322</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setChild(<a name="Log" href="../../../../../org/apache/rat/utils/Log.html#Log">Log</a> log, IHeaderMatcher.Builder builder, String name, String value) { |
| <a class="jxr_linenumber" name="L323" href="#L323">323</a> <a name="Description" href="../../../../../org/apache/rat/config/parameters/Description.html#Description">Description</a> d = getChildren().get(name); |
| <a class="jxr_linenumber" name="L324" href="#L324">324</a> <strong class="jxr_keyword">if</strong> (d == <strong class="jxr_keyword">null</strong>) { |
| <a class="jxr_linenumber" name="L325" href="#L325">325</a> log.error(String.format(<span class="jxr_string">"%s does not define a ConfigComponent for a member %s."</span>, |
| <a class="jxr_linenumber" name="L326" href="#L326">326</a> builder.getClass().getCanonicalName(), name)); |
| <a class="jxr_linenumber" name="L327" href="#L327">327</a> } <strong class="jxr_keyword">else</strong> { |
| <a class="jxr_linenumber" name="L328" href="#L328">328</a> callSetter(log, d, builder, value); |
| <a class="jxr_linenumber" name="L329" href="#L329">329</a> } |
| <a class="jxr_linenumber" name="L330" href="#L330">330</a> } |
| <a class="jxr_linenumber" name="L331" href="#L331">331</a> |
| <a class="jxr_linenumber" name="L332" href="#L332">332</a> @Override |
| <a class="jxr_linenumber" name="L333" href="#L333">333</a> <strong class="jxr_keyword">public</strong> String toString() { |
| <a class="jxr_linenumber" name="L334" href="#L334">334</a> String childList = children.isEmpty() ? <span class="jxr_string">""</span> |
| <a class="jxr_linenumber" name="L335" href="#L335">335</a> : String.join(<span class="jxr_string">", "</span>, |
| <a class="jxr_linenumber" name="L336" href="#L336">336</a> children.values().stream().map(Description::getCommonName).collect(Collectors.toList())); |
| <a class="jxr_linenumber" name="L337" href="#L337">337</a> |
| <a class="jxr_linenumber" name="L338" href="#L338">338</a> <strong class="jxr_keyword">return</strong> String.format(<span class="jxr_string">"Description[%s t:%s c:%s %s children: [%s]] "</span>, name, type, isCollection, childClass, |
| <a class="jxr_linenumber" name="L339" href="#L339">339</a> childList); |
| <a class="jxr_linenumber" name="L340" href="#L340">340</a> } |
| <a class="jxr_linenumber" name="L341" href="#L341">341</a> |
| <a class="jxr_linenumber" name="L342" href="#L342">342</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L343" href="#L343">343</a> <em class="jxr_javadoccomment"> * Write a description with indentation.</em> |
| <a class="jxr_linenumber" name="L344" href="#L344">344</a> <em class="jxr_javadoccomment"> * </em> |
| <a class="jxr_linenumber" name="L345" href="#L345">345</a> <em class="jxr_javadoccomment"> * @param indent the number of spaces to indent.</em> |
| <a class="jxr_linenumber" name="L346" href="#L346">346</a> <em class="jxr_javadoccomment"> * @return the string with the formatted data.</em> |
| <a class="jxr_linenumber" name="L347" href="#L347">347</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L348" href="#L348">348</a> <strong class="jxr_keyword">public</strong> String toString(<strong class="jxr_keyword">int</strong> indent) { |
| <a class="jxr_linenumber" name="L349" href="#L349">349</a> <strong class="jxr_keyword">char</strong>[] spaces = <strong class="jxr_keyword">new</strong> <strong class="jxr_keyword">char</strong>[indent]; |
| <a class="jxr_linenumber" name="L350" href="#L350">350</a> Arrays.fill(spaces, ' '); |
| <a class="jxr_linenumber" name="L351" href="#L351">351</a> String padding = String.copyValueOf(spaces); |
| <a class="jxr_linenumber" name="L352" href="#L352">352</a> String top = String.format(<span class="jxr_string">"%sDescription[ t:%s n:%s c:%s %s%n%s %s] "</span>, padding, type, name, isCollection, |
| <a class="jxr_linenumber" name="L353" href="#L353">353</a> childClass, padding, desc); |
| <a class="jxr_linenumber" name="L354" href="#L354">354</a> <strong class="jxr_keyword">if</strong> (children.isEmpty()) { |
| <a class="jxr_linenumber" name="L355" href="#L355">355</a> <strong class="jxr_keyword">return</strong> top; |
| <a class="jxr_linenumber" name="L356" href="#L356">356</a> } |
| <a class="jxr_linenumber" name="L357" href="#L357">357</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(top); |
| <a class="jxr_linenumber" name="L358" href="#L358">358</a> <strong class="jxr_keyword">for</strong> (<a name="Description" href="../../../../../org/apache/rat/config/parameters/Description.html#Description">Description</a> child : children.values()) { |
| <a class="jxr_linenumber" name="L359" href="#L359">359</a> sb.append(System.lineSeparator()).append(child.toString(indent + 2)); |
| <a class="jxr_linenumber" name="L360" href="#L360">360</a> } |
| <a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong class="jxr_keyword">return</strong> sb.toString(); |
| <a class="jxr_linenumber" name="L362" href="#L362">362</a> } |
| <a class="jxr_linenumber" name="L363" href="#L363">363</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> |
