| <!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>VelocityContext xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../apidocs/org/apache/velocity/VelocityContext.html">View Javadoc</a></div><pre> |
|
|
| <a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.velocity;
|
| <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.util.HashMap;
|
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.Map;
|
| <a name="24" href="#24">24</a>
|
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.context.AbstractContext;
|
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.context.Context;
|
| <a name="27" href="#27">27</a>
|
| <a name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * General purpose implemention of the application Context</em>
|
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * interface for general application use. This class should</em>
|
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * be used in place of the original Context class.</em>
|
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * This implementation uses a HashMap (@see java.util.HashMap )</em>
|
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * for data storage.</em>
|
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * This context implementation cannot be shared between threads</em>
|
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * without those threads synchronizing access between them, as</em>
|
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * the HashMap is not synchronized, nor are some of the fundamentals</em>
|
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * of AbstractContext. If you need to share a Context between</em>
|
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * threads with simultaneous access for some reason, please create</em>
|
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * your own and extend the interface Context</em>
|
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @see org.apache.velocity.context.Context</em>
|
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="45" href="#45">45</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="46" href="#46">46</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="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:fedor.karpelevitch@home.com" target="alexandria_uri">mailto:fedor.karpelevitch@home.com</a>">Fedor Karpelevitch</a></em>
|
| <a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:dlr@finemaltcoding.com" target="alexandria_uri">mailto:dlr@finemaltcoding.com</a>">Daniel Rall</a></em>
|
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @version $Id: VelocityContext.java 463298 2006-10-12 16:10:32Z henning $</em>
|
| <a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="51" href="#51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../org/apache/velocity/VelocityContext.html">VelocityContext</a> <strong class="jxr_keyword">extends</strong> <a href="../../../org/apache/velocity/context/AbstractContext.html">AbstractContext</a> implements Cloneable
|
| <a name="52" href="#52">52</a> {
|
| <a name="53" href="#53">53</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * Version Id for serializable</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">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 9033846851064645037L;
|
| <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"> * Storage for key/value pairs.</em>
|
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="61" href="#61">61</a> <strong class="jxr_keyword">private</strong> Map context = <strong class="jxr_keyword">null</strong>;
|
| <a name="62" href="#62">62</a>
|
| <a name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * Creates a new instance (with no inner context).</em>
|
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="66" href="#66">66</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/apache/velocity/VelocityContext.html">VelocityContext</a>()
|
| <a name="67" href="#67">67</a> {
|
| <a name="68" href="#68">68</a> <strong class="jxr_keyword">this</strong>(<strong class="jxr_keyword">null</strong>, <strong class="jxr_keyword">null</strong>);
|
| <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"> * Creates a new instance with the provided storage (and no inner</em>
|
| <a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * context).</em>
|
| <a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @param context</em>
|
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="76" href="#76">76</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/apache/velocity/VelocityContext.html">VelocityContext</a>(Map context)
|
| <a name="77" href="#77">77</a> {
|
| <a name="78" href="#78">78</a> <strong class="jxr_keyword">this</strong>(context, <strong class="jxr_keyword">null</strong>);
|
| <a name="79" href="#79">79</a> }
|
| <a name="80" href="#80">80</a>
|
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * Chaining constructor, used when you want to</em>
|
| <a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * wrap a context in another. The inner context</em>
|
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * will be 'read only' - put() calls to the</em>
|
| <a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * wrapping context will only effect the outermost</em>
|
| <a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> * context</em>
|
| <a name="87" href="#87">87</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="88" href="#88">88</a> <em class="jxr_javadoccomment"> * @param innerContext The <code>Context</code> implementation to</em>
|
| <a name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * wrap.</em>
|
| <a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="91" href="#91">91</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/apache/velocity/VelocityContext.html">VelocityContext</a>( Context innerContext )
|
| <a name="92" href="#92">92</a> {
|
| <a name="93" href="#93">93</a> <strong class="jxr_keyword">this</strong>(<strong class="jxr_keyword">null</strong>, innerContext);
|
| <a name="94" href="#94">94</a> }
|
| <a name="95" href="#95">95</a>
|
| <a name="96" href="#96">96</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * Initializes internal storage (never to <code>null</code>), and</em>
|
| <a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> * inner context.</em>
|
| <a name="99" href="#99">99</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * @param context Internal storage, or <code>null</code> to</em>
|
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * create default storage.</em>
|
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * @param innerContext Inner context.</em>
|
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="104" href="#104">104</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/apache/velocity/VelocityContext.html">VelocityContext</a>(Map context, <a href="../../../org/apache/velocity/context/Context.html">Context</a> innerContext)
|
| <a name="105" href="#105">105</a> {
|
| <a name="106" href="#106">106</a> <strong class="jxr_keyword">super</strong>(innerContext);
|
| <a name="107" href="#107">107</a> <strong class="jxr_keyword">this</strong>.context = (context == <strong class="jxr_keyword">null</strong> ? <strong class="jxr_keyword">new</strong> HashMap() : context);
|
| <a name="108" href="#108">108</a> }
|
| <a name="109" href="#109">109</a>
|
| <a name="110" href="#110">110</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * retrieves value for key from internal</em>
|
| <a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * storage</em>
|
| <a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * @param key name of value to get</em>
|
| <a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * @return value as object</em>
|
| <a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="117" href="#117">117</a> <strong class="jxr_keyword">public</strong> Object internalGet( String key )
|
| <a name="118" href="#118">118</a> {
|
| <a name="119" href="#119">119</a> <strong class="jxr_keyword">return</strong> context.get( key );
|
| <a name="120" href="#120">120</a> }
|
| <a name="121" href="#121">121</a>
|
| <a name="122" href="#122">122</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * stores the value for key to internal</em>
|
| <a name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * storage</em>
|
| <a name="125" href="#125">125</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * @param key name of value to store</em>
|
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * @param value value to store</em>
|
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * @return previous value of key as Object</em>
|
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="130" href="#130">130</a> <strong class="jxr_keyword">public</strong> Object internalPut( String key, Object value )
|
| <a name="131" href="#131">131</a> {
|
| <a name="132" href="#132">132</a> <strong class="jxr_keyword">return</strong> context.put( key, value );
|
| <a name="133" href="#133">133</a> }
|
| <a name="134" href="#134">134</a>
|
| <a name="135" href="#135">135</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * determines if there is a value for the</em>
|
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * given key</em>
|
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * @param key name of value to check</em>
|
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> * @return true if non-null value in store</em>
|
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="142" href="#142">142</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> internalContainsKey(Object key)
|
| <a name="143" href="#143">143</a> {
|
| <a name="144" href="#144">144</a> <strong class="jxr_keyword">return</strong> context.containsKey( key );
|
| <a name="145" href="#145">145</a> }
|
| <a name="146" href="#146">146</a>
|
| <a name="147" href="#147">147</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * returns array of keys</em>
|
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * @return keys as []</em>
|
| <a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="152" href="#152">152</a> <strong class="jxr_keyword">public</strong> Object[] internalGetKeys()
|
| <a name="153" href="#153">153</a> {
|
| <a name="154" href="#154">154</a> <strong class="jxr_keyword">return</strong> context.keySet().toArray();
|
| <a name="155" href="#155">155</a> }
|
| <a name="156" href="#156">156</a>
|
| <a name="157" href="#157">157</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="158" href="#158">158</a> <em class="jxr_javadoccomment"> * remove a key/value pair from the</em>
|
| <a name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * internal storage</em>
|
| <a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * @param key name of value to remove</em>
|
| <a name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * @return value removed</em>
|
| <a name="163" href="#163">163</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="164" href="#164">164</a> <strong class="jxr_keyword">public</strong> Object internalRemove(Object key)
|
| <a name="165" href="#165">165</a> {
|
| <a name="166" href="#166">166</a> <strong class="jxr_keyword">return</strong> context.remove( key );
|
| <a name="167" href="#167">167</a> }
|
| <a name="168" href="#168">168</a>
|
| <a name="169" href="#169">169</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * Clones this context object.</em>
|
| <a name="171" href="#171">171</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * @return A deep copy of this <code>Context</code>.</em>
|
| <a name="173" href="#173">173</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="174" href="#174">174</a> <strong class="jxr_keyword">public</strong> Object clone()
|
| <a name="175" href="#175">175</a> {
|
| <a name="176" href="#176">176</a> <a href="../../../org/apache/velocity/VelocityContext.html">VelocityContext</a> clone = <strong class="jxr_keyword">null</strong>;
|
| <a name="177" href="#177">177</a> <strong class="jxr_keyword">try</strong>
|
| <a name="178" href="#178">178</a> {
|
| <a name="179" href="#179">179</a> clone = (VelocityContext) <strong class="jxr_keyword">super</strong>.clone();
|
| <a name="180" href="#180">180</a> clone.context = <strong class="jxr_keyword">new</strong> HashMap(context);
|
| <a name="181" href="#181">181</a> }
|
| <a name="182" href="#182">182</a> <strong class="jxr_keyword">catch</strong> (CloneNotSupportedException ignored)
|
| <a name="183" href="#183">183</a> {
|
| <a name="184" href="#184">184</a> }
|
| <a name="185" href="#185">185</a> <strong class="jxr_keyword">return</strong> clone;
|
| <a name="186" href="#186">186</a> }
|
| <a name="187" href="#187">187</a> }
|
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
|
|
