Modified: maven/website/components/shared-archives/maven-shared-jar-LATEST/xref/org/apache/maven/shared/jar/JarData.html ============================================================================== --- maven/website/components/shared-archives/maven-shared-jar-LATEST/xref/org/apache/maven/shared/jar/JarData.html (original) +++ maven/website/components/shared-archives/maven-shared-jar-LATEST/xref/org/apache/maven/shared/jar/JarData.html Sat Jun 1 19:47:09 2024 @@ -1,180 +1,208 @@ -<!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>JarData xref</title> -<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> -</head> -<body> -<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/shared/jar/JarData.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.maven.shared.jar; -<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.util.Collections; -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.jar.Attributes; -<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.jar.JarEntry; -<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.jar.Manifest; -<a class="jxr_linenumber" name="L27" href="#L27">27</a> -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.jar.classes.JarClasses; -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.jar.identification.JarIdentification; -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.util.StringUtils; -<a class="jxr_linenumber" name="L31" href="#L31">31</a> -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * Class that contains details of a single JAR file and it's entries.</em> -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a name="JarData" href="../../../../../org/apache/maven/shared/jar/JarData.html#JarData">JarData</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"> * The JAR file.</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">private</strong> <strong class="jxr_keyword">final</strong> File file; -<a class="jxr_linenumber" name="L40" href="#L40">40</a> -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * Whether the JAR file is sealed.</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">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> aSealed; -<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 hashcode for the entire file's contents.</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> String fileHash; -<a class="jxr_linenumber" name="L50" href="#L50">50</a> -<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> <em class="jxr_javadoccomment"> * The hashcode for the file's class data contents.</em> -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">private</strong> String bytecodeHash; -<a class="jxr_linenumber" name="L55" href="#L55">55</a> -<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * The JAR's manifest.</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> Manifest manifest; -<a class="jxr_linenumber" name="L60" href="#L60">60</a> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * Information about the JAR's classes.</em> -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">private</strong> <a name="JarClasses" href="../../../../../org/apache/maven/shared/jar/classes/JarClasses.html#JarClasses">JarClasses</a> jarClasses; -<a class="jxr_linenumber" name="L65" href="#L65">65</a> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * The JAR entries.</em> -<a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List<JarEntry> entries; -<a class="jxr_linenumber" name="L70" href="#L70">70</a> -<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"> * Information about the JAR's identifying features.</em> -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">private</strong> <a name="JarIdentification" href="../../../../../org/apache/maven/shared/jar/identification/JarIdentification.html#JarIdentification">JarIdentification</a> jarIdentification; -<a class="jxr_linenumber" name="L75" href="#L75">75</a> -<a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * Constructor.</em> -<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> * @param file the JAR file</em> -<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * @param manifest the JAR manifest</em> -<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * @param entries the JAR entries</em> -<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">public</strong> <a name="JarData" href="../../../../../org/apache/maven/shared/jar/JarData.html#JarData">JarData</a>(File file, Manifest manifest, List<JarEntry> entries) { -<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">this</strong>.file = file; -<a class="jxr_linenumber" name="L85" href="#L85">85</a> -<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">this</strong>.manifest = manifest; -<a class="jxr_linenumber" name="L87" href="#L87">87</a> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">this</strong>.entries = Collections.unmodifiableList(entries); -<a class="jxr_linenumber" name="L89" href="#L89">89</a> -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">boolean</strong> aSealed = false; -<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.manifest != <strong class="jxr_keyword">null</strong>) { -<a class="jxr_linenumber" name="L92" href="#L92">92</a> String sval = <strong class="jxr_keyword">this</strong>.manifest.getMainAttributes().getValue(Attributes.Name.SEALED); -<a class="jxr_linenumber" name="L93" href="#L93">93</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotEmpty(sval)) { -<a class="jxr_linenumber" name="L94" href="#L94">94</a> aSealed = <span class="jxr_string">"true"</span>.equalsIgnoreCase(sval.trim()); -<a class="jxr_linenumber" name="L95" href="#L95">95</a> } -<a class="jxr_linenumber" name="L96" href="#L96">96</a> } -<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">this</strong>.aSealed = aSealed; -<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> <strong class="jxr_keyword">public</strong> List<JarEntry> getEntries() { -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">return</strong> entries; -<a class="jxr_linenumber" name="L102" href="#L102">102</a> } -<a class="jxr_linenumber" name="L103" href="#L103">103</a> -<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">public</strong> Manifest getManifest() { -<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">return</strong> manifest; -<a class="jxr_linenumber" name="L106" href="#L106">106</a> } -<a class="jxr_linenumber" name="L107" href="#L107">107</a> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">public</strong> File getFile() { -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">return</strong> file; -<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">public</strong> <strong class="jxr_keyword">boolean</strong> isSealed() { -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">return</strong> aSealed; -<a class="jxr_linenumber" name="L114" href="#L114">114</a> } -<a class="jxr_linenumber" name="L115" href="#L115">115</a> -<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFileHash(String fileHash) { -<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">this</strong>.fileHash = fileHash; -<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> <strong class="jxr_keyword">public</strong> String getFileHash() { -<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">return</strong> fileHash; -<a class="jxr_linenumber" name="L122" href="#L122">122</a> } -<a class="jxr_linenumber" name="L123" href="#L123">123</a> -<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setBytecodeHash(String bytecodeHash) { -<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">this</strong>.bytecodeHash = bytecodeHash; -<a class="jxr_linenumber" name="L126" href="#L126">126</a> } -<a class="jxr_linenumber" name="L127" href="#L127">127</a> -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">public</strong> String getBytecodeHash() { -<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">return</strong> bytecodeHash; -<a class="jxr_linenumber" name="L130" href="#L130">130</a> } -<a class="jxr_linenumber" name="L131" href="#L131">131</a> -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isDebugPresent() { -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">return</strong> jarClasses.isDebugPresent(); -<a class="jxr_linenumber" name="L134" href="#L134">134</a> } -<a class="jxr_linenumber" name="L135" href="#L135">135</a> -<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setJarClasses(<a name="JarClasses" href="../../../../../org/apache/maven/shared/jar/classes/JarClasses.html#JarClasses">JarClasses</a> jarClasses) { -<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">this</strong>.jarClasses = jarClasses; -<a class="jxr_linenumber" name="L138" href="#L138">138</a> } -<a class="jxr_linenumber" name="L139" href="#L139">139</a> -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getNumEntries() { -<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">return</strong> entries.size(); -<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">public</strong> <strong class="jxr_keyword">int</strong> getNumClasses() { -<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">return</strong> jarClasses.getClassNames().size(); -<a class="jxr_linenumber" name="L146" href="#L146">146</a> } -<a class="jxr_linenumber" name="L147" href="#L147">147</a> -<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getNumPackages() { -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">return</strong> jarClasses.getPackages().size(); -<a class="jxr_linenumber" name="L150" href="#L150">150</a> } -<a class="jxr_linenumber" name="L151" href="#L151">151</a> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">public</strong> String getJdkRevision() { -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">return</strong> jarClasses.getJdkRevision(); -<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setJarIdentification(<a name="JarIdentification" href="../../../../../org/apache/maven/shared/jar/identification/JarIdentification.html#JarIdentification">JarIdentification</a> jarIdentification) { -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">this</strong>.jarIdentification = jarIdentification; -<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> <strong class="jxr_keyword">public</strong> <a name="JarIdentification" href="../../../../../org/apache/maven/shared/jar/identification/JarIdentification.html#JarIdentification">JarIdentification</a> getJarIdentification() { -<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">return</strong> jarIdentification; -<a class="jxr_linenumber" name="L162" href="#L162">162</a> } -<a class="jxr_linenumber" name="L163" href="#L163">163</a> -<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">public</strong> <a name="JarClasses" href="../../../../../org/apache/maven/shared/jar/classes/JarClasses.html#JarClasses">JarClasses</a> getJarClasses() { -<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">return</strong> jarClasses; -<a class="jxr_linenumber" name="L166" href="#L166">166</a> } -<a class="jxr_linenumber" name="L167" href="#L167">167</a> } -</pre> -<hr/> -<div id="footer">Copyright © 2002–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> -</body> +<!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>JarData xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/shared/jar/JarData.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.maven.shared.jar; +<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.util.Collections; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.jar.Attributes; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.jar.Attributes.Name; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.jar.JarEntry; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.jar.Manifest; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.jar.classes.JarClasses; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.jar.classes.JarVersionedRuntimes; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <strong class="jxr_keyword">import</strong> org.apache.maven.shared.jar.identification.JarIdentification; +<a class="jxr_linenumber" name="L32" href="#L32">32</a> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * Class that contains details of a single JAR file and it's entries.</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a name="JarData" href="../../../../../org/apache/maven/shared/jar/JarData.html#JarData">JarData</a> { +<a class="jxr_linenumber" name="L37" href="#L37">37</a> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Name ATTR_MULTI_RELEASE = <strong class="jxr_keyword">new</strong> Attributes.Name(<span class="jxr_string">"Multi-Release"</span>); +<a class="jxr_linenumber" name="L39" href="#L39">39</a> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * The JAR file.</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">private</strong> <strong class="jxr_keyword">final</strong> File file; +<a class="jxr_linenumber" name="L44" href="#L44">44</a> +<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> <em class="jxr_javadoccomment"> * Whether the JAR file is sealed.</em> +<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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> aSealed; +<a class="jxr_linenumber" name="L49" href="#L49">49</a> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment"> * Whether the JAR file is Multi-Release.</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> multiRelease; +<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"> * The hashcode for the entire file's contents.</em> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">private</strong> String fileHash; +<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"> * The hashcode for the file's class data contents.</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> <strong class="jxr_keyword">private</strong> String bytecodeHash; +<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"> * The JAR's manifest.</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Manifest manifest; +<a class="jxr_linenumber" name="L69" href="#L69">69</a> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * Information about the JAR's classes.</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">private</strong> <a name="JarClasses" href="../../../../../org/apache/maven/shared/jar/classes/JarClasses.html#JarClasses">JarClasses</a> jarClasses; +<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"> * The JAR entries.</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> List<JarEntry> entries; +<a class="jxr_linenumber" name="L79" href="#L79">79</a> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * Information about the JAR's identifying features.</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">private</strong> <a name="JarIdentification" href="../../../../../org/apache/maven/shared/jar/identification/JarIdentification.html#JarIdentification">JarIdentification</a> jarIdentification; +<a class="jxr_linenumber" name="L84" href="#L84">84</a> +<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> <em class="jxr_javadoccomment"> * Information about the JAR's Multi-Release entries</em> +<a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <strong class="jxr_keyword">private</strong> <a name="JarVersionedRuntimes" href="../../../../../org/apache/maven/shared/jar/classes/JarVersionedRuntimes.html#JarVersionedRuntimes">JarVersionedRuntimes</a> versionedRuntimes; +<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"> * Constructor.</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * @param file the JAR file</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * @param manifest the JAR manifest</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * @param entries the JAR entries</em> +<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> <strong class="jxr_keyword">public</strong> <a name="JarData" href="../../../../../org/apache/maven/shared/jar/JarData.html#JarData">JarData</a>(File file, Manifest manifest, List<JarEntry> entries) { +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <strong class="jxr_keyword">this</strong>.file = file; +<a class="jxr_linenumber" name="L99" href="#L99">99</a> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">this</strong>.manifest = manifest; +<a class="jxr_linenumber" name="L101" href="#L101">101</a> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">this</strong>.entries = Collections.unmodifiableList(entries); +<a class="jxr_linenumber" name="L103" href="#L103">103</a> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">this</strong>.aSealed = isAttributePresent(Attributes.Name.SEALED); +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">this</strong>.multiRelease = isAttributePresent(ATTR_MULTI_RELEASE); +<a class="jxr_linenumber" name="L106" href="#L106">106</a> } +<a class="jxr_linenumber" name="L107" href="#L107">107</a> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <strong class="jxr_keyword">public</strong> List<JarEntry> getEntries() { +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">return</strong> entries; +<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">public</strong> Manifest getManifest() { +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">return</strong> manifest; +<a class="jxr_linenumber" name="L114" href="#L114">114</a> } +<a class="jxr_linenumber" name="L115" href="#L115">115</a> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <strong class="jxr_keyword">public</strong> File getFile() { +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">return</strong> file; +<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isSealed() { +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">return</strong> aSealed; +<a class="jxr_linenumber" name="L122" href="#L122">122</a> } +<a class="jxr_linenumber" name="L123" href="#L123">123</a> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isMultiRelease() { +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <strong class="jxr_keyword">return</strong> multiRelease; +<a class="jxr_linenumber" name="L126" href="#L126">126</a> } +<a class="jxr_linenumber" name="L127" href="#L127">127</a> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setFileHash(String fileHash) { +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <strong class="jxr_keyword">this</strong>.fileHash = fileHash; +<a class="jxr_linenumber" name="L130" href="#L130">130</a> } +<a class="jxr_linenumber" name="L131" href="#L131">131</a> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <strong class="jxr_keyword">public</strong> String getFileHash() { +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">return</strong> fileHash; +<a class="jxr_linenumber" name="L134" href="#L134">134</a> } +<a class="jxr_linenumber" name="L135" href="#L135">135</a> +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setBytecodeHash(String bytecodeHash) { +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <strong class="jxr_keyword">this</strong>.bytecodeHash = bytecodeHash; +<a class="jxr_linenumber" name="L138" href="#L138">138</a> } +<a class="jxr_linenumber" name="L139" href="#L139">139</a> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">public</strong> String getBytecodeHash() { +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">return</strong> bytecodeHash; +<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">public</strong> <strong class="jxr_keyword">boolean</strong> isDebugPresent() { +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">return</strong> jarClasses.isDebugPresent(); +<a class="jxr_linenumber" name="L146" href="#L146">146</a> } +<a class="jxr_linenumber" name="L147" href="#L147">147</a> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setJarClasses(<a name="JarClasses" href="../../../../../org/apache/maven/shared/jar/classes/JarClasses.html#JarClasses">JarClasses</a> jarClasses) { +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">this</strong>.jarClasses = jarClasses; +<a class="jxr_linenumber" name="L150" href="#L150">150</a> } +<a class="jxr_linenumber" name="L151" href="#L151">151</a> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getNumEntries() { +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">return</strong> entries.size(); +<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getNumClasses() { +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">return</strong> jarClasses.getClassNames().size(); +<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> getNumPackages() { +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <strong class="jxr_keyword">return</strong> jarClasses.getPackages().size(); +<a class="jxr_linenumber" name="L162" href="#L162">162</a> } +<a class="jxr_linenumber" name="L163" href="#L163">163</a> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">public</strong> String getJdkRevision() { +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">return</strong> jarClasses.getJdkRevision(); +<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">public</strong> <strong class="jxr_keyword">void</strong> setJarIdentification(<a name="JarIdentification" href="../../../../../org/apache/maven/shared/jar/identification/JarIdentification.html#JarIdentification">JarIdentification</a> jarIdentification) { +<a class="jxr_linenumber" name="L169" href="#L169">169</a> <strong class="jxr_keyword">this</strong>.jarIdentification = jarIdentification; +<a class="jxr_linenumber" name="L170" href="#L170">170</a> } +<a class="jxr_linenumber" name="L171" href="#L171">171</a> +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">public</strong> <a name="JarIdentification" href="../../../../../org/apache/maven/shared/jar/identification/JarIdentification.html#JarIdentification">JarIdentification</a> getJarIdentification() { +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">return</strong> jarIdentification; +<a class="jxr_linenumber" name="L174" href="#L174">174</a> } +<a class="jxr_linenumber" name="L175" href="#L175">175</a> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> <strong class="jxr_keyword">public</strong> <a name="JarClasses" href="../../../../../org/apache/maven/shared/jar/classes/JarClasses.html#JarClasses">JarClasses</a> getJarClasses() { +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">return</strong> jarClasses; +<a class="jxr_linenumber" name="L178" href="#L178">178</a> } +<a class="jxr_linenumber" name="L179" href="#L179">179</a> +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setVersionedRuntimes(<a name="JarVersionedRuntimes" href="../../../../../org/apache/maven/shared/jar/classes/JarVersionedRuntimes.html#JarVersionedRuntimes">JarVersionedRuntimes</a> versionedRuntimess) { +<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong class="jxr_keyword">this</strong>.versionedRuntimes = versionedRuntimess; +<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> <strong class="jxr_keyword">public</strong> <a name="JarVersionedRuntimes" href="../../../../../org/apache/maven/shared/jar/classes/JarVersionedRuntimes.html#JarVersionedRuntimes">JarVersionedRuntimes</a> getVersionedRuntimes() { +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.versionedRuntimes; +<a class="jxr_linenumber" name="L186" href="#L186">186</a> } +<a class="jxr_linenumber" name="L187" href="#L187">187</a> +<a class="jxr_linenumber" name="L188" href="#L188">188</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isAttributePresent(Attributes.Name attrName) { +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong>.manifest != <strong class="jxr_keyword">null</strong>) { +<a class="jxr_linenumber" name="L190" href="#L190">190</a> String sval = <strong class="jxr_keyword">this</strong>.manifest.getMainAttributes().getValue(attrName); +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">return</strong> sval != <strong class="jxr_keyword">null</strong> && <span class="jxr_string">"true"</span>.equalsIgnoreCase(sval.trim()); +<a class="jxr_linenumber" name="L192" href="#L192">192</a> } +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <strong class="jxr_keyword">return</strong> false; +<a class="jxr_linenumber" name="L194" href="#L194">194</a> } +<a class="jxr_linenumber" name="L195" href="#L195">195</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2002–2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> </html> \ No newline at end of file
Modified: maven/website/components/shared-archives/maven-shared-jar-LATEST/xref/org/apache/maven/shared/jar/classes/ImportVisitor.html ============================================================================== --- maven/website/components/shared-archives/maven-shared-jar-LATEST/xref/org/apache/maven/shared/jar/classes/ImportVisitor.html (original) +++ maven/website/components/shared-archives/maven-shared-jar-LATEST/xref/org/apache/maven/shared/jar/classes/ImportVisitor.html Sat Jun 1 19:47:09 2024 @@ -1,180 +1,180 @@ -<!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>ImportVisitor xref</title> -<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> -</head> -<body> -<div id="overview"><a href="../../../../../../../apidocs/org/apache/maven/shared/jar/classes/ImportVisitor.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.maven.shared.jar.classes; -<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.util.ArrayList; -<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.List; -<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.regex.Matcher; -<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.regex.Pattern; -<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.bcel.classfile.ConstantClass; -<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.bcel.classfile.ConstantUtf8; -<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.bcel.classfile.EmptyVisitor; -<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.bcel.classfile.JavaClass; -<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.commons.collections4.list.SetUniqueList; -<a class="jxr_linenumber" name="L31" href="#L31">31</a> -<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * Implementation of a BCEL class visitor that analyzes a class and collects imports.</em> -<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="ImportVisitor" href="../../../../../../org/apache/maven/shared/jar/classes/ImportVisitor.html#ImportVisitor">ImportVisitor</a> <strong class="jxr_keyword">extends</strong> EmptyVisitor { -<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"> * The list of imports discovered.</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">private</strong> <strong class="jxr_keyword">final</strong> List<String> imports; -<a class="jxr_linenumber" name="L40" href="#L40">40</a> -<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * The Java class that is being analyzed.</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">private</strong> <strong class="jxr_keyword">final</strong> JavaClass javaClass; -<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"> * Pattern to detect if the import is qualified and allows retrieval of the actual import name from the string via</em> -<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * the group 1.</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">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Pattern QUALIFIED_IMPORT_PATTERN = Pattern.compile(<span class="jxr_string">"L([a-zA-Z][a-zA-Z0-9\\.]+);"</span>); -<a class="jxr_linenumber" name="L51" href="#L51">51</a> -<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * Pattern that checks whether a string is valid UTF-8. Imports that are not are ignored.</em> -<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Pattern VALID_UTF8_PATTERN = Pattern.compile(<span class="jxr_string">"^[\\(\\)\\[A-Za-z0-9;/]+$"</span>); -<a class="jxr_linenumber" name="L56" href="#L56">56</a> -<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * Create an Import visitor.</em> -<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @param javaClass the javaclass to work from</em> -<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">public</strong> <a name="ImportVisitor" href="../../../../../../org/apache/maven/shared/jar/classes/ImportVisitor.html#ImportVisitor">ImportVisitor</a>(JavaClass javaClass) { -<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">this</strong>.javaClass = javaClass; -<a class="jxr_linenumber" name="L64" href="#L64">64</a> -<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_comment">// Create a list that is guaranteed to be unique while retaining it's list qualities (LinkedHashSet does not</em> -<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_comment">// expose the list interface even if natural ordering is retained)</em> -<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">this</strong>.imports = SetUniqueList.setUniqueList(<strong class="jxr_keyword">new</strong> ArrayList<>()); -<a class="jxr_linenumber" name="L68" href="#L68">68</a> } -<a class="jxr_linenumber" name="L69" href="#L69">69</a> -<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * Get the list of discovered imports.</em> -<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * @return Returns the imports.</em> -<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">public</strong> List<String> getImports() { -<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">return</strong> imports; -<a class="jxr_linenumber" name="L77" href="#L77">77</a> } -<a class="jxr_linenumber" name="L78" href="#L78">78</a> -<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * Find any formally declared import in the Constant Pool.</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> <em class="jxr_javadoccomment"> * @see org.apache.bcel.classfile.EmptyVisitor#visitConstantClass(org.apache.bcel.classfile.ConstantClass)</em> -<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L84" href="#L84">84</a> @Override -<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> visitConstantClass(ConstantClass constantClass) { -<a class="jxr_linenumber" name="L86" href="#L86">86</a> String name = constantClass.getBytes(javaClass.getConstantPool()); -<a class="jxr_linenumber" name="L87" href="#L87">87</a> -<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_comment">// only strings with '/' character are to be considered.</em> -<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">if</strong> (name.indexOf('/') == -1) { -<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">return</strong>; -<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> name = name.replace('/', '.'); -<a class="jxr_linenumber" name="L94" href="#L94">94</a> -<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">if</strong> (name.endsWith(<span class="jxr_string">".class"</span>)) { -<a class="jxr_linenumber" name="L96" href="#L96">96</a> name = name.substring(0, name.length() - 6); -<a class="jxr_linenumber" name="L97" href="#L97">97</a> } -<a class="jxr_linenumber" name="L98" href="#L98">98</a> -<a class="jxr_linenumber" name="L99" href="#L99">99</a> Matcher mat = QUALIFIED_IMPORT_PATTERN.matcher(name); -<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">if</strong> (mat.find()) { -<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">this</strong>.imports.add(mat.group(1)); -<a class="jxr_linenumber" name="L102" href="#L102">102</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">this</strong>.imports.add(name); -<a class="jxr_linenumber" name="L104" href="#L104">104</a> } -<a class="jxr_linenumber" name="L105" href="#L105">105</a> } -<a class="jxr_linenumber" name="L106" href="#L106">106</a> -<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * Find any package class Strings in the UTF8 String Pool.</em> -<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * @see org.apache.bcel.classfile.EmptyVisitor#visitConstantUtf8(org.apache.bcel.classfile.ConstantUtf8)</em> -<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="L112" href="#L112">112</a> @Override -<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> visitConstantUtf8(ConstantUtf8 constantUtf8) { -<a class="jxr_linenumber" name="L114" href="#L114">114</a> String ret = constantUtf8.getBytes().trim(); -<a class="jxr_linenumber" name="L115" href="#L115">115</a> -<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_comment">// empty strings are not class names.</em> -<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">if</strong> (ret.length() <= 0) { -<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L119" href="#L119">119</a> } -<a class="jxr_linenumber" name="L120" href="#L120">120</a> -<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_comment">// Only valid characters please.</em> -<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">if</strong> (!VALID_UTF8_PATTERN.matcher(ret).matches()) { -<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">return</strong>; -<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_comment">// only strings with '/' character are to be considered.</em> -<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">if</strong> (ret.indexOf('/') == -1) { -<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L129" href="#L129">129</a> } -<a class="jxr_linenumber" name="L130" href="#L130">130</a> -<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_comment">// Strings that start with '/' are bad too</em> -<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_comment">// Seen when Pool has regex patterns.</em> -<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">if</strong> (ret.charAt(0) == '/') { -<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L135" href="#L135">135</a> } -<a class="jxr_linenumber" name="L136" href="#L136">136</a> -<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_comment">// Make string more class-like.</em> -<a class="jxr_linenumber" name="L138" href="#L138">138</a> ret = ret.replace('/', '.'); -<a class="jxr_linenumber" name="L139" href="#L139">139</a> -<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_comment">// Double ".." indicates a bad class fail-fast.</em> -<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_comment">// Seen when ConstantUTF8 Pool has regex patterns.</em> -<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">if</strong> (ret.contains(<span class="jxr_string">".."</span>)) { -<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="L144" href="#L144">144</a> } -<a class="jxr_linenumber" name="L145" href="#L145">145</a> -<a class="jxr_linenumber" name="L146" href="#L146">146</a> Matcher mat = QUALIFIED_IMPORT_PATTERN.matcher(ret); -<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">char</strong> prefix = ret.charAt(0); -<a class="jxr_linenumber" name="L148" href="#L148">148</a> -<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">if</strong> (prefix == '(') { -<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_comment">// A Method Declaration.</em> -<a class="jxr_linenumber" name="L151" href="#L151">151</a> -<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_comment">// Loop for each Qualified Class found.</em> -<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">while</strong> (mat.find()) { -<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">this</strong>.imports.add(mat.group(1)); -<a class="jxr_linenumber" name="L155" href="#L155">155</a> } -<a class="jxr_linenumber" name="L156" href="#L156">156</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_comment">// A Variable Declaration.</em> -<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">if</strong> (mat.find()) { -<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_comment">// Add a UTF8 Qualified Class reference.</em> -<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">this</strong>.imports.add(mat.group(1)); -<a class="jxr_linenumber" name="L161" href="#L161">161</a> } <strong class="jxr_keyword">else</strong> { -<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_comment">// Add a simple Class reference.</em> -<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">this</strong>.imports.add(ret); -<a class="jxr_linenumber" name="L164" href="#L164">164</a> } -<a class="jxr_linenumber" name="L165" href="#L165">165</a> } -<a class="jxr_linenumber" name="L166" href="#L166">166</a> } -<a class="jxr_linenumber" name="L167" href="#L167">167</a> } -</pre> -<hr/> -<div id="footer">Copyright © 2002–2023 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> -</body> +<!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>ImportVisitor xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../../apidocs/org/apache/maven/shared/jar/classes/ImportVisitor.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.maven.shared.jar.classes; +<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.util.ArrayList; +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.util.List; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.regex.Matcher; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.regex.Pattern; +<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.bcel.classfile.ConstantClass; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> org.apache.bcel.classfile.ConstantUtf8; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> org.apache.bcel.classfile.EmptyVisitor; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> <strong class="jxr_keyword">import</strong> org.apache.bcel.classfile.JavaClass; +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <strong class="jxr_keyword">import</strong> org.apache.commons.collections4.list.SetUniqueList; +<a class="jxr_linenumber" name="L31" href="#L31">31</a> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * Implementation of a BCEL class visitor that analyzes a class and collects imports.</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="ImportVisitor" href="../../../../../../org/apache/maven/shared/jar/classes/ImportVisitor.html#ImportVisitor">ImportVisitor</a> <strong class="jxr_keyword">extends</strong> EmptyVisitor { +<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"> * The list of imports discovered.</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">private</strong> <strong class="jxr_keyword">final</strong> List<String> imports; +<a class="jxr_linenumber" name="L40" href="#L40">40</a> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * The Java class that is being analyzed.</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">private</strong> <strong class="jxr_keyword">final</strong> JavaClass javaClass; +<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"> * Pattern to detect if the import is qualified and allows retrieval of the actual import name from the string via</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * the group 1.</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">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Pattern QUALIFIED_IMPORT_PATTERN = Pattern.compile(<span class="jxr_string">"L([a-zA-Z][a-zA-Z0-9\\.]+);"</span>); +<a class="jxr_linenumber" name="L51" href="#L51">51</a> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * Pattern that checks whether a string is valid UTF-8. Imports that are not are ignored.</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Pattern VALID_UTF8_PATTERN = Pattern.compile(<span class="jxr_string">"^[\\(\\)\\[A-Za-z0-9;/]+$"</span>); +<a class="jxr_linenumber" name="L56" href="#L56">56</a> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * Create an Import visitor.</em> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * @param javaClass the javaclass to work from</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">public</strong> <a name="ImportVisitor" href="../../../../../../org/apache/maven/shared/jar/classes/ImportVisitor.html#ImportVisitor">ImportVisitor</a>(JavaClass javaClass) { +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">this</strong>.javaClass = javaClass; +<a class="jxr_linenumber" name="L64" href="#L64">64</a> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_comment">// Create a list that is guaranteed to be unique while retaining it's list qualities (LinkedHashSet does not</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_comment">// expose the list interface even if natural ordering is retained)</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <strong class="jxr_keyword">this</strong>.imports = SetUniqueList.setUniqueList(<strong class="jxr_keyword">new</strong> ArrayList<>()); +<a class="jxr_linenumber" name="L68" href="#L68">68</a> } +<a class="jxr_linenumber" name="L69" href="#L69">69</a> +<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> * Get the list of discovered imports.</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * @return Returns the imports.</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">public</strong> List<String> getImports() { +<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">return</strong> imports; +<a class="jxr_linenumber" name="L77" href="#L77">77</a> } +<a class="jxr_linenumber" name="L78" href="#L78">78</a> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * Find any formally declared import in the Constant Pool.</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> <em class="jxr_javadoccomment"> * @see org.apache.bcel.classfile.EmptyVisitor#visitConstantClass(org.apache.bcel.classfile.ConstantClass)</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> @Override +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> visitConstantClass(ConstantClass constantClass) { +<a class="jxr_linenumber" name="L86" href="#L86">86</a> String name = constantClass.getBytes(javaClass.getConstantPool()); +<a class="jxr_linenumber" name="L87" href="#L87">87</a> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_comment">// only strings with '/' character are to be considered.</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">if</strong> (name.indexOf('/') == -1) { +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">return</strong>; +<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> name = name.replace('/', '.'); +<a class="jxr_linenumber" name="L94" href="#L94">94</a> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">if</strong> (name.endsWith(<span class="jxr_string">".class"</span>)) { +<a class="jxr_linenumber" name="L96" href="#L96">96</a> name = name.substring(0, name.length() - 6); +<a class="jxr_linenumber" name="L97" href="#L97">97</a> } +<a class="jxr_linenumber" name="L98" href="#L98">98</a> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> Matcher mat = QUALIFIED_IMPORT_PATTERN.matcher(name); +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">if</strong> (mat.find()) { +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">this</strong>.imports.add(mat.group(1)); +<a class="jxr_linenumber" name="L102" href="#L102">102</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <strong class="jxr_keyword">this</strong>.imports.add(name); +<a class="jxr_linenumber" name="L104" href="#L104">104</a> } +<a class="jxr_linenumber" name="L105" href="#L105">105</a> } +<a class="jxr_linenumber" name="L106" href="#L106">106</a> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> * Find any package class Strings in the UTF8 String Pool.</em> +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * @see org.apache.bcel.classfile.EmptyVisitor#visitConstantUtf8(org.apache.bcel.classfile.ConstantUtf8)</em> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> @Override +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> visitConstantUtf8(ConstantUtf8 constantUtf8) { +<a class="jxr_linenumber" name="L114" href="#L114">114</a> String ret = constantUtf8.getBytes().trim(); +<a class="jxr_linenumber" name="L115" href="#L115">115</a> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_comment">// empty strings are not class names.</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">if</strong> (ret.length() <= 0) { +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L119" href="#L119">119</a> } +<a class="jxr_linenumber" name="L120" href="#L120">120</a> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_comment">// Only valid characters please.</em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">if</strong> (!VALID_UTF8_PATTERN.matcher(ret).matches()) { +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <strong class="jxr_keyword">return</strong>; +<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_comment">// only strings with '/' character are to be considered.</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <strong class="jxr_keyword">if</strong> (ret.indexOf('/') == -1) { +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L129" href="#L129">129</a> } +<a class="jxr_linenumber" name="L130" href="#L130">130</a> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_comment">// Strings that start with '/' are bad too</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_comment">// Seen when Pool has regex patterns.</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">if</strong> (ret.charAt(0) == '/') { +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L135" href="#L135">135</a> } +<a class="jxr_linenumber" name="L136" href="#L136">136</a> +<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em class="jxr_comment">// Make string more class-like.</em> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> ret = ret.replace('/', '.'); +<a class="jxr_linenumber" name="L139" href="#L139">139</a> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_comment">// Double ".." indicates a bad class fail-fast.</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_comment">// Seen when ConstantUTF8 Pool has regex patterns.</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong class="jxr_keyword">if</strong> (ret.contains(<span class="jxr_string">".."</span>)) { +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L144" href="#L144">144</a> } +<a class="jxr_linenumber" name="L145" href="#L145">145</a> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> Matcher mat = QUALIFIED_IMPORT_PATTERN.matcher(ret); +<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong class="jxr_keyword">char</strong> prefix = ret.charAt(0); +<a class="jxr_linenumber" name="L148" href="#L148">148</a> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <strong class="jxr_keyword">if</strong> (prefix == '(') { +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_comment">// A Method Declaration.</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_comment">// Loop for each Qualified Class found.</em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">while</strong> (mat.find()) { +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <strong class="jxr_keyword">this</strong>.imports.add(mat.group(1)); +<a class="jxr_linenumber" name="L155" href="#L155">155</a> } +<a class="jxr_linenumber" name="L156" href="#L156">156</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_comment">// A Variable Declaration.</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">if</strong> (mat.find()) { +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_comment">// Add a UTF8 Qualified Class reference.</em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <strong class="jxr_keyword">this</strong>.imports.add(mat.group(1)); +<a class="jxr_linenumber" name="L161" href="#L161">161</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_comment">// Add a simple Class reference.</em> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <strong class="jxr_keyword">this</strong>.imports.add(ret); +<a class="jxr_linenumber" name="L164" href="#L164">164</a> } +<a class="jxr_linenumber" name="L165" href="#L165">165</a> } +<a class="jxr_linenumber" name="L166" href="#L166">166</a> } +<a class="jxr_linenumber" name="L167" href="#L167">167</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2002–2024 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> </html> \ No newline at end of file
