blob: d21b8d108688d6e55209d24c7336fcf3544da019 [file] [log] [blame]
<!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>PropertyExecutor xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/velocity/runtime/parser/node/PropertyExecutor.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.velocity.runtime.parser.node;
<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.InvocationTargetException;
<a name="23" href="#23">23</a>
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.commons.lang.StringUtils;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.RuntimeLogger;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.log.Log;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.runtime.log.RuntimeLoggerLog;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.introspection.Introspector;
<a name="29" href="#29">29</a>
<a name="30" href="#30">30</a> <em class="jxr_javadoccomment">/**</em>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * Returned the value of object property when executed.</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> */</em>
<a name="33" href="#33">33</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/velocity/runtime/parser/node/PropertyExecutor.html">PropertyExecutor</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/velocity/runtime/parser/node/AbstractExecutor.html">AbstractExecutor</a>
<a name="34" href="#34">34</a> {
<a name="35" href="#35">35</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/velocity/util/introspection/Introspector.html">Introspector</a> introspector;
<a name="36" href="#36">36</a>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment">/**</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * @param log</em>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * @param introspector</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @param clazz</em>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @param property</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> */</em>
<a name="43" href="#43">43</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/velocity/runtime/parser/node/PropertyExecutor.html">PropertyExecutor</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/velocity/runtime/log/Log.html">Log</a> log, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/velocity/util/introspection/Introspector.html">Introspector</a> introspector,
<a name="44" href="#44">44</a> <strong class="jxr_keyword">final</strong> Class clazz, <strong class="jxr_keyword">final</strong> String property)
<a name="45" href="#45">45</a> {
<a name="46" href="#46">46</a> <strong class="jxr_keyword">this</strong>.log = log;
<a name="47" href="#47">47</a> <strong class="jxr_keyword">this</strong>.introspector = introspector;
<a name="48" href="#48">48</a>
<a name="49" href="#49">49</a> <em class="jxr_comment">// Don't allow passing in the empty string or null because</em>
<a name="50" href="#50">50</a> <em class="jxr_comment">// it will either fail with a StringIndexOutOfBounds error</em>
<a name="51" href="#51">51</a> <em class="jxr_comment">// or the introspector will get confused.</em>
<a name="52" href="#52">52</a> <strong class="jxr_keyword">if</strong> (StringUtils.isNotEmpty(property))
<a name="53" href="#53">53</a> {
<a name="54" href="#54">54</a> discover(clazz, property);
<a name="55" href="#55">55</a> }
<a name="56" href="#56">56</a> }
<a name="57" href="#57">57</a>
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em>
<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * @param r</em>
<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * @param introspector</em>
<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @param clazz</em>
<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @param property</em>
<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @deprecated RuntimeLogger is deprecated. Use the other constructor.</em>
<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> */</em>
<a name="65" href="#65">65</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/velocity/runtime/parser/node/PropertyExecutor.html">PropertyExecutor</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/velocity/runtime/RuntimeLogger.html">RuntimeLogger</a> r, <strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/velocity/util/introspection/Introspector.html">Introspector</a> introspector,
<a name="66" href="#66">66</a> <strong class="jxr_keyword">final</strong> Class clazz, <strong class="jxr_keyword">final</strong> String property)
<a name="67" href="#67">67</a> {
<a name="68" href="#68">68</a> <strong class="jxr_keyword">this</strong>(<strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/velocity/runtime/log/RuntimeLoggerLog.html">RuntimeLoggerLog</a>(r), introspector, clazz, property);
<a name="69" href="#69">69</a> }
<a name="70" href="#70">70</a>
<a name="71" href="#71">71</a> <em class="jxr_javadoccomment">/**</em>
<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @return The current introspector.</em>
<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> */</em>
<a name="74" href="#74">74</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/velocity/util/introspection/Introspector.html">Introspector</a> getIntrospector()
<a name="75" href="#75">75</a> {
<a name="76" href="#76">76</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.introspector;
<a name="77" href="#77">77</a> }
<a name="78" href="#78">78</a>
<a name="79" href="#79">79</a> <em class="jxr_javadoccomment">/**</em>
<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * @param clazz</em>
<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * @param property</em>
<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> */</em>
<a name="83" href="#83">83</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> discover(<strong class="jxr_keyword">final</strong> Class clazz, <strong class="jxr_keyword">final</strong> String property)
<a name="84" href="#84">84</a> {
<a name="85" href="#85">85</a> <em class="jxr_comment">/*</em>
<a name="86" href="#86">86</a> <em class="jxr_comment"> * this is gross and linear, but it keeps it straightforward.</em>
<a name="87" href="#87">87</a> <em class="jxr_comment"> */</em>
<a name="88" href="#88">88</a>
<a name="89" href="#89">89</a> <strong class="jxr_keyword">try</strong>
<a name="90" href="#90">90</a> {
<a name="91" href="#91">91</a> Object [] params = {};
<a name="92" href="#92">92</a>
<a name="93" href="#93">93</a> StringBuffer sb = <strong class="jxr_keyword">new</strong> StringBuffer(<span class="jxr_string">"get"</span>);
<a name="94" href="#94">94</a> sb.append(property);
<a name="95" href="#95">95</a>
<a name="96" href="#96">96</a> setMethod(introspector.getMethod(clazz, sb.toString(), params));
<a name="97" href="#97">97</a>
<a name="98" href="#98">98</a> <strong class="jxr_keyword">if</strong> (!isAlive())
<a name="99" href="#99">99</a> {
<a name="100" href="#100">100</a> <em class="jxr_comment">/*</em>
<a name="101" href="#101">101</a> <em class="jxr_comment"> * now the convenience, flip the 1st character</em>
<a name="102" href="#102">102</a> <em class="jxr_comment"> */</em>
<a name="103" href="#103">103</a>
<a name="104" href="#104">104</a> <strong class="jxr_keyword">char</strong> c = sb.charAt(3);
<a name="105" href="#105">105</a>
<a name="106" href="#106">106</a> <strong class="jxr_keyword">if</strong> (Character.isLowerCase(c))
<a name="107" href="#107">107</a> {
<a name="108" href="#108">108</a> sb.setCharAt(3, Character.toUpperCase(c));
<a name="109" href="#109">109</a> }
<a name="110" href="#110">110</a> <strong class="jxr_keyword">else</strong>
<a name="111" href="#111">111</a> {
<a name="112" href="#112">112</a> sb.setCharAt(3, Character.toLowerCase(c));
<a name="113" href="#113">113</a> }
<a name="114" href="#114">114</a>
<a name="115" href="#115">115</a> setMethod(introspector.getMethod(clazz, sb.toString(), params));
<a name="116" href="#116">116</a> }
<a name="117" href="#117">117</a> }
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">/**</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * pass through application level runtime exceptions</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment"> */</em>
<a name="121" href="#121">121</a> <strong class="jxr_keyword">catch</strong>( RuntimeException e )
<a name="122" href="#122">122</a> {
<a name="123" href="#123">123</a> <strong class="jxr_keyword">throw</strong> e;
<a name="124" href="#124">124</a> }
<a name="125" href="#125">125</a> <strong class="jxr_keyword">catch</strong>(Exception e)
<a name="126" href="#126">126</a> {
<a name="127" href="#127">127</a> log.error(<span class="jxr_string">"While looking for property getter for '"</span> + property + <span class="jxr_string">"':"</span>, e);
<a name="128" href="#128">128</a> }
<a name="129" href="#129">129</a> }
<a name="130" href="#130">130</a>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">/**</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.runtime.parser.node.AbstractExecutor#execute(java.lang.Object)</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> */</em>
<a name="134" href="#134">134</a> <strong class="jxr_keyword">public</strong> Object execute(Object o)
<a name="135" href="#135">135</a> <strong class="jxr_keyword">throws</strong> IllegalAccessException, InvocationTargetException
<a name="136" href="#136">136</a> {
<a name="137" href="#137">137</a> <strong class="jxr_keyword">return</strong> isAlive() ? getMethod().invoke(o, ((Object []) <strong class="jxr_keyword">null</strong>)) : <strong class="jxr_keyword">null</strong>;
<a name="138" href="#138">138</a> }
<a name="139" href="#139">139</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>