blob: f5b916f8e135059969527c80c7cde1952a2f6e50 [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>NullSetEventHandler xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/velocity/app/event/NullSetEventHandler.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.velocity.app.event;
<a name="2" href="#2">2</a>
<a name="3" href="#3">3</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.context.Context;
<a name="4" href="#4">4</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.ContextAware;
<a name="5" href="#5">5</a>
<a name="6" href="#6">6</a> <em class="jxr_comment">/*</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> *</em>
<a name="15" href="#15">15</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="16" href="#16">16</a> <em class="jxr_comment"> *</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="19" href="#19">19</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="20" href="#20">20</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="21" href="#21">21</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="22" href="#22">22</a> <em class="jxr_comment"> * under the License. </em>
<a name="23" href="#23">23</a> <em class="jxr_comment"> */</em>
<a name="24" href="#24">24</a>
<a name="25" href="#25">25</a> <em class="jxr_javadoccomment">/**</em>
<a name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * Event handler called when the RHS of #set is null. Lets an app approve / veto</em>
<a name="27" href="#27">27</a> <em class="jxr_javadoccomment"> * writing a log message based on the specific reference.</em>
<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> *</em>
<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:wglass@forio.com" target="alexandria_uri">mailto:wglass@forio.com</a>"&gt;Will Glass-Husain&lt;/a&gt;</em>
<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:geirm@optonline.net" target="alexandria_uri">mailto:geirm@optonline.net</a>"&gt;Geir Magnusson Jr.&lt;/a&gt;</em>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * @version $Id: NullSetEventHandler.java 470256 2006-11-02 07:20:36Z wglass $</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">interface</strong> <a href="../../../../../org/apache/velocity/app/event/NullSetEventHandler.html">NullSetEventHandler</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/velocity/app/event/EventHandler.html">EventHandler</a>
<a name="34" href="#34">34</a> {
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment">/**</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * Called when the RHS of a #set() is null, which will result</em>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * in a null LHS. All NullSetEventHandlers</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * are called in sequence until a false is returned. If no NullSetEventHandler</em>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * is registered all nulls will be logged.</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> *</em>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @param lhs reference literal of left-hand-side of set statement</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @param rhs reference literal of right-hand-side of set statement</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @return true if log message should be written, false otherwise</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em>
<a name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> shouldLogOnNullSet( String lhs, String rhs );
<a name="46" href="#46">46</a>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment">/**</em>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * Defines the execution strategy for shouldLogOnNullSet</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> */</em>
<a name="50" href="#50">50</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/velocity/app/event/NullSetEventHandler.html">ShouldLogOnNullSetExecutor</a> implements <a href="../../../../../org/apache/velocity/app/event/EventHandlerMethodExecutor.html">EventHandlerMethodExecutor</a>
<a name="51" href="#51">51</a> {
<a name="52" href="#52">52</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/velocity/context/Context.html">Context</a> context;
<a name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> String lhs;
<a name="54" href="#54">54</a> <strong class="jxr_keyword">private</strong> String rhs;
<a name="55" href="#55">55</a>
<a name="56" href="#56">56</a> <em class="jxr_javadoccomment">/**</em>
<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * when this is false, quit iterating</em>
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em>
<a name="59" href="#59">59</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> result = <strong class="jxr_keyword">true</strong>;
<a name="60" href="#60">60</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> executed = false;
<a name="61" href="#61">61</a>
<a name="62" href="#62">62</a> <a href="../../../../../org/apache/velocity/app/event/NullSetEventHandler.html">ShouldLogOnNullSetExecutor</a>(
<a name="63" href="#63">63</a> <a href="../../../../../org/apache/velocity/context/Context.html">Context</a> context,
<a name="64" href="#64">64</a> String lhs,
<a name="65" href="#65">65</a> String rhs)
<a name="66" href="#66">66</a> {
<a name="67" href="#67">67</a> <strong class="jxr_keyword">this</strong>.context = context;
<a name="68" href="#68">68</a> <strong class="jxr_keyword">this</strong>.lhs = lhs;
<a name="69" href="#69">69</a> <strong class="jxr_keyword">this</strong>.rhs = rhs;
<a name="70" href="#70">70</a> }
<a name="71" href="#71">71</a>
<a name="72" href="#72">72</a> <em class="jxr_javadoccomment">/**</em>
<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * Call the method shouldLogOnNullSet()</em>
<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * </em>
<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * @param handler call the appropriate method on this handler</em>
<a name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em>
<a name="77" href="#77">77</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute(<a href="../../../../../org/apache/velocity/app/event/EventHandler.html">EventHandler</a> handler)
<a name="78" href="#78">78</a> {
<a name="79" href="#79">79</a> <a href="../../../../../org/apache/velocity/app/event/NullSetEventHandler.html">NullSetEventHandler</a> eh = (NullSetEventHandler) handler;
<a name="80" href="#80">80</a>
<a name="81" href="#81">81</a> <strong class="jxr_keyword">if</strong> (eh instanceof ContextAware)
<a name="82" href="#82">82</a> ((<a href="../../../../../org/apache/velocity/util/ContextAware.html">ContextAware</a>) eh).setContext(context);
<a name="83" href="#83">83</a>
<a name="84" href="#84">84</a> executed = <strong class="jxr_keyword">true</strong>;
<a name="85" href="#85">85</a> result = ((NullSetEventHandler) handler).shouldLogOnNullSet(lhs, rhs);
<a name="86" href="#86">86</a> }
<a name="87" href="#87">87</a>
<a name="88" href="#88">88</a> <strong class="jxr_keyword">public</strong> Object getReturnValue()
<a name="89" href="#89">89</a> {
<a name="90" href="#90">90</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> Boolean(result);
<a name="91" href="#91">91</a> }
<a name="92" href="#92">92</a>
<a name="93" href="#93">93</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isDone()
<a name="94" href="#94">94</a> {
<a name="95" href="#95">95</a> <strong class="jxr_keyword">return</strong> executed &amp;&amp; !result;
<a name="96" href="#96">96</a> }
<a name="97" href="#97">97</a>
<a name="98" href="#98">98</a>
<a name="99" href="#99">99</a> }
<a name="100" href="#100">100</a>
<a name="101" href="#101">101</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>