| <!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=ISO-8859-1" /> |
| <title>ClassMap xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/velocity/util/introspection/ClassMap.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.velocity.util.introspection; |
| <a name="2" href="#2">2</a> |
| <a name="3" href="#3">3</a> <em class="jxr_comment">/*</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> *</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="19" href="#19">19</a> <em class="jxr_comment"> * under the License. </em> |
| <a name="20" href="#20">20</a> <em class="jxr_comment"> */</em> |
| <a name="21" href="#21">21</a> |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.lang.reflect.Method; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.lang.reflect.Modifier; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.HashMap; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.List; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.Map; |
| <a name="29" href="#29">29</a> |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.log.Log; |
| <a name="31" href="#31">31</a> |
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * A cache of introspection information for a specific class instance.</em> |
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * Keys {@link java.lang.reflect.Method} objects by a concatenation of the</em> |
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * method name and the names of classes that make up the parameters.</em> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:jvanzyl@apache.org" target="alexandria_uri">mailto:jvanzyl@apache.org</a>">Jason van Zyl</a></em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:bob@werken.com" target="alexandria_uri">mailto:bob@werken.com</a>">Bob McWhirter</a></em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:szegedia@freemail.hu" target="alexandria_uri">mailto:szegedia@freemail.hu</a>">Attila Szegedi</a></em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:geirm@optonline.net" target="alexandria_uri">mailto:geirm@optonline.net</a>">Geir Magnusson Jr.</a></em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:henning@apache.org" target="alexandria_uri">mailto:henning@apache.org</a>">Henning P. Schmiedehausen</a></em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @version $Id: ClassMap.java 477003 2006-11-20 01:14:22Z henning $</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="44" href="#44">44</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/velocity/util/introspection/ClassMap.html">ClassMap</a> |
| <a name="45" href="#45">45</a> { |
| <a name="46" href="#46">46</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Set true if you want to debug the reflection code */</em> |
| <a name="47" href="#47">47</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> debugReflection = false; |
| <a name="48" href="#48">48</a> |
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Class logger */</em> |
| <a name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/velocity/runtime/log/Log.html">Log</a> log; |
| <a name="51" href="#51">51</a> |
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * Class passed into the constructor used to as</em> |
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * the basis for the Method map.</em> |
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="56" href="#56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Class clazz; |
| <a name="57" href="#57">57</a> |
| <a name="58" href="#58">58</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/velocity/util/introspection/ClassMap.html">MethodCache</a> methodCache; |
| <a name="59" href="#59">59</a> |
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * Standard constructor</em> |
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @param clazz The class for which this ClassMap gets constructed.</em> |
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="64" href="#64">64</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/velocity/util/introspection/ClassMap.html">ClassMap</a>(<strong class="jxr_keyword">final</strong> Class clazz, <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/velocity/runtime/log/Log.html">Log</a> log) |
| <a name="65" href="#65">65</a> { |
| <a name="66" href="#66">66</a> <strong class="jxr_keyword">this</strong>.clazz = clazz; |
| <a name="67" href="#67">67</a> <strong class="jxr_keyword">this</strong>.log = log; |
| <a name="68" href="#68">68</a> |
| <a name="69" href="#69">69</a> <strong class="jxr_keyword">if</strong> (debugReflection && log.isDebugEnabled()) |
| <a name="70" href="#70">70</a> { |
| <a name="71" href="#71">71</a> log.debug(<span class="jxr_string">"================================================================="</span>); |
| <a name="72" href="#72">72</a> log.debug(<span class="jxr_string">"== Class: "</span> + clazz); |
| <a name="73" href="#73">73</a> } |
| <a name="74" href="#74">74</a> |
| <a name="75" href="#75">75</a> methodCache = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/util/introspection/ClassMap.html">MethodCache</a>(log); |
| <a name="76" href="#76">76</a> |
| <a name="77" href="#77">77</a> populateMethodCache(); |
| <a name="78" href="#78">78</a> |
| <a name="79" href="#79">79</a> <strong class="jxr_keyword">if</strong> (debugReflection && log.isDebugEnabled()) |
| <a name="80" href="#80">80</a> { |
| <a name="81" href="#81">81</a> log.debug(<span class="jxr_string">"================================================================="</span>); |
| <a name="82" href="#82">82</a> } |
| <a name="83" href="#83">83</a> } |
| <a name="84" href="#84">84</a> |
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * Returns the class object whose methods are cached by this map.</em> |
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @return The class object whose methods are cached by this map.</em> |
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="90" href="#90">90</a> <strong class="jxr_keyword">public</strong> Class getCachedClass() |
| <a name="91" href="#91">91</a> { |
| <a name="92" href="#92">92</a> <strong class="jxr_keyword">return</strong> clazz; |
| <a name="93" href="#93">93</a> } |
| <a name="94" href="#94">94</a> |
| <a name="95" href="#95">95</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * Find a Method using the method name and parameter objects.</em> |
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * @param name The method name to look up.</em> |
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * @param params An array of parameters for the method.</em> |
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * @return A Method object representing the method to invoke or null.</em> |
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * @throws MethodMap.AmbiguousException When more than one method is a match for the parameters.</em> |
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="103" href="#103">103</a> <strong class="jxr_keyword">public</strong> Method findMethod(<strong class="jxr_keyword">final</strong> String name, <strong class="jxr_keyword">final</strong> Object[] params) |
| <a name="104" href="#104">104</a> <strong class="jxr_keyword">throws</strong> MethodMap.AmbiguousException |
| <a name="105" href="#105">105</a> { |
| <a name="106" href="#106">106</a> <strong class="jxr_keyword">return</strong> methodCache.get(name, params); |
| <a name="107" href="#107">107</a> } |
| <a name="108" href="#108">108</a> |
| <a name="109" href="#109">109</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * Populate the Map of direct hits. These</em> |
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * are taken from all the public methods</em> |
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * that our class, its parents and their implemented interfaces provide.</em> |
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="114" href="#114">114</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> populateMethodCache() |
| <a name="115" href="#115">115</a> { |
| <a name="116" href="#116">116</a> <em class="jxr_comment">//</em> |
| <a name="117" href="#117">117</a> <em class="jxr_comment">// Build a list of all elements in the class hierarchy. This one is bottom-first (i.e. we start</em> |
| <a name="118" href="#118">118</a> <em class="jxr_comment">// with the actual declaring class and its interfaces and then move up (superclass etc.) until we</em> |
| <a name="119" href="#119">119</a> <em class="jxr_comment">// hit java.lang.Object. That is important because it will give us the methods of the declaring class</em> |
| <a name="120" href="#120">120</a> <em class="jxr_comment">// which might in turn be abstract further up the tree.</em> |
| <a name="121" href="#121">121</a> <em class="jxr_comment">//</em> |
| <a name="122" href="#122">122</a> <em class="jxr_comment">// We also ignore all SecurityExceptions that might happen due to SecurityManager restrictions (prominently </em> |
| <a name="123" href="#123">123</a> <em class="jxr_comment">// hit with Tomcat 5.5).</em> |
| <a name="124" href="#124">124</a> <em class="jxr_comment">//</em> |
| <a name="125" href="#125">125</a> <em class="jxr_comment">// We can also omit all that complicated getPublic, getAccessible and upcast logic that the class map had up</em> |
| <a name="126" href="#126">126</a> <em class="jxr_comment">// until Velocity 1.4. As we always reflect all elements of the tree (that's what we have a cache for), we will</em> |
| <a name="127" href="#127">127</a> <em class="jxr_comment">// hit the public elements sooner or later because we reflect all the public elements anyway.</em> |
| <a name="128" href="#128">128</a> <em class="jxr_comment">//</em> |
| <a name="129" href="#129">129</a> List classesToReflect = <strong class="jxr_keyword">new</strong> ArrayList(); |
| <a name="130" href="#130">130</a> |
| <a name="131" href="#131">131</a> <em class="jxr_comment">// Ah, the miracles of Java for(;;) ... </em> |
| <a name="132" href="#132">132</a> <strong class="jxr_keyword">for</strong> (Class classToReflect = getCachedClass(); classToReflect != <strong class="jxr_keyword">null</strong> ; classToReflect = classToReflect.getSuperclass()) |
| <a name="133" href="#133">133</a> { |
| <a name="134" href="#134">134</a> <strong class="jxr_keyword">if</strong> (Modifier.isPublic(classToReflect.getModifiers())) |
| <a name="135" href="#135">135</a> { |
| <a name="136" href="#136">136</a> classesToReflect.add(classToReflect); |
| <a name="137" href="#137">137</a> <strong class="jxr_keyword">if</strong> (debugReflection && log.isDebugEnabled()) |
| <a name="138" href="#138">138</a> { |
| <a name="139" href="#139">139</a> log.debug(<span class="jxr_string">"Adding "</span> + classToReflect + <span class="jxr_string">" for reflection"</span>); |
| <a name="140" href="#140">140</a> } |
| <a name="141" href="#141">141</a> } |
| <a name="142" href="#142">142</a> Class [] interfaces = classToReflect.getInterfaces(); |
| <a name="143" href="#143">143</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < interfaces.length; i++) |
| <a name="144" href="#144">144</a> { |
| <a name="145" href="#145">145</a> <strong class="jxr_keyword">if</strong> (Modifier.isPublic(interfaces[i].getModifiers())) |
| <a name="146" href="#146">146</a> { |
| <a name="147" href="#147">147</a> classesToReflect.add(interfaces[i]); |
| <a name="148" href="#148">148</a> <strong class="jxr_keyword">if</strong> (debugReflection && log.isDebugEnabled()) |
| <a name="149" href="#149">149</a> { |
| <a name="150" href="#150">150</a> log.debug(<span class="jxr_string">"Adding "</span> + interfaces[i] + <span class="jxr_string">" for reflection"</span>); |
| <a name="151" href="#151">151</a> } |
| <a name="152" href="#152">152</a> } |
| <a name="153" href="#153">153</a> } |
| <a name="154" href="#154">154</a> } |
| <a name="155" href="#155">155</a> |
| <a name="156" href="#156">156</a> <strong class="jxr_keyword">for</strong> (Iterator it = classesToReflect.iterator(); it.hasNext(); ) |
| <a name="157" href="#157">157</a> { |
| <a name="158" href="#158">158</a> Class classToReflect = (Class) it.next(); |
| <a name="159" href="#159">159</a> <strong class="jxr_keyword">if</strong> (debugReflection && log.isDebugEnabled()) |
| <a name="160" href="#160">160</a> { |
| <a name="161" href="#161">161</a> log.debug(<span class="jxr_string">"Reflecting "</span> + classToReflect); |
| <a name="162" href="#162">162</a> } |
| <a name="163" href="#163">163</a> |
| <a name="164" href="#164">164</a> |
| <a name="165" href="#165">165</a> <strong class="jxr_keyword">try</strong> |
| <a name="166" href="#166">166</a> { |
| <a name="167" href="#167">167</a> Method[] methods = classToReflect.getMethods(); |
| <a name="168" href="#168">168</a> |
| <a name="169" href="#169">169</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < methods.length; i++) |
| <a name="170" href="#170">170</a> { |
| <a name="171" href="#171">171</a> <em class="jxr_comment">// Strictly spoken that check shouldn't be necessary</em> |
| <a name="172" href="#172">172</a> <em class="jxr_comment">// because getMethods only returns public methods.</em> |
| <a name="173" href="#173">173</a> <strong class="jxr_keyword">int</strong> modifiers = methods[i].getModifiers(); |
| <a name="174" href="#174">174</a> <strong class="jxr_keyword">if</strong> (Modifier.isPublic(modifiers)) <em class="jxr_comment">// && !)</em> |
| <a name="175" href="#175">175</a> { |
| <a name="176" href="#176">176</a> <em class="jxr_comment">// Some of the interfaces contain abstract methods. That is fine, because the actual object must </em> |
| <a name="177" href="#177">177</a> <em class="jxr_comment">// implement them anyway (else it wouldn't be implementing the interface). If we find an abstract</em> |
| <a name="178" href="#178">178</a> <em class="jxr_comment">// method in a non-interface, we skip it, because we do want to make sure that no abstract methods end up in</em> |
| <a name="179" href="#179">179</a> <em class="jxr_comment">// the cache. </em> |
| <a name="180" href="#180">180</a> <strong class="jxr_keyword">if</strong> (classToReflect.isInterface() || !Modifier.isAbstract(modifiers)) |
| <a name="181" href="#181">181</a> { |
| <a name="182" href="#182">182</a> methodCache.put(methods[i]); |
| <a name="183" href="#183">183</a> } |
| <a name="184" href="#184">184</a> } |
| <a name="185" href="#185">185</a> } |
| <a name="186" href="#186">186</a> } |
| <a name="187" href="#187">187</a> <strong class="jxr_keyword">catch</strong> (SecurityException se) <em class="jxr_comment">// Everybody feels better with...</em> |
| <a name="188" href="#188">188</a> { |
| <a name="189" href="#189">189</a> <strong class="jxr_keyword">if</strong> (log.isDebugEnabled()) |
| <a name="190" href="#190">190</a> { |
| <a name="191" href="#191">191</a> log.debug(<span class="jxr_string">"While accessing methods of "</span> + classToReflect + <span class="jxr_string">": "</span>, se); |
| <a name="192" href="#192">192</a> } |
| <a name="193" href="#193">193</a> } |
| <a name="194" href="#194">194</a> } |
| <a name="195" href="#195">195</a> } |
| <a name="196" href="#196">196</a> |
| <a name="197" href="#197">197</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="198" href="#198">198</a> <em class="jxr_javadoccomment"> * This is the cache to store and look up the method information. </em> |
| <a name="199" href="#199">199</a> <em class="jxr_javadoccomment"> * </em> |
| <a name="200" href="#200">200</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:henning@apache.org" target="alexandria_uri">mailto:henning@apache.org</a>">Henning P. Schmiedehausen</a></em> |
| <a name="201" href="#201">201</a> <em class="jxr_javadoccomment"> * @version $Id: ClassMap.java 477003 2006-11-20 01:14:22Z henning $</em> |
| <a name="202" href="#202">202</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="203" href="#203">203</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/velocity/util/introspection/ClassMap.html">MethodCache</a> |
| <a name="204" href="#204">204</a> { |
| <a name="205" href="#205">205</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/velocity/util/introspection/ClassMap.html">CacheMiss</a> { } |
| <a name="206" href="#206">206</a> |
| <a name="207" href="#207">207</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/velocity/util/introspection/ClassMap.html">CacheMiss</a> CACHE_MISS = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/util/introspection/ClassMap.html">CacheMiss</a>(); |
| <a name="208" href="#208">208</a> |
| <a name="209" href="#209">209</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Object OBJECT = <strong class="jxr_keyword">new</strong> Object(); |
| <a name="210" href="#210">210</a> |
| <a name="211" href="#211">211</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Map convertPrimitives = <strong class="jxr_keyword">new</strong> HashMap(); |
| <a name="212" href="#212">212</a> |
| <a name="213" href="#213">213</a> <strong class="jxr_keyword">static</strong> |
| <a name="214" href="#214">214</a> { |
| <a name="215" href="#215">215</a> convertPrimitives.put(Boolean.TYPE, Boolean.<strong class="jxr_keyword">class</strong>.getName()); |
| <a name="216" href="#216">216</a> convertPrimitives.put(Byte.TYPE, Byte.<strong class="jxr_keyword">class</strong>.getName()); |
| <a name="217" href="#217">217</a> convertPrimitives.put(Character.TYPE, Character.<strong class="jxr_keyword">class</strong>.getName()); |
| <a name="218" href="#218">218</a> convertPrimitives.put(Double.TYPE, Double.<strong class="jxr_keyword">class</strong>.getName()); |
| <a name="219" href="#219">219</a> convertPrimitives.put(Float.TYPE, Float.<strong class="jxr_keyword">class</strong>.getName()); |
| <a name="220" href="#220">220</a> convertPrimitives.put(Integer.TYPE, Integer.<strong class="jxr_keyword">class</strong>.getName()); |
| <a name="221" href="#221">221</a> convertPrimitives.put(Long.TYPE, Long.<strong class="jxr_keyword">class</strong>.getName()); |
| <a name="222" href="#222">222</a> convertPrimitives.put(Short.TYPE, Short.<strong class="jxr_keyword">class</strong>.getName()); |
| <a name="223" href="#223">223</a> } |
| <a name="224" href="#224">224</a> |
| <a name="225" href="#225">225</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Class logger */</em> |
| <a name="226" href="#226">226</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/velocity/runtime/log/Log.html">Log</a> log; |
| <a name="227" href="#227">227</a> |
| <a name="228" href="#228">228</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="229" href="#229">229</a> <em class="jxr_javadoccomment"> * Cache of Methods, or CACHE_MISS, keyed by method</em> |
| <a name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * name and actual arguments used to find it.</em> |
| <a name="231" href="#231">231</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="232" href="#232">232</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> Map cache = <strong class="jxr_keyword">new</strong> HashMap(); |
| <a name="233" href="#233">233</a> |
| <a name="234" href="#234">234</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Map of methods that are searchable according to method parameters to find a match */</em> |
| <a name="235" href="#235">235</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/velocity/util/introspection/MethodMap.html">MethodMap</a> methodMap = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/velocity/util/introspection/MethodMap.html">MethodMap</a>(); |
| <a name="236" href="#236">236</a> |
| <a name="237" href="#237">237</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/velocity/util/introspection/ClassMap.html">MethodCache</a>(<a href="../../../../../org/apache/velocity/runtime/log/Log.html">Log</a> log) |
| <a name="238" href="#238">238</a> { |
| <a name="239" href="#239">239</a> <strong class="jxr_keyword">this</strong>.log = log; |
| <a name="240" href="#240">240</a> } |
| <a name="241" href="#241">241</a> |
| <a name="242" href="#242">242</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="243" href="#243">243</a> <em class="jxr_javadoccomment"> * Find a Method using the method name and parameter objects.</em> |
| <a name="244" href="#244">244</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="245" href="#245">245</a> <em class="jxr_javadoccomment"> * Look in the methodMap for an entry. If found,</em> |
| <a name="246" href="#246">246</a> <em class="jxr_javadoccomment"> * it'll either be a CACHE_MISS, in which case we</em> |
| <a name="247" href="#247">247</a> <em class="jxr_javadoccomment"> * simply give up, or it'll be a Method, in which</em> |
| <a name="248" href="#248">248</a> <em class="jxr_javadoccomment"> * case, we return it.</em> |
| <a name="249" href="#249">249</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="250" href="#250">250</a> <em class="jxr_javadoccomment"> * If nothing is found, then we must actually go</em> |
| <a name="251" href="#251">251</a> <em class="jxr_javadoccomment"> * and introspect the method from the MethodMap.</em> |
| <a name="252" href="#252">252</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="253" href="#253">253</a> <em class="jxr_javadoccomment"> * @param name The method name to look up.</em> |
| <a name="254" href="#254">254</a> <em class="jxr_javadoccomment"> * @param params An array of parameters for the method.</em> |
| <a name="255" href="#255">255</a> <em class="jxr_javadoccomment"> * @return A Method object representing the method to invoke or null.</em> |
| <a name="256" href="#256">256</a> <em class="jxr_javadoccomment"> * @throws MethodMap.AmbiguousException When more than one method is a match for the parameters.</em> |
| <a name="257" href="#257">257</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="258" href="#258">258</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> Method get(<strong class="jxr_keyword">final</strong> String name, <strong class="jxr_keyword">final</strong> Object [] params) |
| <a name="259" href="#259">259</a> <strong class="jxr_keyword">throws</strong> MethodMap.AmbiguousException |
| <a name="260" href="#260">260</a> { |
| <a name="261" href="#261">261</a> String methodKey = makeMethodKey(name, params); |
| <a name="262" href="#262">262</a> |
| <a name="263" href="#263">263</a> Object cacheEntry = cache.get(methodKey); |
| <a name="264" href="#264">264</a> |
| <a name="265" href="#265">265</a> <em class="jxr_comment">// We looked this up before and failed. </em> |
| <a name="266" href="#266">266</a> <strong class="jxr_keyword">if</strong> (cacheEntry == CACHE_MISS) |
| <a name="267" href="#267">267</a> { |
| <a name="268" href="#268">268</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>; |
| <a name="269" href="#269">269</a> } |
| <a name="270" href="#270">270</a> |
| <a name="271" href="#271">271</a> <strong class="jxr_keyword">if</strong> (cacheEntry == <strong class="jxr_keyword">null</strong>) |
| <a name="272" href="#272">272</a> { |
| <a name="273" href="#273">273</a> <strong class="jxr_keyword">try</strong> |
| <a name="274" href="#274">274</a> { |
| <a name="275" href="#275">275</a> <em class="jxr_comment">// That one is expensive...</em> |
| <a name="276" href="#276">276</a> cacheEntry = methodMap.find(name, params); |
| <a name="277" href="#277">277</a> } |
| <a name="278" href="#278">278</a> <strong class="jxr_keyword">catch</strong>(MethodMap.AmbiguousException ae) |
| <a name="279" href="#279">279</a> { |
| <a name="280" href="#280">280</a> <em class="jxr_comment">/*</em> |
| <a name="281" href="#281">281</a> <em class="jxr_comment"> * that's a miss :-)</em> |
| <a name="282" href="#282">282</a> <em class="jxr_comment"> */</em> |
| <a name="283" href="#283">283</a> cache.put(methodKey, CACHE_MISS); |
| <a name="284" href="#284">284</a> <strong class="jxr_keyword">throw</strong> ae; |
| <a name="285" href="#285">285</a> } |
| <a name="286" href="#286">286</a> |
| <a name="287" href="#287">287</a> cache.put(methodKey, |
| <a name="288" href="#288">288</a> (cacheEntry != <strong class="jxr_keyword">null</strong>) ? cacheEntry : CACHE_MISS); |
| <a name="289" href="#289">289</a> } |
| <a name="290" href="#290">290</a> |
| <a name="291" href="#291">291</a> <em class="jxr_comment">// Yes, this might just be null.</em> |
| <a name="292" href="#292">292</a> |
| <a name="293" href="#293">293</a> <strong class="jxr_keyword">return</strong> (Method) cacheEntry; |
| <a name="294" href="#294">294</a> } |
| <a name="295" href="#295">295</a> |
| <a name="296" href="#296">296</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">synchronized</strong> <strong class="jxr_keyword">void</strong> put(Method method) |
| <a name="297" href="#297">297</a> { |
| <a name="298" href="#298">298</a> String methodKey = makeMethodKey(method); |
| <a name="299" href="#299">299</a> |
| <a name="300" href="#300">300</a> <em class="jxr_comment">// We don't overwrite methods. Especially not if we fill the</em> |
| <a name="301" href="#301">301</a> <em class="jxr_comment">// cache from defined class towards java.lang.Object because </em> |
| <a name="302" href="#302">302</a> <em class="jxr_comment">// abstract methods in superclasses would else overwrite concrete</em> |
| <a name="303" href="#303">303</a> <em class="jxr_comment">// classes further down the hierarchy.</em> |
| <a name="304" href="#304">304</a> <strong class="jxr_keyword">if</strong> (cache.get(methodKey) == <strong class="jxr_keyword">null</strong>) |
| <a name="305" href="#305">305</a> { |
| <a name="306" href="#306">306</a> cache.put(methodKey, method); |
| <a name="307" href="#307">307</a> methodMap.add(method); |
| <a name="308" href="#308">308</a> <strong class="jxr_keyword">if</strong> (debugReflection && log.isDebugEnabled()) |
| <a name="309" href="#309">309</a> { |
| <a name="310" href="#310">310</a> log.debug(<span class="jxr_string">"Adding "</span> + method); |
| <a name="311" href="#311">311</a> } |
| <a name="312" href="#312">312</a> } |
| <a name="313" href="#313">313</a> } |
| <a name="314" href="#314">314</a> |
| <a name="315" href="#315">315</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="316" href="#316">316</a> <em class="jxr_javadoccomment"> * Make a methodKey for the given method using</em> |
| <a name="317" href="#317">317</a> <em class="jxr_javadoccomment"> * the concatenation of the name and the</em> |
| <a name="318" href="#318">318</a> <em class="jxr_javadoccomment"> * types of the method parameters.</em> |
| <a name="319" href="#319">319</a> <em class="jxr_javadoccomment"> * </em> |
| <a name="320" href="#320">320</a> <em class="jxr_javadoccomment"> * @param method to be stored as key</em> |
| <a name="321" href="#321">321</a> <em class="jxr_javadoccomment"> * @return key for ClassMap</em> |
| <a name="322" href="#322">322</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="323" href="#323">323</a> <strong class="jxr_keyword">private</strong> String makeMethodKey(<strong class="jxr_keyword">final</strong> Method method) |
| <a name="324" href="#324">324</a> { |
| <a name="325" href="#325">325</a> Class[] parameterTypes = method.getParameterTypes(); |
| <a name="326" href="#326">326</a> |
| <a name="327" href="#327">327</a> StringBuffer methodKey = <strong class="jxr_keyword">new</strong> StringBuffer(method.getName()); |
| <a name="328" href="#328">328</a> |
| <a name="329" href="#329">329</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> j = 0; j < parameterTypes.length; j++) |
| <a name="330" href="#330">330</a> { |
| <a name="331" href="#331">331</a> <em class="jxr_comment">/*</em> |
| <a name="332" href="#332">332</a> <em class="jxr_comment"> * If the argument type is primitive then we want</em> |
| <a name="333" href="#333">333</a> <em class="jxr_comment"> * to convert our primitive type signature to the</em> |
| <a name="334" href="#334">334</a> <em class="jxr_comment"> * corresponding Object type so introspection for</em> |
| <a name="335" href="#335">335</a> <em class="jxr_comment"> * methods with primitive types will work correctly.</em> |
| <a name="336" href="#336">336</a> <em class="jxr_comment"> *</em> |
| <a name="337" href="#337">337</a> <em class="jxr_comment"> * The lookup map (convertPrimitives) contains all eight</em> |
| <a name="338" href="#338">338</a> <em class="jxr_comment"> * primitives (boolean, byte, char, double, float, int, long, short)</em> |
| <a name="339" href="#339">339</a> <em class="jxr_comment"> * known to Java. So it should never return null for the key passed in.</em> |
| <a name="340" href="#340">340</a> <em class="jxr_comment"> */</em> |
| <a name="341" href="#341">341</a> <strong class="jxr_keyword">if</strong> (parameterTypes[j].isPrimitive()) |
| <a name="342" href="#342">342</a> { |
| <a name="343" href="#343">343</a> methodKey.append((String) convertPrimitives.get(parameterTypes[j])); |
| <a name="344" href="#344">344</a> } |
| <a name="345" href="#345">345</a> <strong class="jxr_keyword">else</strong> |
| <a name="346" href="#346">346</a> { |
| <a name="347" href="#347">347</a> methodKey.append(parameterTypes[j].getName()); |
| <a name="348" href="#348">348</a> } |
| <a name="349" href="#349">349</a> } |
| <a name="350" href="#350">350</a> |
| <a name="351" href="#351">351</a> <strong class="jxr_keyword">return</strong> methodKey.toString(); |
| <a name="352" href="#352">352</a> } |
| <a name="353" href="#353">353</a> |
| <a name="354" href="#354">354</a> <strong class="jxr_keyword">private</strong> String makeMethodKey(String method, Object[] params) |
| <a name="355" href="#355">355</a> { |
| <a name="356" href="#356">356</a> StringBuffer methodKey = <strong class="jxr_keyword">new</strong> StringBuffer().append(method); |
| <a name="357" href="#357">357</a> |
| <a name="358" href="#358">358</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> j = 0; j < params.length; j++) |
| <a name="359" href="#359">359</a> { |
| <a name="360" href="#360">360</a> Object arg = params[j]; |
| <a name="361" href="#361">361</a> |
| <a name="362" href="#362">362</a> <strong class="jxr_keyword">if</strong> (arg == <strong class="jxr_keyword">null</strong>) |
| <a name="363" href="#363">363</a> { |
| <a name="364" href="#364">364</a> arg = OBJECT; |
| <a name="365" href="#365">365</a> } |
| <a name="366" href="#366">366</a> |
| <a name="367" href="#367">367</a> methodKey.append(arg.getClass().getName()); |
| <a name="368" href="#368">368</a> } |
| <a name="369" href="#369">369</a> |
| <a name="370" href="#370">370</a> <strong class="jxr_keyword">return</strong> methodKey.toString(); |
| <a name="371" href="#371">371</a> } |
| <a name="372" href="#372">372</a> } |
| <a name="373" href="#373">373</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
| |
