blob: 251b369e0e0e3f6fdc80db226661b96e2e623603 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase, class: CompoundConfiguration">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.io.DataOutput;</span>
<span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span>
<span class="source-line-no">022</span><span id="line-22">import java.io.OutputStream;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.ArrayList;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.HashMap;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.Iterator;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.List;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.Map;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.conf.Configuration;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">031</span><span id="line-31"></span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.hbase.thirdparty.org.apache.commons.collections4.iterators.UnmodifiableIterator;</span>
<span class="source-line-no">033</span><span id="line-33"></span>
<span class="source-line-no">034</span><span id="line-34">/**</span>
<span class="source-line-no">035</span><span id="line-35"> * Do a shallow merge of multiple KV configuration pools. This is a very useful utility class to</span>
<span class="source-line-no">036</span><span id="line-36"> * easily add per-object configurations in addition to wider scope settings. This is different from</span>
<span class="source-line-no">037</span><span id="line-37"> * Configuration.addResource() functionality, which performs a deep merge and mutates the common</span>
<span class="source-line-no">038</span><span id="line-38"> * data structure.</span>
<span class="source-line-no">039</span><span id="line-39"> * &lt;p&gt;</span>
<span class="source-line-no">040</span><span id="line-40"> * The iterator on CompoundConfiguration is unmodifiable. Obtaining iterator is an expensive</span>
<span class="source-line-no">041</span><span id="line-41"> * operation.</span>
<span class="source-line-no">042</span><span id="line-42"> * &lt;p&gt;</span>
<span class="source-line-no">043</span><span id="line-43"> * For clarity: the shallow merge allows the user to mutate either of the configuration objects and</span>
<span class="source-line-no">044</span><span id="line-44"> * have changes reflected everywhere. In contrast to a deep merge, that requires you to explicitly</span>
<span class="source-line-no">045</span><span id="line-45"> * know all applicable copies to propagate changes. WARNING: The values set in the</span>
<span class="source-line-no">046</span><span id="line-46"> * CompoundConfiguration are do not handle Property variable substitution. However, if they are set</span>
<span class="source-line-no">047</span><span id="line-47"> * in the underlying configuration substitutions are done.</span>
<span class="source-line-no">048</span><span id="line-48"> */</span>
<span class="source-line-no">049</span><span id="line-49">@InterfaceAudience.Private</span>
<span class="source-line-no">050</span><span id="line-50">public class CompoundConfiguration extends Configuration {</span>
<span class="source-line-no">051</span><span id="line-51"></span>
<span class="source-line-no">052</span><span id="line-52"> private Configuration mutableConf = null;</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> /**</span>
<span class="source-line-no">055</span><span id="line-55"> * Default Constructor. Initializes empty configuration</span>
<span class="source-line-no">056</span><span id="line-56"> */</span>
<span class="source-line-no">057</span><span id="line-57"> public CompoundConfiguration() {</span>
<span class="source-line-no">058</span><span id="line-58"> }</span>
<span class="source-line-no">059</span><span id="line-59"></span>
<span class="source-line-no">060</span><span id="line-60"> // Devs: these APIs are the same contract as their counterparts in</span>
<span class="source-line-no">061</span><span id="line-61"> // Configuration.java</span>
<span class="source-line-no">062</span><span id="line-62"> private interface ImmutableConfigMap extends Iterable&lt;Map.Entry&lt;String, String&gt;&gt; {</span>
<span class="source-line-no">063</span><span id="line-63"> String get(String key);</span>
<span class="source-line-no">064</span><span id="line-64"></span>
<span class="source-line-no">065</span><span id="line-65"> String getRaw(String key);</span>
<span class="source-line-no">066</span><span id="line-66"></span>
<span class="source-line-no">067</span><span id="line-67"> Class&lt;?&gt; getClassByName(String name) throws ClassNotFoundException;</span>
<span class="source-line-no">068</span><span id="line-68"></span>
<span class="source-line-no">069</span><span id="line-69"> int size();</span>
<span class="source-line-no">070</span><span id="line-70"> }</span>
<span class="source-line-no">071</span><span id="line-71"></span>
<span class="source-line-no">072</span><span id="line-72"> private final List&lt;ImmutableConfigMap&gt; configs = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">073</span><span id="line-73"></span>
<span class="source-line-no">074</span><span id="line-74"> static class ImmutableConfWrapper implements ImmutableConfigMap {</span>
<span class="source-line-no">075</span><span id="line-75"> private final Configuration c;</span>
<span class="source-line-no">076</span><span id="line-76"></span>
<span class="source-line-no">077</span><span id="line-77"> ImmutableConfWrapper(Configuration conf) {</span>
<span class="source-line-no">078</span><span id="line-78"> c = conf;</span>
<span class="source-line-no">079</span><span id="line-79"> }</span>
<span class="source-line-no">080</span><span id="line-80"></span>
<span class="source-line-no">081</span><span id="line-81"> @Override</span>
<span class="source-line-no">082</span><span id="line-82"> public Iterator&lt;Map.Entry&lt;String, String&gt;&gt; iterator() {</span>
<span class="source-line-no">083</span><span id="line-83"> return c.iterator();</span>
<span class="source-line-no">084</span><span id="line-84"> }</span>
<span class="source-line-no">085</span><span id="line-85"></span>
<span class="source-line-no">086</span><span id="line-86"> @Override</span>
<span class="source-line-no">087</span><span id="line-87"> public String get(String key) {</span>
<span class="source-line-no">088</span><span id="line-88"> return c.get(key);</span>
<span class="source-line-no">089</span><span id="line-89"> }</span>
<span class="source-line-no">090</span><span id="line-90"></span>
<span class="source-line-no">091</span><span id="line-91"> @Override</span>
<span class="source-line-no">092</span><span id="line-92"> public String getRaw(String key) {</span>
<span class="source-line-no">093</span><span id="line-93"> return c.getRaw(key);</span>
<span class="source-line-no">094</span><span id="line-94"> }</span>
<span class="source-line-no">095</span><span id="line-95"></span>
<span class="source-line-no">096</span><span id="line-96"> @Override</span>
<span class="source-line-no">097</span><span id="line-97"> public Class&lt;?&gt; getClassByName(String name) throws ClassNotFoundException {</span>
<span class="source-line-no">098</span><span id="line-98"> return c.getClassByName(name);</span>
<span class="source-line-no">099</span><span id="line-99"> }</span>
<span class="source-line-no">100</span><span id="line-100"></span>
<span class="source-line-no">101</span><span id="line-101"> @Override</span>
<span class="source-line-no">102</span><span id="line-102"> public int size() {</span>
<span class="source-line-no">103</span><span id="line-103"> return c.size();</span>
<span class="source-line-no">104</span><span id="line-104"> }</span>
<span class="source-line-no">105</span><span id="line-105"></span>
<span class="source-line-no">106</span><span id="line-106"> @Override</span>
<span class="source-line-no">107</span><span id="line-107"> public String toString() {</span>
<span class="source-line-no">108</span><span id="line-108"> return c.toString();</span>
<span class="source-line-no">109</span><span id="line-109"> }</span>
<span class="source-line-no">110</span><span id="line-110"> }</span>
<span class="source-line-no">111</span><span id="line-111"></span>
<span class="source-line-no">112</span><span id="line-112"> /**</span>
<span class="source-line-no">113</span><span id="line-113"> * If set has been called, it will create a mutableConf. This converts the mutableConf to an</span>
<span class="source-line-no">114</span><span id="line-114"> * immutable one and resets it to allow a new mutable conf. This is used when a new map or conf is</span>
<span class="source-line-no">115</span><span id="line-115"> * added to the compound configuration to preserve proper override semantics.</span>
<span class="source-line-no">116</span><span id="line-116"> */</span>
<span class="source-line-no">117</span><span id="line-117"> void freezeMutableConf() {</span>
<span class="source-line-no">118</span><span id="line-118"> if (mutableConf == null) {</span>
<span class="source-line-no">119</span><span id="line-119"> // do nothing if there is no current mutableConf</span>
<span class="source-line-no">120</span><span id="line-120"> return;</span>
<span class="source-line-no">121</span><span id="line-121"> }</span>
<span class="source-line-no">122</span><span id="line-122"></span>
<span class="source-line-no">123</span><span id="line-123"> this.configs.add(0, new ImmutableConfWrapper(mutableConf));</span>
<span class="source-line-no">124</span><span id="line-124"> mutableConf = null;</span>
<span class="source-line-no">125</span><span id="line-125"> }</span>
<span class="source-line-no">126</span><span id="line-126"></span>
<span class="source-line-no">127</span><span id="line-127"> /**</span>
<span class="source-line-no">128</span><span id="line-128"> * Add Hadoop Configuration object to config list. The added configuration overrides the previous</span>
<span class="source-line-no">129</span><span id="line-129"> * ones if there are name collisions.</span>
<span class="source-line-no">130</span><span id="line-130"> * @param conf configuration object</span>
<span class="source-line-no">131</span><span id="line-131"> * @return this, for builder pattern</span>
<span class="source-line-no">132</span><span id="line-132"> */</span>
<span class="source-line-no">133</span><span id="line-133"> public CompoundConfiguration add(final Configuration conf) {</span>
<span class="source-line-no">134</span><span id="line-134"> freezeMutableConf();</span>
<span class="source-line-no">135</span><span id="line-135"></span>
<span class="source-line-no">136</span><span id="line-136"> if (conf instanceof CompoundConfiguration) {</span>
<span class="source-line-no">137</span><span id="line-137"> this.configs.addAll(0, ((CompoundConfiguration) conf).configs);</span>
<span class="source-line-no">138</span><span id="line-138"> return this;</span>
<span class="source-line-no">139</span><span id="line-139"> }</span>
<span class="source-line-no">140</span><span id="line-140"> // put new config at the front of the list (top priority)</span>
<span class="source-line-no">141</span><span id="line-141"> this.configs.add(0, new ImmutableConfWrapper(conf));</span>
<span class="source-line-no">142</span><span id="line-142"> return this;</span>
<span class="source-line-no">143</span><span id="line-143"> }</span>
<span class="source-line-no">144</span><span id="line-144"></span>
<span class="source-line-no">145</span><span id="line-145"> /**</span>
<span class="source-line-no">146</span><span id="line-146"> * Add Bytes map to config list. This map is generally created by HTableDescriptor or</span>
<span class="source-line-no">147</span><span id="line-147"> * HColumnDescriptor, but can be abstractly used. The added configuration overrides the previous</span>
<span class="source-line-no">148</span><span id="line-148"> * ones if there are name collisions. Bytes map</span>
<span class="source-line-no">149</span><span id="line-149"> * @return this, for builder pattern</span>
<span class="source-line-no">150</span><span id="line-150"> */</span>
<span class="source-line-no">151</span><span id="line-151"> public CompoundConfiguration addBytesMap(final Map&lt;Bytes, Bytes&gt; map) {</span>
<span class="source-line-no">152</span><span id="line-152"> freezeMutableConf();</span>
<span class="source-line-no">153</span><span id="line-153"></span>
<span class="source-line-no">154</span><span id="line-154"> // put new map at the front of the list (top priority)</span>
<span class="source-line-no">155</span><span id="line-155"> this.configs.add(0, new ImmutableConfigMap() {</span>
<span class="source-line-no">156</span><span id="line-156"> private final Map&lt;Bytes, Bytes&gt; m = map;</span>
<span class="source-line-no">157</span><span id="line-157"></span>
<span class="source-line-no">158</span><span id="line-158"> @Override</span>
<span class="source-line-no">159</span><span id="line-159"> public Iterator&lt;Map.Entry&lt;String, String&gt;&gt; iterator() {</span>
<span class="source-line-no">160</span><span id="line-160"> Map&lt;String, String&gt; ret = new HashMap&lt;&gt;();</span>
<span class="source-line-no">161</span><span id="line-161"> for (Map.Entry&lt;Bytes, Bytes&gt; entry : map.entrySet()) {</span>
<span class="source-line-no">162</span><span id="line-162"> String key = Bytes.toString(entry.getKey().get());</span>
<span class="source-line-no">163</span><span id="line-163"> String val = entry.getValue() == null ? null : Bytes.toString(entry.getValue().get());</span>
<span class="source-line-no">164</span><span id="line-164"> ret.put(key, val);</span>
<span class="source-line-no">165</span><span id="line-165"> }</span>
<span class="source-line-no">166</span><span id="line-166"> return ret.entrySet().iterator();</span>
<span class="source-line-no">167</span><span id="line-167"> }</span>
<span class="source-line-no">168</span><span id="line-168"></span>
<span class="source-line-no">169</span><span id="line-169"> @Override</span>
<span class="source-line-no">170</span><span id="line-170"> public String get(String key) {</span>
<span class="source-line-no">171</span><span id="line-171"> Bytes ibw = new Bytes(Bytes.toBytes(key));</span>
<span class="source-line-no">172</span><span id="line-172"> if (!m.containsKey(ibw)) return null;</span>
<span class="source-line-no">173</span><span id="line-173"> Bytes value = m.get(ibw);</span>
<span class="source-line-no">174</span><span id="line-174"> if (value == null || value.get() == null) return null;</span>
<span class="source-line-no">175</span><span id="line-175"> return Bytes.toString(value.get());</span>
<span class="source-line-no">176</span><span id="line-176"> }</span>
<span class="source-line-no">177</span><span id="line-177"></span>
<span class="source-line-no">178</span><span id="line-178"> @Override</span>
<span class="source-line-no">179</span><span id="line-179"> public String getRaw(String key) {</span>
<span class="source-line-no">180</span><span id="line-180"> return get(key);</span>
<span class="source-line-no">181</span><span id="line-181"> }</span>
<span class="source-line-no">182</span><span id="line-182"></span>
<span class="source-line-no">183</span><span id="line-183"> @Override</span>
<span class="source-line-no">184</span><span id="line-184"> public Class&lt;?&gt; getClassByName(String name) throws ClassNotFoundException {</span>
<span class="source-line-no">185</span><span id="line-185"> return null;</span>
<span class="source-line-no">186</span><span id="line-186"> }</span>
<span class="source-line-no">187</span><span id="line-187"></span>
<span class="source-line-no">188</span><span id="line-188"> @Override</span>
<span class="source-line-no">189</span><span id="line-189"> public int size() {</span>
<span class="source-line-no">190</span><span id="line-190"> return m.size();</span>
<span class="source-line-no">191</span><span id="line-191"> }</span>
<span class="source-line-no">192</span><span id="line-192"></span>
<span class="source-line-no">193</span><span id="line-193"> @Override</span>
<span class="source-line-no">194</span><span id="line-194"> public String toString() {</span>
<span class="source-line-no">195</span><span id="line-195"> return m.toString();</span>
<span class="source-line-no">196</span><span id="line-196"> }</span>
<span class="source-line-no">197</span><span id="line-197"> });</span>
<span class="source-line-no">198</span><span id="line-198"> return this;</span>
<span class="source-line-no">199</span><span id="line-199"> }</span>
<span class="source-line-no">200</span><span id="line-200"></span>
<span class="source-line-no">201</span><span id="line-201"> /**</span>
<span class="source-line-no">202</span><span id="line-202"> * Add String map to config list. This map is generally created by HTableDescriptor or</span>
<span class="source-line-no">203</span><span id="line-203"> * HColumnDescriptor, but can be abstractly used. The added configuration overrides the previous</span>
<span class="source-line-no">204</span><span id="line-204"> * ones if there are name collisions.</span>
<span class="source-line-no">205</span><span id="line-205"> * @return this, for builder pattern</span>
<span class="source-line-no">206</span><span id="line-206"> */</span>
<span class="source-line-no">207</span><span id="line-207"> public CompoundConfiguration addStringMap(final Map&lt;String, String&gt; map) {</span>
<span class="source-line-no">208</span><span id="line-208"> freezeMutableConf();</span>
<span class="source-line-no">209</span><span id="line-209"></span>
<span class="source-line-no">210</span><span id="line-210"> // put new map at the front of the list (top priority)</span>
<span class="source-line-no">211</span><span id="line-211"> this.configs.add(0, new ImmutableConfigMap() {</span>
<span class="source-line-no">212</span><span id="line-212"> private final Map&lt;String, String&gt; m = map;</span>
<span class="source-line-no">213</span><span id="line-213"></span>
<span class="source-line-no">214</span><span id="line-214"> @Override</span>
<span class="source-line-no">215</span><span id="line-215"> public Iterator&lt;Map.Entry&lt;String, String&gt;&gt; iterator() {</span>
<span class="source-line-no">216</span><span id="line-216"> return map.entrySet().iterator();</span>
<span class="source-line-no">217</span><span id="line-217"> }</span>
<span class="source-line-no">218</span><span id="line-218"></span>
<span class="source-line-no">219</span><span id="line-219"> @Override</span>
<span class="source-line-no">220</span><span id="line-220"> public String get(String key) {</span>
<span class="source-line-no">221</span><span id="line-221"> return m.get(key);</span>
<span class="source-line-no">222</span><span id="line-222"> }</span>
<span class="source-line-no">223</span><span id="line-223"></span>
<span class="source-line-no">224</span><span id="line-224"> @Override</span>
<span class="source-line-no">225</span><span id="line-225"> public String getRaw(String key) {</span>
<span class="source-line-no">226</span><span id="line-226"> return get(key);</span>
<span class="source-line-no">227</span><span id="line-227"> }</span>
<span class="source-line-no">228</span><span id="line-228"></span>
<span class="source-line-no">229</span><span id="line-229"> @Override</span>
<span class="source-line-no">230</span><span id="line-230"> public Class&lt;?&gt; getClassByName(String name) throws ClassNotFoundException {</span>
<span class="source-line-no">231</span><span id="line-231"> return null;</span>
<span class="source-line-no">232</span><span id="line-232"> }</span>
<span class="source-line-no">233</span><span id="line-233"></span>
<span class="source-line-no">234</span><span id="line-234"> @Override</span>
<span class="source-line-no">235</span><span id="line-235"> public int size() {</span>
<span class="source-line-no">236</span><span id="line-236"> return m.size();</span>
<span class="source-line-no">237</span><span id="line-237"> }</span>
<span class="source-line-no">238</span><span id="line-238"></span>
<span class="source-line-no">239</span><span id="line-239"> @Override</span>
<span class="source-line-no">240</span><span id="line-240"> public String toString() {</span>
<span class="source-line-no">241</span><span id="line-241"> return m.toString();</span>
<span class="source-line-no">242</span><span id="line-242"> }</span>
<span class="source-line-no">243</span><span id="line-243"> });</span>
<span class="source-line-no">244</span><span id="line-244"> return this;</span>
<span class="source-line-no">245</span><span id="line-245"> }</span>
<span class="source-line-no">246</span><span id="line-246"></span>
<span class="source-line-no">247</span><span id="line-247"> @Override</span>
<span class="source-line-no">248</span><span id="line-248"> public String toString() {</span>
<span class="source-line-no">249</span><span id="line-249"> StringBuilder sb = new StringBuilder();</span>
<span class="source-line-no">250</span><span id="line-250"> sb.append("CompoundConfiguration: " + this.configs.size() + " configs");</span>
<span class="source-line-no">251</span><span id="line-251"> for (ImmutableConfigMap m : this.configs) {</span>
<span class="source-line-no">252</span><span id="line-252"> sb.append(m);</span>
<span class="source-line-no">253</span><span id="line-253"> }</span>
<span class="source-line-no">254</span><span id="line-254"> return sb.toString();</span>
<span class="source-line-no">255</span><span id="line-255"> }</span>
<span class="source-line-no">256</span><span id="line-256"></span>
<span class="source-line-no">257</span><span id="line-257"> @Override</span>
<span class="source-line-no">258</span><span id="line-258"> public String get(String key) {</span>
<span class="source-line-no">259</span><span id="line-259"> if (mutableConf != null) {</span>
<span class="source-line-no">260</span><span id="line-260"> String value = mutableConf.get(key);</span>
<span class="source-line-no">261</span><span id="line-261"> if (value != null) {</span>
<span class="source-line-no">262</span><span id="line-262"> return value;</span>
<span class="source-line-no">263</span><span id="line-263"> }</span>
<span class="source-line-no">264</span><span id="line-264"> }</span>
<span class="source-line-no">265</span><span id="line-265"></span>
<span class="source-line-no">266</span><span id="line-266"> for (ImmutableConfigMap m : this.configs) {</span>
<span class="source-line-no">267</span><span id="line-267"> String value = m.get(key);</span>
<span class="source-line-no">268</span><span id="line-268"> if (value != null) {</span>
<span class="source-line-no">269</span><span id="line-269"> return value;</span>
<span class="source-line-no">270</span><span id="line-270"> }</span>
<span class="source-line-no">271</span><span id="line-271"> }</span>
<span class="source-line-no">272</span><span id="line-272"> return null;</span>
<span class="source-line-no">273</span><span id="line-273"> }</span>
<span class="source-line-no">274</span><span id="line-274"></span>
<span class="source-line-no">275</span><span id="line-275"> @Override</span>
<span class="source-line-no">276</span><span id="line-276"> public String getRaw(String key) {</span>
<span class="source-line-no">277</span><span id="line-277"> if (mutableConf != null) {</span>
<span class="source-line-no">278</span><span id="line-278"> String value = mutableConf.getRaw(key);</span>
<span class="source-line-no">279</span><span id="line-279"> if (value != null) {</span>
<span class="source-line-no">280</span><span id="line-280"> return value;</span>
<span class="source-line-no">281</span><span id="line-281"> }</span>
<span class="source-line-no">282</span><span id="line-282"> }</span>
<span class="source-line-no">283</span><span id="line-283"></span>
<span class="source-line-no">284</span><span id="line-284"> for (ImmutableConfigMap m : this.configs) {</span>
<span class="source-line-no">285</span><span id="line-285"> String value = m.getRaw(key);</span>
<span class="source-line-no">286</span><span id="line-286"> if (value != null) {</span>
<span class="source-line-no">287</span><span id="line-287"> return value;</span>
<span class="source-line-no">288</span><span id="line-288"> }</span>
<span class="source-line-no">289</span><span id="line-289"> }</span>
<span class="source-line-no">290</span><span id="line-290"> return null;</span>
<span class="source-line-no">291</span><span id="line-291"> }</span>
<span class="source-line-no">292</span><span id="line-292"></span>
<span class="source-line-no">293</span><span id="line-293"> @Override</span>
<span class="source-line-no">294</span><span id="line-294"> public Class&lt;?&gt; getClassByName(String name) throws ClassNotFoundException {</span>
<span class="source-line-no">295</span><span id="line-295"> if (mutableConf != null) {</span>
<span class="source-line-no">296</span><span id="line-296"> Class&lt;?&gt; value = mutableConf.getClassByName(name);</span>
<span class="source-line-no">297</span><span id="line-297"> if (value != null) {</span>
<span class="source-line-no">298</span><span id="line-298"> return value;</span>
<span class="source-line-no">299</span><span id="line-299"> }</span>
<span class="source-line-no">300</span><span id="line-300"> }</span>
<span class="source-line-no">301</span><span id="line-301"></span>
<span class="source-line-no">302</span><span id="line-302"> for (ImmutableConfigMap m : this.configs) {</span>
<span class="source-line-no">303</span><span id="line-303"> Class&lt;?&gt; value = m.getClassByName(name);</span>
<span class="source-line-no">304</span><span id="line-304"> if (value != null) {</span>
<span class="source-line-no">305</span><span id="line-305"> return value;</span>
<span class="source-line-no">306</span><span id="line-306"> }</span>
<span class="source-line-no">307</span><span id="line-307"> }</span>
<span class="source-line-no">308</span><span id="line-308"> throw new ClassNotFoundException();</span>
<span class="source-line-no">309</span><span id="line-309"> }</span>
<span class="source-line-no">310</span><span id="line-310"></span>
<span class="source-line-no">311</span><span id="line-311"> // TODO: This method overestimates the number of configuration settings -- if a value is masked</span>
<span class="source-line-no">312</span><span id="line-312"> // by an overriding config or map, it will be counted multiple times.</span>
<span class="source-line-no">313</span><span id="line-313"> @Override</span>
<span class="source-line-no">314</span><span id="line-314"> public int size() {</span>
<span class="source-line-no">315</span><span id="line-315"> int ret = 0;</span>
<span class="source-line-no">316</span><span id="line-316"></span>
<span class="source-line-no">317</span><span id="line-317"> if (mutableConf != null) {</span>
<span class="source-line-no">318</span><span id="line-318"> ret += mutableConf.size();</span>
<span class="source-line-no">319</span><span id="line-319"> }</span>
<span class="source-line-no">320</span><span id="line-320"></span>
<span class="source-line-no">321</span><span id="line-321"> for (ImmutableConfigMap m : this.configs) {</span>
<span class="source-line-no">322</span><span id="line-322"> ret += m.size();</span>
<span class="source-line-no">323</span><span id="line-323"> }</span>
<span class="source-line-no">324</span><span id="line-324"> return ret;</span>
<span class="source-line-no">325</span><span id="line-325"> }</span>
<span class="source-line-no">326</span><span id="line-326"></span>
<span class="source-line-no">327</span><span id="line-327"> /**</span>
<span class="source-line-no">328</span><span id="line-328"> * Get the value of the &lt;code&gt;name&lt;/code&gt;. If the key is deprecated, it returns the value of the</span>
<span class="source-line-no">329</span><span id="line-329"> * first key which replaces the deprecated key and is not null. If no such property exists, then</span>
<span class="source-line-no">330</span><span id="line-330"> * &lt;code&gt;defaultValue&lt;/code&gt; is returned. The CompooundConfiguration does not do property</span>
<span class="source-line-no">331</span><span id="line-331"> * substitution. To do so we need Configuration.getProps to be protected or package visible.</span>
<span class="source-line-no">332</span><span id="line-332"> * Though in hadoop2 it is protected, in hadoop1 the method is private and not accessible. All of</span>
<span class="source-line-no">333</span><span id="line-333"> * the get* methods call this overridden get method.</span>
<span class="source-line-no">334</span><span id="line-334"> * @param name property name.</span>
<span class="source-line-no">335</span><span id="line-335"> * @param defaultValue default value.</span>
<span class="source-line-no">336</span><span id="line-336"> * @return property value, or &lt;code&gt;defaultValue&lt;/code&gt; if the property doesn't exist.</span>
<span class="source-line-no">337</span><span id="line-337"> **/</span>
<span class="source-line-no">338</span><span id="line-338"> @Override</span>
<span class="source-line-no">339</span><span id="line-339"> public String get(String name, String defaultValue) {</span>
<span class="source-line-no">340</span><span id="line-340"> String ret = get(name);</span>
<span class="source-line-no">341</span><span id="line-341"> return ret == null ? defaultValue : ret;</span>
<span class="source-line-no">342</span><span id="line-342"> }</span>
<span class="source-line-no">343</span><span id="line-343"></span>
<span class="source-line-no">344</span><span id="line-344"> @Override</span>
<span class="source-line-no">345</span><span id="line-345"> public Iterator&lt;Map.Entry&lt;String, String&gt;&gt; iterator() {</span>
<span class="source-line-no">346</span><span id="line-346"> Map&lt;String, String&gt; ret = new HashMap&lt;&gt;();</span>
<span class="source-line-no">347</span><span id="line-347"></span>
<span class="source-line-no">348</span><span id="line-348"> // add in reverse order so that oldest get overridden.</span>
<span class="source-line-no">349</span><span id="line-349"> if (!configs.isEmpty()) {</span>
<span class="source-line-no">350</span><span id="line-350"> for (int i = configs.size() - 1; i &gt;= 0; i--) {</span>
<span class="source-line-no">351</span><span id="line-351"> ImmutableConfigMap map = configs.get(i);</span>
<span class="source-line-no">352</span><span id="line-352"> Iterator&lt;Map.Entry&lt;String, String&gt;&gt; iter = map.iterator();</span>
<span class="source-line-no">353</span><span id="line-353"> while (iter.hasNext()) {</span>
<span class="source-line-no">354</span><span id="line-354"> Map.Entry&lt;String, String&gt; entry = iter.next();</span>
<span class="source-line-no">355</span><span id="line-355"> ret.put(entry.getKey(), entry.getValue());</span>
<span class="source-line-no">356</span><span id="line-356"> }</span>
<span class="source-line-no">357</span><span id="line-357"> }</span>
<span class="source-line-no">358</span><span id="line-358"> }</span>
<span class="source-line-no">359</span><span id="line-359"></span>
<span class="source-line-no">360</span><span id="line-360"> // add mutations to this CompoundConfiguration last.</span>
<span class="source-line-no">361</span><span id="line-361"> if (mutableConf != null) {</span>
<span class="source-line-no">362</span><span id="line-362"> Iterator&lt;Map.Entry&lt;String, String&gt;&gt; miter = mutableConf.iterator();</span>
<span class="source-line-no">363</span><span id="line-363"> while (miter.hasNext()) {</span>
<span class="source-line-no">364</span><span id="line-364"> Map.Entry&lt;String, String&gt; entry = miter.next();</span>
<span class="source-line-no">365</span><span id="line-365"> ret.put(entry.getKey(), entry.getValue());</span>
<span class="source-line-no">366</span><span id="line-366"> }</span>
<span class="source-line-no">367</span><span id="line-367"> }</span>
<span class="source-line-no">368</span><span id="line-368"></span>
<span class="source-line-no">369</span><span id="line-369"> return UnmodifiableIterator.unmodifiableIterator(ret.entrySet().iterator());</span>
<span class="source-line-no">370</span><span id="line-370"> }</span>
<span class="source-line-no">371</span><span id="line-371"></span>
<span class="source-line-no">372</span><span id="line-372"> @Override</span>
<span class="source-line-no">373</span><span id="line-373"> public void set(String name, String value) {</span>
<span class="source-line-no">374</span><span id="line-374"> if (mutableConf == null) {</span>
<span class="source-line-no">375</span><span id="line-375"> // not thread safe</span>
<span class="source-line-no">376</span><span id="line-376"> mutableConf = new Configuration(false); // an empty configuration</span>
<span class="source-line-no">377</span><span id="line-377"> }</span>
<span class="source-line-no">378</span><span id="line-378"> mutableConf.set(name, value);</span>
<span class="source-line-no">379</span><span id="line-379"> }</span>
<span class="source-line-no">380</span><span id="line-380"></span>
<span class="source-line-no">381</span><span id="line-381"> /***********************************************************************************************</span>
<span class="source-line-no">382</span><span id="line-382"> * These methods are unsupported, and no code using CompoundConfiguration depend upon them.</span>
<span class="source-line-no">383</span><span id="line-383"> * Quickly abort upon any attempts to use them.</span>
<span class="source-line-no">384</span><span id="line-384"> **********************************************************************************************/</span>
<span class="source-line-no">385</span><span id="line-385"></span>
<span class="source-line-no">386</span><span id="line-386"> @Override</span>
<span class="source-line-no">387</span><span id="line-387"> public void clear() {</span>
<span class="source-line-no">388</span><span id="line-388"> throw new UnsupportedOperationException("Immutable Configuration");</span>
<span class="source-line-no">389</span><span id="line-389"> }</span>
<span class="source-line-no">390</span><span id="line-390"></span>
<span class="source-line-no">391</span><span id="line-391"> @Override</span>
<span class="source-line-no">392</span><span id="line-392"> public void write(DataOutput out) throws IOException {</span>
<span class="source-line-no">393</span><span id="line-393"> throw new UnsupportedOperationException("Immutable Configuration");</span>
<span class="source-line-no">394</span><span id="line-394"> }</span>
<span class="source-line-no">395</span><span id="line-395"></span>
<span class="source-line-no">396</span><span id="line-396"> @Override</span>
<span class="source-line-no">397</span><span id="line-397"> public void writeXml(OutputStream out) throws IOException {</span>
<span class="source-line-no">398</span><span id="line-398"> throw new UnsupportedOperationException("Immutable Configuration");</span>
<span class="source-line-no">399</span><span id="line-399"> }</span>
<span class="source-line-no">400</span><span id="line-400">}</span>
</pre>
</div>
</main>
</body>
</html>