Google Git
Sign in
apache / hbase-site / 0dd212ad7c7488fceadc568d4ed9edcae6b5fbc9 / . / devapidocs / src-html / org / apache / hadoop / hbase / regionserver / CellSet.html
blob: d667d2769f86dc02ca318edef350eda929d47f39 [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.regionserver, class: CellSet">
<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.regionserver;</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.util.Collection;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.Comparator;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.Iterator;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.NavigableMap;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.NavigableSet;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.SortedSet;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.concurrent.ConcurrentSkipListMap;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.Cell;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.CellComparator;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.HConstants;</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">/**</span>
<span class="source-line-no">033</span><span id="line-33"> * A {@link java.util.Set} of {@link Cell}s, where an add will overwrite the entry if already exists</span>
<span class="source-line-no">034</span><span id="line-34"> * in the set. The call to add returns true if no value in the backing map or false if there was an</span>
<span class="source-line-no">035</span><span id="line-35"> * entry with same key (though value may be different). implementation is tolerant of concurrent get</span>
<span class="source-line-no">036</span><span id="line-36"> * and set and won't throw ConcurrentModificationException when iterating.</span>
<span class="source-line-no">037</span><span id="line-37"> */</span>
<span class="source-line-no">038</span><span id="line-38">@InterfaceAudience.Private</span>
<span class="source-line-no">039</span><span id="line-39">public class CellSet&lt;T extends Cell&gt; implements NavigableSet&lt;T&gt; {</span>
<span class="source-line-no">040</span><span id="line-40"></span>
<span class="source-line-no">041</span><span id="line-41"> public static final int UNKNOWN_NUM_UNIQUES = -1;</span>
<span class="source-line-no">042</span><span id="line-42"> // Implemented on top of a {@link java.util.concurrent.ConcurrentSkipListMap}</span>
<span class="source-line-no">043</span><span id="line-43"> // Differ from CSLS in one respect, where CSLS does "Adds the specified element to this set if it</span>
<span class="source-line-no">044</span><span id="line-44"> // is not already present.", this implementation "Adds the specified element to this set EVEN</span>
<span class="source-line-no">045</span><span id="line-45"> // if it is already present overwriting what was there previous".</span>
<span class="source-line-no">046</span><span id="line-46"> // Otherwise, has same attributes as ConcurrentSkipListSet</span>
<span class="source-line-no">047</span><span id="line-47"> private final NavigableMap&lt;T, T&gt; delegatee; ///</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49"> private final int numUniqueKeys;</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51"> public CellSet(CellComparator c) {</span>
<span class="source-line-no">052</span><span id="line-52"> this.delegatee = new ConcurrentSkipListMap&lt;&gt;(c.getSimpleComparator());</span>
<span class="source-line-no">053</span><span id="line-53"> this.numUniqueKeys = UNKNOWN_NUM_UNIQUES;</span>
<span class="source-line-no">054</span><span id="line-54"> }</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> CellSet(final NavigableMap&lt;T, T&gt; m, int numUniqueKeys) {</span>
<span class="source-line-no">057</span><span id="line-57"> this.delegatee = m;</span>
<span class="source-line-no">058</span><span id="line-58"> this.numUniqueKeys = numUniqueKeys;</span>
<span class="source-line-no">059</span><span id="line-59"> }</span>
<span class="source-line-no">060</span><span id="line-60"></span>
<span class="source-line-no">061</span><span id="line-61"> CellSet(final NavigableMap&lt;T, T&gt; m) {</span>
<span class="source-line-no">062</span><span id="line-62"> this.delegatee = m;</span>
<span class="source-line-no">063</span><span id="line-63"> this.numUniqueKeys = UNKNOWN_NUM_UNIQUES;</span>
<span class="source-line-no">064</span><span id="line-64"> }</span>
<span class="source-line-no">065</span><span id="line-65"></span>
<span class="source-line-no">066</span><span id="line-66"> NavigableMap&lt;T, T&gt; getDelegatee() {</span>
<span class="source-line-no">067</span><span id="line-67"> return delegatee;</span>
<span class="source-line-no">068</span><span id="line-68"> }</span>
<span class="source-line-no">069</span><span id="line-69"></span>
<span class="source-line-no">070</span><span id="line-70"> @Override</span>
<span class="source-line-no">071</span><span id="line-71"> public T ceiling(T e) {</span>
<span class="source-line-no">072</span><span id="line-72"> throw new UnsupportedOperationException(HConstants.NOT_IMPLEMENTED);</span>
<span class="source-line-no">073</span><span id="line-73"> }</span>
<span class="source-line-no">074</span><span id="line-74"></span>
<span class="source-line-no">075</span><span id="line-75"> @Override</span>
<span class="source-line-no">076</span><span id="line-76"> public Iterator&lt;T&gt; descendingIterator() {</span>
<span class="source-line-no">077</span><span id="line-77"> return this.delegatee.descendingMap().values().iterator();</span>
<span class="source-line-no">078</span><span id="line-78"> }</span>
<span class="source-line-no">079</span><span id="line-79"></span>
<span class="source-line-no">080</span><span id="line-80"> @Override</span>
<span class="source-line-no">081</span><span id="line-81"> public NavigableSet&lt;T&gt; descendingSet() {</span>
<span class="source-line-no">082</span><span id="line-82"> throw new UnsupportedOperationException(HConstants.NOT_IMPLEMENTED);</span>
<span class="source-line-no">083</span><span id="line-83"> }</span>
<span class="source-line-no">084</span><span id="line-84"></span>
<span class="source-line-no">085</span><span id="line-85"> @Override</span>
<span class="source-line-no">086</span><span id="line-86"> public T floor(T e) {</span>
<span class="source-line-no">087</span><span id="line-87"> throw new UnsupportedOperationException(HConstants.NOT_IMPLEMENTED);</span>
<span class="source-line-no">088</span><span id="line-88"> }</span>
<span class="source-line-no">089</span><span id="line-89"></span>
<span class="source-line-no">090</span><span id="line-90"> @Override</span>
<span class="source-line-no">091</span><span id="line-91"> public SortedSet&lt;T&gt; headSet(final T toElement) {</span>
<span class="source-line-no">092</span><span id="line-92"> return headSet(toElement, false);</span>
<span class="source-line-no">093</span><span id="line-93"> }</span>
<span class="source-line-no">094</span><span id="line-94"></span>
<span class="source-line-no">095</span><span id="line-95"> @Override</span>
<span class="source-line-no">096</span><span id="line-96"> public NavigableSet&lt;T&gt; headSet(final T toElement, boolean inclusive) {</span>
<span class="source-line-no">097</span><span id="line-97"> return new CellSet&lt;&gt;(this.delegatee.headMap(toElement, inclusive), UNKNOWN_NUM_UNIQUES);</span>
<span class="source-line-no">098</span><span id="line-98"> }</span>
<span class="source-line-no">099</span><span id="line-99"></span>
<span class="source-line-no">100</span><span id="line-100"> @Override</span>
<span class="source-line-no">101</span><span id="line-101"> public T higher(T e) {</span>
<span class="source-line-no">102</span><span id="line-102"> throw new UnsupportedOperationException(HConstants.NOT_IMPLEMENTED);</span>
<span class="source-line-no">103</span><span id="line-103"> }</span>
<span class="source-line-no">104</span><span id="line-104"></span>
<span class="source-line-no">105</span><span id="line-105"> @Override</span>
<span class="source-line-no">106</span><span id="line-106"> public Iterator&lt;T&gt; iterator() {</span>
<span class="source-line-no">107</span><span id="line-107"> return this.delegatee.values().iterator();</span>
<span class="source-line-no">108</span><span id="line-108"> }</span>
<span class="source-line-no">109</span><span id="line-109"></span>
<span class="source-line-no">110</span><span id="line-110"> @Override</span>
<span class="source-line-no">111</span><span id="line-111"> public T lower(T e) {</span>
<span class="source-line-no">112</span><span id="line-112"> throw new UnsupportedOperationException(HConstants.NOT_IMPLEMENTED);</span>
<span class="source-line-no">113</span><span id="line-113"> }</span>
<span class="source-line-no">114</span><span id="line-114"></span>
<span class="source-line-no">115</span><span id="line-115"> @Override</span>
<span class="source-line-no">116</span><span id="line-116"> public T pollFirst() {</span>
<span class="source-line-no">117</span><span id="line-117"> throw new UnsupportedOperationException(HConstants.NOT_IMPLEMENTED);</span>
<span class="source-line-no">118</span><span id="line-118"> }</span>
<span class="source-line-no">119</span><span id="line-119"></span>
<span class="source-line-no">120</span><span id="line-120"> @Override</span>
<span class="source-line-no">121</span><span id="line-121"> public T pollLast() {</span>
<span class="source-line-no">122</span><span id="line-122"> throw new UnsupportedOperationException(HConstants.NOT_IMPLEMENTED);</span>
<span class="source-line-no">123</span><span id="line-123"> }</span>
<span class="source-line-no">124</span><span id="line-124"></span>
<span class="source-line-no">125</span><span id="line-125"> @Override</span>
<span class="source-line-no">126</span><span id="line-126"> public SortedSet&lt;T&gt; subSet(T fromElement, T toElement) {</span>
<span class="source-line-no">127</span><span id="line-127"> throw new UnsupportedOperationException(HConstants.NOT_IMPLEMENTED);</span>
<span class="source-line-no">128</span><span id="line-128"> }</span>
<span class="source-line-no">129</span><span id="line-129"></span>
<span class="source-line-no">130</span><span id="line-130"> @Override</span>
<span class="source-line-no">131</span><span id="line-131"> public NavigableSet&lt;T&gt; subSet(Cell fromElement, boolean fromInclusive, Cell toElement,</span>
<span class="source-line-no">132</span><span id="line-132"> boolean toInclusive) {</span>
<span class="source-line-no">133</span><span id="line-133"> throw new UnsupportedOperationException(HConstants.NOT_IMPLEMENTED);</span>
<span class="source-line-no">134</span><span id="line-134"> }</span>
<span class="source-line-no">135</span><span id="line-135"></span>
<span class="source-line-no">136</span><span id="line-136"> @Override</span>
<span class="source-line-no">137</span><span id="line-137"> public SortedSet&lt;T&gt; tailSet(T fromElement) {</span>
<span class="source-line-no">138</span><span id="line-138"> return tailSet(fromElement, true);</span>
<span class="source-line-no">139</span><span id="line-139"> }</span>
<span class="source-line-no">140</span><span id="line-140"></span>
<span class="source-line-no">141</span><span id="line-141"> @Override</span>
<span class="source-line-no">142</span><span id="line-142"> public NavigableSet&lt;T&gt; tailSet(T fromElement, boolean inclusive) {</span>
<span class="source-line-no">143</span><span id="line-143"> return new CellSet&lt;&gt;(this.delegatee.tailMap(fromElement, inclusive), UNKNOWN_NUM_UNIQUES);</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"> @Override</span>
<span class="source-line-no">147</span><span id="line-147"> public Comparator&lt;? super T&gt; comparator() {</span>
<span class="source-line-no">148</span><span id="line-148"> throw new UnsupportedOperationException(HConstants.NOT_IMPLEMENTED);</span>
<span class="source-line-no">149</span><span id="line-149"> }</span>
<span class="source-line-no">150</span><span id="line-150"></span>
<span class="source-line-no">151</span><span id="line-151"> @Override</span>
<span class="source-line-no">152</span><span id="line-152"> public T first() {</span>
<span class="source-line-no">153</span><span id="line-153"> return this.delegatee.firstEntry().getValue();</span>
<span class="source-line-no">154</span><span id="line-154"> }</span>
<span class="source-line-no">155</span><span id="line-155"></span>
<span class="source-line-no">156</span><span id="line-156"> @Override</span>
<span class="source-line-no">157</span><span id="line-157"> public T last() {</span>
<span class="source-line-no">158</span><span id="line-158"> return this.delegatee.lastEntry().getValue();</span>
<span class="source-line-no">159</span><span id="line-159"> }</span>
<span class="source-line-no">160</span><span id="line-160"></span>
<span class="source-line-no">161</span><span id="line-161"> @Override</span>
<span class="source-line-no">162</span><span id="line-162"> public boolean add(T e) {</span>
<span class="source-line-no">163</span><span id="line-163"> return this.delegatee.put(e, e) == null;</span>
<span class="source-line-no">164</span><span id="line-164"> }</span>
<span class="source-line-no">165</span><span id="line-165"></span>
<span class="source-line-no">166</span><span id="line-166"> @Override</span>
<span class="source-line-no">167</span><span id="line-167"> public boolean addAll(Collection&lt;? extends T&gt; c) {</span>
<span class="source-line-no">168</span><span id="line-168"> throw new UnsupportedOperationException(HConstants.NOT_IMPLEMENTED);</span>
<span class="source-line-no">169</span><span id="line-169"> }</span>
<span class="source-line-no">170</span><span id="line-170"></span>
<span class="source-line-no">171</span><span id="line-171"> @Override</span>
<span class="source-line-no">172</span><span id="line-172"> public void clear() {</span>
<span class="source-line-no">173</span><span id="line-173"> this.delegatee.clear();</span>
<span class="source-line-no">174</span><span id="line-174"> }</span>
<span class="source-line-no">175</span><span id="line-175"></span>
<span class="source-line-no">176</span><span id="line-176"> @Override</span>
<span class="source-line-no">177</span><span id="line-177"> public boolean contains(Object o) {</span>
<span class="source-line-no">178</span><span id="line-178"> // noinspection SuspiciousMethodCalls</span>
<span class="source-line-no">179</span><span id="line-179"> return this.delegatee.containsKey(o);</span>
<span class="source-line-no">180</span><span id="line-180"> }</span>
<span class="source-line-no">181</span><span id="line-181"></span>
<span class="source-line-no">182</span><span id="line-182"> @Override</span>
<span class="source-line-no">183</span><span id="line-183"> public boolean containsAll(Collection&lt;?&gt; c) {</span>
<span class="source-line-no">184</span><span id="line-184"> throw new UnsupportedOperationException(HConstants.NOT_IMPLEMENTED);</span>
<span class="source-line-no">185</span><span id="line-185"> }</span>
<span class="source-line-no">186</span><span id="line-186"></span>
<span class="source-line-no">187</span><span id="line-187"> @Override</span>
<span class="source-line-no">188</span><span id="line-188"> public boolean isEmpty() {</span>
<span class="source-line-no">189</span><span id="line-189"> return this.delegatee.isEmpty();</span>
<span class="source-line-no">190</span><span id="line-190"> }</span>
<span class="source-line-no">191</span><span id="line-191"></span>
<span class="source-line-no">192</span><span id="line-192"> @Override</span>
<span class="source-line-no">193</span><span id="line-193"> public boolean remove(Object o) {</span>
<span class="source-line-no">194</span><span id="line-194"> return this.delegatee.remove(o) != null;</span>
<span class="source-line-no">195</span><span id="line-195"> }</span>
<span class="source-line-no">196</span><span id="line-196"></span>
<span class="source-line-no">197</span><span id="line-197"> @Override</span>
<span class="source-line-no">198</span><span id="line-198"> public boolean removeAll(Collection&lt;?&gt; c) {</span>
<span class="source-line-no">199</span><span id="line-199"> throw new UnsupportedOperationException(HConstants.NOT_IMPLEMENTED);</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"> @Override</span>
<span class="source-line-no">203</span><span id="line-203"> public boolean retainAll(Collection&lt;?&gt; c) {</span>
<span class="source-line-no">204</span><span id="line-204"> throw new UnsupportedOperationException(HConstants.NOT_IMPLEMENTED);</span>
<span class="source-line-no">205</span><span id="line-205"> }</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 Cell get(Cell kv) {</span>
<span class="source-line-no">208</span><span id="line-208"> return this.delegatee.get(kv);</span>
<span class="source-line-no">209</span><span id="line-209"> }</span>
<span class="source-line-no">210</span><span id="line-210"></span>
<span class="source-line-no">211</span><span id="line-211"> @Override</span>
<span class="source-line-no">212</span><span id="line-212"> public int size() {</span>
<span class="source-line-no">213</span><span id="line-213"> if (delegatee instanceof ConcurrentSkipListMap) {</span>
<span class="source-line-no">214</span><span id="line-214"> throw new UnsupportedOperationException("ConcurrentSkipListMap.size() is time-consuming");</span>
<span class="source-line-no">215</span><span id="line-215"> }</span>
<span class="source-line-no">216</span><span id="line-216"> return this.delegatee.size();</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 Object[] toArray() {</span>
<span class="source-line-no">221</span><span id="line-221"> throw new UnsupportedOperationException(HConstants.NOT_IMPLEMENTED);</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 &lt;T&gt; T[] toArray(T[] a) {</span>
<span class="source-line-no">226</span><span id="line-226"> throw new UnsupportedOperationException(HConstants.NOT_IMPLEMENTED);</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"> public int getNumUniqueKeys() {</span>
<span class="source-line-no">230</span><span id="line-230"> return numUniqueKeys;</span>
<span class="source-line-no">231</span><span id="line-231"> }</span>
<span class="source-line-no">232</span><span id="line-232">}</span>
</pre>
</div>
</main>
</body>
</html>