selenium-webdriver

Version:

The official WebDriver JavaScript bindings from the Selenium project

1 lines • 37.2 kB

HTML

<!DOCTYPE html><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no"><meta http-equiv="Content-Language" content="en"><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>map.js</title><link href="../../../../dossier.css" rel="stylesheet" type="text/css"><header><div><form><div><input type="search" placeholder="Search" tabindex="1"></div></form></div></header><main><article class="srcfile"><h1>lib/goog/structs/map.js</h1><div><table><tr><td><a id="l1"></a><a href="#l1">1</a><td>// Copyright 2006 The Closure Library Authors. All Rights Reserved.<tr><td><a id="l2"></a><a href="#l2">2</a><td>//<tr><td><a id="l3"></a><a href="#l3">3</a><td>// Licensed under the Apache License, Version 2.0 (the "License");<tr><td><a id="l4"></a><a href="#l4">4</a><td>// you may not use this file except in compliance with the License.<tr><td><a id="l5"></a><a href="#l5">5</a><td>// You may obtain a copy of the License at<tr><td><a id="l6"></a><a href="#l6">6</a><td>//<tr><td><a id="l7"></a><a href="#l7">7</a><td>// http://www.apache.org/licenses/LICENSE-2.0<tr><td><a id="l8"></a><a href="#l8">8</a><td>//<tr><td><a id="l9"></a><a href="#l9">9</a><td>// Unless required by applicable law or agreed to in writing, software<tr><td><a id="l10"></a><a href="#l10">10</a><td>// distributed under the License is distributed on an "AS-IS" BASIS,<tr><td><a id="l11"></a><a href="#l11">11</a><td>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<tr><td><a id="l12"></a><a href="#l12">12</a><td>// See the License for the specific language governing permissions and<tr><td><a id="l13"></a><a href="#l13">13</a><td>// limitations under the License.<tr><td><a id="l14"></a><a href="#l14">14</a><td><tr><td><a id="l15"></a><a href="#l15">15</a><td>/**<tr><td><a id="l16"></a><a href="#l16">16</a><td> * @fileoverview Datastructure: Hash Map.<tr><td><a id="l17"></a><a href="#l17">17</a><td> *<tr><td><a id="l18"></a><a href="#l18">18</a><td> * @author arv@google.com (Erik Arvidsson)<tr><td><a id="l19"></a><a href="#l19">19</a><td> *<tr><td><a id="l20"></a><a href="#l20">20</a><td> * This file contains an implementation of a Map structure. It implements a lot<tr><td><a id="l21"></a><a href="#l21">21</a><td> * of the methods used in goog.structs so those functions work on hashes. This<tr><td><a id="l22"></a><a href="#l22">22</a><td> * is best suited for complex key types. For simple keys such as numbers and<tr><td><a id="l23"></a><a href="#l23">23</a><td> * strings consider using the lighter-weight utilities in goog.object.<tr><td><a id="l24"></a><a href="#l24">24</a><td> */<tr><td><a id="l25"></a><a href="#l25">25</a><td><tr><td><a id="l26"></a><a href="#l26">26</a><td><tr><td><a id="l27"></a><a href="#l27">27</a><td>goog.provide('goog.structs.Map');<tr><td><a id="l28"></a><a href="#l28">28</a><td><tr><td><a id="l29"></a><a href="#l29">29</a><td>goog.require('goog.iter.Iterator');<tr><td><a id="l30"></a><a href="#l30">30</a><td>goog.require('goog.iter.StopIteration');<tr><td><a id="l31"></a><a href="#l31">31</a><td>goog.require('goog.object');<tr><td><a id="l32"></a><a href="#l32">32</a><td><tr><td><a id="l33"></a><a href="#l33">33</a><td><tr><td><a id="l34"></a><a href="#l34">34</a><td><tr><td><a id="l35"></a><a href="#l35">35</a><td>/**<tr><td><a id="l36"></a><a href="#l36">36</a><td> * Class for Hash Map datastructure.<tr><td><a id="l37"></a><a href="#l37">37</a><td> * @param {*=} opt_map Map or Object to initialize the map with.<tr><td><a id="l38"></a><a href="#l38">38</a><td> * @param {...*} var_args If 2 or more arguments are present then they<tr><td><a id="l39"></a><a href="#l39">39</a><td> * will be used as key-value pairs.<tr><td><a id="l40"></a><a href="#l40">40</a><td> * @constructor<tr><td><a id="l41"></a><a href="#l41">41</a><td> * @template K, V<tr><td><a id="l42"></a><a href="#l42">42</a><td> */<tr><td><a id="l43"></a><a href="#l43">43</a><td>goog.structs.Map = function(opt_map, var_args) {<tr><td><a id="l44"></a><a href="#l44">44</a><td><tr><td><a id="l45"></a><a href="#l45">45</a><td> /**<tr><td><a id="l46"></a><a href="#l46">46</a><td> * Underlying JS object used to implement the map.<tr><td><a id="l47"></a><a href="#l47">47</a><td> * @private {!Object}<tr><td><a id="l48"></a><a href="#l48">48</a><td> */<tr><td><a id="l49"></a><a href="#l49">49</a><td> this.map_ = {};<tr><td><a id="l50"></a><a href="#l50">50</a><td><tr><td><a id="l51"></a><a href="#l51">51</a><td> /**<tr><td><a id="l52"></a><a href="#l52">52</a><td> * An array of keys. This is necessary for two reasons:<tr><td><a id="l53"></a><a href="#l53">53</a><td> * 1. Iterating the keys using for (var key in this.map_) allocates an<tr><td><a id="l54"></a><a href="#l54">54</a><td> * object for every key in IE which is really bad for IE6 GC perf.<tr><td><a id="l55"></a><a href="#l55">55</a><td> * 2. Without a side data structure, we would need to escape all the keys<tr><td><a id="l56"></a><a href="#l56">56</a><td> * as that would be the only way we could tell during iteration if the<tr><td><a id="l57"></a><a href="#l57">57</a><td> * key was an internal key or a property of the object.<tr><td><a id="l58"></a><a href="#l58">58</a><td> *<tr><td><a id="l59"></a><a href="#l59">59</a><td> * This array can contain deleted keys so it's necessary to check the map<tr><td><a id="l60"></a><a href="#l60">60</a><td> * as well to see if the key is still in the map (this doesn't require a<tr><td><a id="l61"></a><a href="#l61">61</a><td> * memory allocation in IE).<tr><td><a id="l62"></a><a href="#l62">62</a><td> * @private {!Array<string>}<tr><td><a id="l63"></a><a href="#l63">63</a><td> */<tr><td><a id="l64"></a><a href="#l64">64</a><td> this.keys_ = [];<tr><td><a id="l65"></a><a href="#l65">65</a><td><tr><td><a id="l66"></a><a href="#l66">66</a><td> /**<tr><td><a id="l67"></a><a href="#l67">67</a><td> * The number of key value pairs in the map.<tr><td><a id="l68"></a><a href="#l68">68</a><td> * @private {number}<tr><td><a id="l69"></a><a href="#l69">69</a><td> */<tr><td><a id="l70"></a><a href="#l70">70</a><td> this.count_ = 0;<tr><td><a id="l71"></a><a href="#l71">71</a><td><tr><td><a id="l72"></a><a href="#l72">72</a><td> /**<tr><td><a id="l73"></a><a href="#l73">73</a><td> * Version used to detect changes while iterating.<tr><td><a id="l74"></a><a href="#l74">74</a><td> * @private {number}<tr><td><a id="l75"></a><a href="#l75">75</a><td> */<tr><td><a id="l76"></a><a href="#l76">76</a><td> this.version_ = 0;<tr><td><a id="l77"></a><a href="#l77">77</a><td><tr><td><a id="l78"></a><a href="#l78">78</a><td> var argLength = arguments.length;<tr><td><a id="l79"></a><a href="#l79">79</a><td><tr><td><a id="l80"></a><a href="#l80">80</a><td> if (argLength > 1) {<tr><td><a id="l81"></a><a href="#l81">81</a><td> if (argLength % 2) {<tr><td><a id="l82"></a><a href="#l82">82</a><td> throw Error('Uneven number of arguments');<tr><td><a id="l83"></a><a href="#l83">83</a><td> }<tr><td><a id="l84"></a><a href="#l84">84</a><td> for (var i = 0; i < argLength; i += 2) {<tr><td><a id="l85"></a><a href="#l85">85</a><td> this.set(arguments[i], arguments[i + 1]);<tr><td><a id="l86"></a><a href="#l86">86</a><td> }<tr><td><a id="l87"></a><a href="#l87">87</a><td> } else if (opt_map) {<tr><td><a id="l88"></a><a href="#l88">88</a><td> this.addAll(/** @type {Object} */ (opt_map));<tr><td><a id="l89"></a><a href="#l89">89</a><td> }<tr><td><a id="l90"></a><a href="#l90">90</a><td>};<tr><td><a id="l91"></a><a href="#l91">91</a><td><tr><td><a id="l92"></a><a href="#l92">92</a><td><tr><td><a id="l93"></a><a href="#l93">93</a><td>/**<tr><td><a id="l94"></a><a href="#l94">94</a><td> * @return {number} The number of key-value pairs in the map.<tr><td><a id="l95"></a><a href="#l95">95</a><td> */<tr><td><a id="l96"></a><a href="#l96">96</a><td>goog.structs.Map.prototype.getCount = function() {<tr><td><a id="l97"></a><a href="#l97">97</a><td> return this.count_;<tr><td><a id="l98"></a><a href="#l98">98</a><td>};<tr><td><a id="l99"></a><a href="#l99">99</a><td><tr><td><a id="l100"></a><a href="#l100">100</a><td><tr><td><a id="l101"></a><a href="#l101">101</a><td>/**<tr><td><a id="l102"></a><a href="#l102">102</a><td> * Returns the values of the map.<tr><td><a id="l103"></a><a href="#l103">103</a><td> * @return {!Array<V>} The values in the map.<tr><td><a id="l104"></a><a href="#l104">104</a><td> */<tr><td><a id="l105"></a><a href="#l105">105</a><td>goog.structs.Map.prototype.getValues = function() {<tr><td><a id="l106"></a><a href="#l106">106</a><td> this.cleanupKeysArray_();<tr><td><a id="l107"></a><a href="#l107">107</a><td><tr><td><a id="l108"></a><a href="#l108">108</a><td> var rv = [];<tr><td><a id="l109"></a><a href="#l109">109</a><td> for (var i = 0; i < this.keys_.length; i++) {<tr><td><a id="l110"></a><a href="#l110">110</a><td> var key = this.keys_[i];<tr><td><a id="l111"></a><a href="#l111">111</a><td> rv.push(this.map_[key]);<tr><td><a id="l112"></a><a href="#l112">112</a><td> }<tr><td><a id="l113"></a><a href="#l113">113</a><td> return rv;<tr><td><a id="l114"></a><a href="#l114">114</a><td>};<tr><td><a id="l115"></a><a href="#l115">115</a><td><tr><td><a id="l116"></a><a href="#l116">116</a><td><tr><td><a id="l117"></a><a href="#l117">117</a><td>/**<tr><td><a id="l118"></a><a href="#l118">118</a><td> * Returns the keys of the map.<tr><td><a id="l119"></a><a href="#l119">119</a><td> * @return {!Array<string>} Array of string values.<tr><td><a id="l120"></a><a href="#l120">120</a><td> */<tr><td><a id="l121"></a><a href="#l121">121</a><td>goog.structs.Map.prototype.getKeys = function() {<tr><td><a id="l122"></a><a href="#l122">122</a><td> this.cleanupKeysArray_();<tr><td><a id="l123"></a><a href="#l123">123</a><td> return /** @type {!Array<string>} */ (this.keys_.concat());<tr><td><a id="l124"></a><a href="#l124">124</a><td>};<tr><td><a id="l125"></a><a href="#l125">125</a><td><tr><td><a id="l126"></a><a href="#l126">126</a><td><tr><td><a id="l127"></a><a href="#l127">127</a><td>/**<tr><td><a id="l128"></a><a href="#l128">128</a><td> * Whether the map contains the given key.<tr><td><a id="l129"></a><a href="#l129">129</a><td> * @param {*} key The key to check for.<tr><td><a id="l130"></a><a href="#l130">130</a><td> * @return {boolean} Whether the map contains the key.<tr><td><a id="l131"></a><a href="#l131">131</a><td> */<tr><td><a id="l132"></a><a href="#l132">132</a><td>goog.structs.Map.prototype.containsKey = function(key) {<tr><td><a id="l133"></a><a href="#l133">133</a><td> return goog.structs.Map.hasKey_(this.map_, key);<tr><td><a id="l134"></a><a href="#l134">134</a><td>};<tr><td><a id="l135"></a><a href="#l135">135</a><td><tr><td><a id="l136"></a><a href="#l136">136</a><td><tr><td><a id="l137"></a><a href="#l137">137</a><td>/**<tr><td><a id="l138"></a><a href="#l138">138</a><td> * Whether the map contains the given value. This is O(n).<tr><td><a id="l139"></a><a href="#l139">139</a><td> * @param {V} val The value to check for.<tr><td><a id="l140"></a><a href="#l140">140</a><td> * @return {boolean} Whether the map contains the value.<tr><td><a id="l141"></a><a href="#l141">141</a><td> */<tr><td><a id="l142"></a><a href="#l142">142</a><td>goog.structs.Map.prototype.containsValue = function(val) {<tr><td><a id="l143"></a><a href="#l143">143</a><td> for (var i = 0; i < this.keys_.length; i++) {<tr><td><a id="l144"></a><a href="#l144">144</a><td> var key = this.keys_[i];<tr><td><a id="l145"></a><a href="#l145">145</a><td> if (goog.structs.Map.hasKey_(this.map_, key) && this.map_[key] == val) {<tr><td><a id="l146"></a><a href="#l146">146</a><td> return true;<tr><td><a id="l147"></a><a href="#l147">147</a><td> }<tr><td><a id="l148"></a><a href="#l148">148</a><td> }<tr><td><a id="l149"></a><a href="#l149">149</a><td> return false;<tr><td><a id="l150"></a><a href="#l150">150</a><td>};<tr><td><a id="l151"></a><a href="#l151">151</a><td><tr><td><a id="l152"></a><a href="#l152">152</a><td><tr><td><a id="l153"></a><a href="#l153">153</a><td>/**<tr><td><a id="l154"></a><a href="#l154">154</a><td> * Whether this map is equal to the argument map.<tr><td><a id="l155"></a><a href="#l155">155</a><td> * @param {goog.structs.Map} otherMap The map against which to test equality.<tr><td><a id="l156"></a><a href="#l156">156</a><td> * @param {function(V, V): boolean=} opt_equalityFn Optional equality function<tr><td><a id="l157"></a><a href="#l157">157</a><td> * to test equality of values. If not specified, this will test whether<tr><td><a id="l158"></a><a href="#l158">158</a><td> * the values contained in each map are identical objects.<tr><td><a id="l159"></a><a href="#l159">159</a><td> * @return {boolean} Whether the maps are equal.<tr><td><a id="l160"></a><a href="#l160">160</a><td> */<tr><td><a id="l161"></a><a href="#l161">161</a><td>goog.structs.Map.prototype.equals = function(otherMap, opt_equalityFn) {<tr><td><a id="l162"></a><a href="#l162">162</a><td> if (this === otherMap) {<tr><td><a id="l163"></a><a href="#l163">163</a><td> return true;<tr><td><a id="l164"></a><a href="#l164">164</a><td> }<tr><td><a id="l165"></a><a href="#l165">165</a><td><tr><td><a id="l166"></a><a href="#l166">166</a><td> if (this.count_ != otherMap.getCount()) {<tr><td><a id="l167"></a><a href="#l167">167</a><td> return false;<tr><td><a id="l168"></a><a href="#l168">168</a><td> }<tr><td><a id="l169"></a><a href="#l169">169</a><td><tr><td><a id="l170"></a><a href="#l170">170</a><td> var equalityFn = opt_equalityFn || goog.structs.Map.defaultEquals;<tr><td><a id="l171"></a><a href="#l171">171</a><td><tr><td><a id="l172"></a><a href="#l172">172</a><td> this.cleanupKeysArray_();<tr><td><a id="l173"></a><a href="#l173">173</a><td> for (var key, i = 0; key = this.keys_[i]; i++) {<tr><td><a id="l174"></a><a href="#l174">174</a><td> if (!equalityFn(this.get(key), otherMap.get(key))) {<tr><td><a id="l175"></a><a href="#l175">175</a><td> return false;<tr><td><a id="l176"></a><a href="#l176">176</a><td> }<tr><td><a id="l177"></a><a href="#l177">177</a><td> }<tr><td><a id="l178"></a><a href="#l178">178</a><td><tr><td><a id="l179"></a><a href="#l179">179</a><td> return true;<tr><td><a id="l180"></a><a href="#l180">180</a><td>};<tr><td><a id="l181"></a><a href="#l181">181</a><td><tr><td><a id="l182"></a><a href="#l182">182</a><td><tr><td><a id="l183"></a><a href="#l183">183</a><td>/**<tr><td><a id="l184"></a><a href="#l184">184</a><td> * Default equality test for values.<tr><td><a id="l185"></a><a href="#l185">185</a><td> * @param {*} a The first value.<tr><td><a id="l186"></a><a href="#l186">186</a><td> * @param {*} b The second value.<tr><td><a id="l187"></a><a href="#l187">187</a><td> * @return {boolean} Whether a and b reference the same object.<tr><td><a id="l188"></a><a href="#l188">188</a><td> */<tr><td><a id="l189"></a><a href="#l189">189</a><td>goog.structs.Map.defaultEquals = function(a, b) {<tr><td><a id="l190"></a><a href="#l190">190</a><td> return a === b;<tr><td><a id="l191"></a><a href="#l191">191</a><td>};<tr><td><a id="l192"></a><a href="#l192">192</a><td><tr><td><a id="l193"></a><a href="#l193">193</a><td><tr><td><a id="l194"></a><a href="#l194">194</a><td>/**<tr><td><a id="l195"></a><a href="#l195">195</a><td> * @return {boolean} Whether the map is empty.<tr><td><a id="l196"></a><a href="#l196">196</a><td> */<tr><td><a id="l197"></a><a href="#l197">197</a><td>goog.structs.Map.prototype.isEmpty = function() {<tr><td><a id="l198"></a><a href="#l198">198</a><td> return this.count_ == 0;<tr><td><a id="l199"></a><a href="#l199">199</a><td>};<tr><td><a id="l200"></a><a href="#l200">200</a><td><tr><td><a id="l201"></a><a href="#l201">201</a><td><tr><td><a id="l202"></a><a href="#l202">202</a><td>/**<tr><td><a id="l203"></a><a href="#l203">203</a><td> * Removes all key-value pairs from the map.<tr><td><a id="l204"></a><a href="#l204">204</a><td> */<tr><td><a id="l205"></a><a href="#l205">205</a><td>goog.structs.Map.prototype.clear = function() {<tr><td><a id="l206"></a><a href="#l206">206</a><td> this.map_ = {};<tr><td><a id="l207"></a><a href="#l207">207</a><td> this.keys_.length = 0;<tr><td><a id="l208"></a><a href="#l208">208</a><td> this.count_ = 0;<tr><td><a id="l209"></a><a href="#l209">209</a><td> this.version_ = 0;<tr><td><a id="l210"></a><a href="#l210">210</a><td>};<tr><td><a id="l211"></a><a href="#l211">211</a><td><tr><td><a id="l212"></a><a href="#l212">212</a><td><tr><td><a id="l213"></a><a href="#l213">213</a><td>/**<tr><td><a id="l214"></a><a href="#l214">214</a><td> * Removes a key-value pair based on the key. This is O(logN) amortized due to<tr><td><a id="l215"></a><a href="#l215">215</a><td> * updating the keys array whenever the count becomes half the size of the keys<tr><td><a id="l216"></a><a href="#l216">216</a><td> * in the keys array.<tr><td><a id="l217"></a><a href="#l217">217</a><td> * @param {*} key The key to remove.<tr><td><a id="l218"></a><a href="#l218">218</a><td> * @return {boolean} Whether object was removed.<tr><td><a id="l219"></a><a href="#l219">219</a><td> */<tr><td><a id="l220"></a><a href="#l220">220</a><td>goog.structs.Map.prototype.remove = function(key) {<tr><td><a id="l221"></a><a href="#l221">221</a><td> if (goog.structs.Map.hasKey_(this.map_, key)) {<tr><td><a id="l222"></a><a href="#l222">222</a><td> delete this.map_[key];<tr><td><a id="l223"></a><a href="#l223">223</a><td> this.count_--;<tr><td><a id="l224"></a><a href="#l224">224</a><td> this.version_++;<tr><td><a id="l225"></a><a href="#l225">225</a><td><tr><td><a id="l226"></a><a href="#l226">226</a><td> // clean up the keys array if the threshhold is hit<tr><td><a id="l227"></a><a href="#l227">227</a><td> if (this.keys_.length > 2 * this.count_) {<tr><td><a id="l228"></a><a href="#l228">228</a><td> this.cleanupKeysArray_();<tr><td><a id="l229"></a><a href="#l229">229</a><td> }<tr><td><a id="l230"></a><a href="#l230">230</a><td><tr><td><a id="l231"></a><a href="#l231">231</a><td> return true;<tr><td><a id="l232"></a><a href="#l232">232</a><td> }<tr><td><a id="l233"></a><a href="#l233">233</a><td> return false;<tr><td><a id="l234"></a><a href="#l234">234</a><td>};<tr><td><a id="l235"></a><a href="#l235">235</a><td><tr><td><a id="l236"></a><a href="#l236">236</a><td><tr><td><a id="l237"></a><a href="#l237">237</a><td>/**<tr><td><a id="l238"></a><a href="#l238">238</a><td> * Cleans up the temp keys array by removing entries that are no longer in the<tr><td><a id="l239"></a><a href="#l239">239</a><td> * map.<tr><td><a id="l240"></a><a href="#l240">240</a><td> * @private<tr><td><a id="l241"></a><a href="#l241">241</a><td> */<tr><td><a id="l242"></a><a href="#l242">242</a><td>goog.structs.Map.prototype.cleanupKeysArray_ = function() {<tr><td><a id="l243"></a><a href="#l243">243</a><td> if (this.count_ != this.keys_.length) {<tr><td><a id="l244"></a><a href="#l244">244</a><td> // First remove keys that are no longer in the map.<tr><td><a id="l245"></a><a href="#l245">245</a><td> var srcIndex = 0;<tr><td><a id="l246"></a><a href="#l246">246</a><td> var destIndex = 0;<tr><td><a id="l247"></a><a href="#l247">247</a><td> while (srcIndex < this.keys_.length) {<tr><td><a id="l248"></a><a href="#l248">248</a><td> var key = this.keys_[srcIndex];<tr><td><a id="l249"></a><a href="#l249">249</a><td> if (goog.structs.Map.hasKey_(this.map_, key)) {<tr><td><a id="l250"></a><a href="#l250">250</a><td> this.keys_[destIndex++] = key;<tr><td><a id="l251"></a><a href="#l251">251</a><td> }<tr><td><a id="l252"></a><a href="#l252">252</a><td> srcIndex++;<tr><td><a id="l253"></a><a href="#l253">253</a><td> }<tr><td><a id="l254"></a><a href="#l254">254</a><td> this.keys_.length = destIndex;<tr><td><a id="l255"></a><a href="#l255">255</a><td> }<tr><td><a id="l256"></a><a href="#l256">256</a><td><tr><td><a id="l257"></a><a href="#l257">257</a><td> if (this.count_ != this.keys_.length) {<tr><td><a id="l258"></a><a href="#l258">258</a><td> // If the count still isn't correct, that means we have duplicates. This can<tr><td><a id="l259"></a><a href="#l259">259</a><td> // happen when the same key is added and removed multiple times. Now we have<tr><td><a id="l260"></a><a href="#l260">260</a><td> // to allocate one extra Object to remove the duplicates. This could have<tr><td><a id="l261"></a><a href="#l261">261</a><td> // been done in the first pass, but in the common case, we can avoid<tr><td><a id="l262"></a><a href="#l262">262</a><td> // allocating an extra object by only doing this when necessary.<tr><td><a id="l263"></a><a href="#l263">263</a><td> var seen = {};<tr><td><a id="l264"></a><a href="#l264">264</a><td> var srcIndex = 0;<tr><td><a id="l265"></a><a href="#l265">265</a><td> var destIndex = 0;<tr><td><a id="l266"></a><a href="#l266">266</a><td> while (srcIndex < this.keys_.length) {<tr><td><a id="l267"></a><a href="#l267">267</a><td> var key = this.keys_[srcIndex];<tr><td><a id="l268"></a><a href="#l268">268</a><td> if (!(goog.structs.Map.hasKey_(seen, key))) {<tr><td><a id="l269"></a><a href="#l269">269</a><td> this.keys_[destIndex++] = key;<tr><td><a id="l270"></a><a href="#l270">270</a><td> seen[key] = 1;<tr><td><a id="l271"></a><a href="#l271">271</a><td> }<tr><td><a id="l272"></a><a href="#l272">272</a><td> srcIndex++;<tr><td><a id="l273"></a><a href="#l273">273</a><td> }<tr><td><a id="l274"></a><a href="#l274">274</a><td> this.keys_.length = destIndex;<tr><td><a id="l275"></a><a href="#l275">275</a><td> }<tr><td><a id="l276"></a><a href="#l276">276</a><td>};<tr><td><a id="l277"></a><a href="#l277">277</a><td><tr><td><a id="l278"></a><a href="#l278">278</a><td><tr><td><a id="l279"></a><a href="#l279">279</a><td>/**<tr><td><a id="l280"></a><a href="#l280">280</a><td> * Returns the value for the given key. If the key is not found and the default<tr><td><a id="l281"></a><a href="#l281">281</a><td> * value is not given this will return {@code undefined}.<tr><td><a id="l282"></a><a href="#l282">282</a><td> * @param {*} key The key to get the value for.<tr><td><a id="l283"></a><a href="#l283">283</a><td> * @param {DEFAULT=} opt_val The value to return if no item is found for the<tr><td><a id="l284"></a><a href="#l284">284</a><td> * given key, defaults to undefined.<tr><td><a id="l285"></a><a href="#l285">285</a><td> * @return {V|DEFAULT} The value for the given key.<tr><td><a id="l286"></a><a href="#l286">286</a><td> * @template DEFAULT<tr><td><a id="l287"></a><a href="#l287">287</a><td> */<tr><td><a id="l288"></a><a href="#l288">288</a><td>goog.structs.Map.prototype.get = function(key, opt_val) {<tr><td><a id="l289"></a><a href="#l289">289</a><td> if (goog.structs.Map.hasKey_(this.map_, key)) {<tr><td><a id="l290"></a><a href="#l290">290</a><td> return this.map_[key];<tr><td><a id="l291"></a><a href="#l291">291</a><td> }<tr><td><a id="l292"></a><a href="#l292">292</a><td> return opt_val;<tr><td><a id="l293"></a><a href="#l293">293</a><td>};<tr><td><a id="l294"></a><a href="#l294">294</a><td><tr><td><a id="l295"></a><a href="#l295">295</a><td><tr><td><a id="l296"></a><a href="#l296">296</a><td>/**<tr><td><a id="l297"></a><a href="#l297">297</a><td> * Adds a key-value pair to the map.<tr><td><a id="l298"></a><a href="#l298">298</a><td> * @param {*} key The key.<tr><td><a id="l299"></a><a href="#l299">299</a><td> * @param {V} value The value to add.<tr><td><a id="l300"></a><a href="#l300">300</a><td> * @return {*} Some subclasses return a value.<tr><td><a id="l301"></a><a href="#l301">301</a><td> */<tr><td><a id="l302"></a><a href="#l302">302</a><td>goog.structs.Map.prototype.set = function(key, value) {<tr><td><a id="l303"></a><a href="#l303">303</a><td> if (!(goog.structs.Map.hasKey_(this.map_, key))) {<tr><td><a id="l304"></a><a href="#l304">304</a><td> this.count_++;<tr><td><a id="l305"></a><a href="#l305">305</a><td> // TODO(johnlenz): This class lies, it claims to return an array of string<tr><td><a id="l306"></a><a href="#l306">306</a><td> // keys, but instead returns the original object used.<tr><td><a id="l307"></a><a href="#l307">307</a><td> this.keys_.push(/** @type {?} */ (key));<tr><td><a id="l308"></a><a href="#l308">308</a><td> // Only change the version if we add a new key.<tr><td><a id="l309"></a><a href="#l309">309</a><td> this.version_++;<tr><td><a id="l310"></a><a href="#l310">310</a><td> }<tr><td><a id="l311"></a><a href="#l311">311</a><td> this.map_[key] = value;<tr><td><a id="l312"></a><a href="#l312">312</a><td>};<tr><td><a id="l313"></a><a href="#l313">313</a><td><tr><td><a id="l314"></a><a href="#l314">314</a><td><tr><td><a id="l315"></a><a href="#l315">315</a><td>/**<tr><td><a id="l316"></a><a href="#l316">316</a><td> * Adds multiple key-value pairs from another goog.structs.Map or Object.<tr><td><a id="l317"></a><a href="#l317">317</a><td> * @param {Object} map Object containing the data to add.<tr><td><a id="l318"></a><a href="#l318">318</a><td> */<tr><td><a id="l319"></a><a href="#l319">319</a><td>goog.structs.Map.prototype.addAll = function(map) {<tr><td><a id="l320"></a><a href="#l320">320</a><td> var keys, values;<tr><td><a id="l321"></a><a href="#l321">321</a><td> if (map instanceof goog.structs.Map) {<tr><td><a id="l322"></a><a href="#l322">322</a><td> keys = map.getKeys();<tr><td><a id="l323"></a><a href="#l323">323</a><td> values = map.getValues();<tr><td><a id="l324"></a><a href="#l324">324</a><td> } else {<tr><td><a id="l325"></a><a href="#l325">325</a><td> keys = goog.object.getKeys(map);<tr><td><a id="l326"></a><a href="#l326">326</a><td> values = goog.object.getValues(map);<tr><td><a id="l327"></a><a href="#l327">327</a><td> }<tr><td><a id="l328"></a><a href="#l328">328</a><td> // we could use goog.array.forEach here but I don't want to introduce that<tr><td><a id="l329"></a><a href="#l329">329</a><td> // dependency just for this.<tr><td><a id="l330"></a><a href="#l330">330</a><td> for (var i = 0; i < keys.length; i++) {<tr><td><a id="l331"></a><a href="#l331">331</a><td> this.set(keys[i], values[i]);<tr><td><a id="l332"></a><a href="#l332">332</a><td> }<tr><td><a id="l333"></a><a href="#l333">333</a><td>};<tr><td><a id="l334"></a><a href="#l334">334</a><td><tr><td><a id="l335"></a><a href="#l335">335</a><td><tr><td><a id="l336"></a><a href="#l336">336</a><td>/**<tr><td><a id="l337"></a><a href="#l337">337</a><td> * Calls the given function on each entry in the map.<tr><td><a id="l338"></a><a href="#l338">338</a><td> * @param {function(this:T, V, K, goog.structs.Map<K,V>)} f<tr><td><a id="l339"></a><a href="#l339">339</a><td> * @param {T=} opt_obj The value of "this" inside f.<tr><td><a id="l340"></a><a href="#l340">340</a><td> * @template T<tr><td><a id="l341"></a><a href="#l341">341</a><td> */<tr><td><a id="l342"></a><a href="#l342">342</a><td>goog.structs.Map.prototype.forEach = function(f, opt_obj) {<tr><td><a id="l343"></a><a href="#l343">343</a><td> var keys = this.getKeys();<tr><td><a id="l344"></a><a href="#l344">344</a><td> for (var i = 0; i < keys.length; i++) {<tr><td><a id="l345"></a><a href="#l345">345</a><td> var key = keys[i];<tr><td><a id="l346"></a><a href="#l346">346</a><td> var value = this.get(key);<tr><td><a id="l347"></a><a href="#l347">347</a><td> f.call(opt_obj, value, key, this);<tr><td><a id="l348"></a><a href="#l348">348</a><td> }<tr><td><a id="l349"></a><a href="#l349">349</a><td>};<tr><td><a id="l350"></a><a href="#l350">350</a><td><tr><td><a id="l351"></a><a href="#l351">351</a><td><tr><td><a id="l352"></a><a href="#l352">352</a><td>/**<tr><td><a id="l353"></a><a href="#l353">353</a><td> * Clones a map and returns a new map.<tr><td><a id="l354"></a><a href="#l354">354</a><td> * @return {!goog.structs.Map} A new map with the same key-value pairs.<tr><td><a id="l355"></a><a href="#l355">355</a><td> */<tr><td><a id="l356"></a><a href="#l356">356</a><td>goog.structs.Map.prototype.clone = function() {<tr><td><a id="l357"></a><a href="#l357">357</a><td> return new goog.structs.Map(this);<tr><td><a id="l358"></a><a href="#l358">358</a><td>};<tr><td><a id="l359"></a><a href="#l359">359</a><td><tr><td><a id="l360"></a><a href="#l360">360</a><td><tr><td><a id="l361"></a><a href="#l361">361</a><td>/**<tr><td><a id="l362"></a><a href="#l362">362</a><td> * Returns a new map in which all the keys and values are interchanged<tr><td><a id="l363"></a><a href="#l363">363</a><td> * (keys become values and values become keys). If multiple keys map to the<tr><td><a id="l364"></a><a href="#l364">364</a><td> * same value, the chosen transposed value is implementation-dependent.<tr><td><a id="l365"></a><a href="#l365">365</a><td> *<tr><td><a id="l366"></a><a href="#l366">366</a><td> * It acts very similarly to {goog.object.transpose(Object)}.<tr><td><a id="l367"></a><a href="#l367">367</a><td> *<tr><td><a id="l368"></a><a href="#l368">368</a><td> * @return {!goog.structs.Map} The transposed map.<tr><td><a id="l369"></a><a href="#l369">369</a><td> */<tr><td><a id="l370"></a><a href="#l370">370</a><td>goog.structs.Map.prototype.transpose = function() {<tr><td><a id="l371"></a><a href="#l371">371</a><td> var transposed = new goog.structs.Map();<tr><td><a id="l372"></a><a href="#l372">372</a><td> for (var i = 0; i < this.keys_.length; i++) {<tr><td><a id="l373"></a><a href="#l373">373</a><td> var key = this.keys_[i];<tr><td><a id="l374"></a><a href="#l374">374</a><td> var value = this.map_[key];<tr><td><a id="l375"></a><a href="#l375">375</a><td> transposed.set(value, key);<tr><td><a id="l376"></a><a href="#l376">376</a><td> }<tr><td><a id="l377"></a><a href="#l377">377</a><td><tr><td><a id="l378"></a><a href="#l378">378</a><td> return transposed;<tr><td><a id="l379"></a><a href="#l379">379</a><td>};<tr><td><a id="l380"></a><a href="#l380">380</a><td><tr><td><a id="l381"></a><a href="#l381">381</a><td><tr><td><a id="l382"></a><a href="#l382">382</a><td>/**<tr><td><a id="l383"></a><a href="#l383">383</a><td> * @return {!Object} Object representation of the map.<tr><td><a id="l384"></a><a href="#l384">384</a><td> */<tr><td><a id="l385"></a><a href="#l385">385</a><td>goog.structs.Map.prototype.toObject = function() {<tr><td><a id="l386"></a><a href="#l386">386</a><td> this.cleanupKeysArray_();<tr><td><a id="l387"></a><a href="#l387">387</a><td> var obj = {};<tr><td><a id="l388"></a><a href="#l388">388</a><td> for (var i = 0; i < this.keys_.length; i++) {<tr><td><a id="l389"></a><a href="#l389">389</a><td> var key = this.keys_[i];<tr><td><a id="l390"></a><a href="#l390">390</a><td> obj[key] = this.map_[key];<tr><td><a id="l391"></a><a href="#l391">391</a><td> }<tr><td><a id="l392"></a><a href="#l392">392</a><td> return obj;<tr><td><a id="l393"></a><a href="#l393">393</a><td>};<tr><td><a id="l394"></a><a href="#l394">394</a><td><tr><td><a id="l395"></a><a href="#l395">395</a><td><tr><td><a id="l396"></a><a href="#l396">396</a><td>/**<tr><td><a id="l397"></a><a href="#l397">397</a><td> * Returns an iterator that iterates over the keys in the map. Removal of keys<tr><td><a id="l398"></a><a href="#l398">398</a><td> * while iterating might have undesired side effects.<tr><td><a id="l399"></a><a href="#l399">399</a><td> * @return {!goog.iter.Iterator} An iterator over the keys in the map.<tr><td><a id="l400"></a><a href="#l400">400</a><td> */<tr><td><a id="l401"></a><a href="#l401">401</a><td>goog.structs.Map.prototype.getKeyIterator = function() {<tr><td><a id="l402"></a><a href="#l402">402</a><td> return this.__iterator__(true);<tr><td><a id="l403"></a><a href="#l403">403</a><td>};<tr><td><a id="l404"></a><a href="#l404">404</a><td><tr><td><a id="l405"></a><a href="#l405">405</a><td><tr><td><a id="l406"></a><a href="#l406">406</a><td>/**<tr><td><a id="l407"></a><a href="#l407">407</a><td> * Returns an iterator that iterates over the values in the map. Removal of<tr><td><a id="l408"></a><a href="#l408">408</a><td> * keys while iterating might have undesired side effects.<tr><td><a id="l409"></a><a href="#l409">409</a><td> * @return {!goog.iter.Iterator} An iterator over the values in the map.<tr><td><a id="l410"></a><a href="#l410">410</a><td> */<tr><td><a id="l411"></a><a href="#l411">411</a><td>goog.structs.Map.prototype.getValueIterator = function() {<tr><td><a id="l412"></a><a href="#l412">412</a><td> return this.__iterator__(false);<tr><td><a id="l413"></a><a href="#l413">413</a><td>};<tr><td><a id="l414"></a><a href="#l414">414</a><td><tr><td><a id="l415"></a><a href="#l415">415</a><td><tr><td><a id="l416"></a><a href="#l416">416</a><td>/**<tr><td><a id="l417"></a><a href="#l417">417</a><td> * Returns an iterator that iterates over the values or the keys in the map.<tr><td><a id="l418"></a><a href="#l418">418</a><td> * This throws an exception if the map was mutated since the iterator was<tr><td><a id="l419"></a><a href="#l419">419</a><td> * created.<tr><td><a id="l420"></a><a href="#l420">420</a><td> * @param {boolean=} opt_keys True to iterate over the keys. False to iterate<tr><td><a id="l421"></a><a href="#l421">421</a><td> * over the values. The default value is false.<tr><td><a id="l422"></a><a href="#l422">422</a><td> * @return {!goog.iter.Iterator} An iterator over the values or keys in the map.<tr><td><a id="l423"></a><a href="#l423">423</a><td> */<tr><td><a id="l424"></a><a href="#l424">424</a><td>goog.structs.Map.prototype.__iterator__ = function(opt_keys) {<tr><td><a id="l425"></a><a href="#l425">425</a><td> // Clean up keys to minimize the risk of iterating over dead keys.<tr><td><a id="l426"></a><a href="#l426">426</a><td> this.cleanupKeysArray_();<tr><td><a id="l427"></a><a href="#l427">427</a><td><tr><td><a id="l428"></a><a href="#l428">428</a><td> var i = 0;<tr><td><a id="l429"></a><a href="#l429">429</a><td> var version = this.version_;<tr><td><a id="l430"></a><a href="#l430">430</a><td> var selfObj = this;<tr><td><a id="l431"></a><a href="#l431">431</a><td><tr><td><a id="l432"></a><a href="#l432">432</a><td> var newIter = new goog.iter.Iterator;<tr><td><a id="l433"></a><a href="#l433">433</a><td> newIter.next = function() {<tr><td><a id="l434"></a><a href="#l434">434</a><td> if (version != selfObj.version_) {<tr><td><a id="l435"></a><a href="#l435">435</a><td> throw Error('The map has changed since the iterator was created');<tr><td><a id="l436"></a><a href="#l436">436</a><td> }<tr><td><a id="l437"></a><a href="#l437">437</a><td> if (i >= selfObj.keys_.length) {<tr><td><a id="l438"></a><a href="#l438">438</a><td> throw goog.iter.StopIteration;<tr><td><a id="l439"></a><a href="#l439">439</a><td> }<tr><td><a id="l440"></a><a href="#l440">440</a><td> var key = selfObj.keys_[i++];<tr><td><a id="l441"></a><a href="#l441">441</a><td> return opt_keys ? key : selfObj.map_[key];<tr><td><a id="l442"></a><a href="#l442">442</a><td> };<tr><td><a id="l443"></a><a href="#l443">443</a><td> return newIter;<tr><td><a id="l444"></a><a href="#l444">444</a><td>};<tr><td><a id="l445"></a><a href="#l445">445</a><td><tr><td><a id="l446"></a><a href="#l446">446</a><td><tr><td><a id="l447"></a><a href="#l447">447</a><td>/**<tr><td><a id="l448"></a><a href="#l448">448</a><td> * Safe way to test for hasOwnProperty. It even allows testing for<tr><td><a id="l449"></a><a href="#l449">449</a><td> * 'hasOwnProperty'.<tr><td><a id="l450"></a><a href="#l450">450</a><td> * @param {Object} obj The object to test for presence of the given key.<tr><td><a id="l451"></a><a href="#l451">451</a><td> * @param {*} key The key to check for.<tr><td><a id="l452"></a><a href="#l452">452</a><td> * @return {boolean} Whether the object has the key.<tr><td><a id="l453"></a><a href="#l453">453</a><td> * @private<tr><td><a id="l454"></a><a href="#l454">454</a><td> */<tr><td><a id="l455"></a><a href="#l455">455</a><td>goog.structs.Map.hasKey_ = function(obj, key) {<tr><td><a id="l456"></a><a href="#l456">456</a><td> return Object.prototype.hasOwnProperty.call(obj, key);<tr><td><a id="l457"></a><a href="#l457">457</a><td>};</table></div></article><nav><h3><a href="../../../../index.html" tabindex="2">Overview</a></h3><div><input type="checkbox" id="nav-modules" checked/><label for="nav-modules"><h3><span class="selectable" tabindex="2">Modules</span></h3></label><div id="nav-modules-view"></div></div><div><input type="checkbox" id="nav-types" checked/><label for="nav-types"><h3><span class="selectable" tabindex="2">Types</span></h3></label><div id="nav-types-view"></div></div><h3><a href="../../../../Changes.html" tabindex="2">Changes</a></h3></nav></main><footer><div><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></div></footer><script src="../../../../types.js"></script><script src="../../../../dossier.js"></script>