Google Git
Sign in
apache / hbase-site / 8ac68d4b7a8449d1b079203ac526389e2358d31e / . / devapidocs / src-html / org / apache / hadoop / hbase / util / SimpleMutableByteRange.html
blob: 7a6862f58b7d405d77ec1d6010ffd112ab71c34f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
<span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
<span class="sourceLineNo">017</span> *<a name="line.17"></a>
<span class="sourceLineNo">018</span> * The portion of this file denoted by 'Copied from com.google.protobuf.CodedOutputStream'<a name="line.18"></a>
<span class="sourceLineNo">019</span> * is from Protocol Buffers v2.5.0 under the following license<a name="line.19"></a>
<span class="sourceLineNo">020</span> *<a name="line.20"></a>
<span class="sourceLineNo">021</span> * Copyright 2008 Google Inc. All rights reserved.<a name="line.21"></a>
<span class="sourceLineNo">022</span> * http://code.google.com/p/protobuf/<a name="line.22"></a>
<span class="sourceLineNo">023</span> *<a name="line.23"></a>
<span class="sourceLineNo">024</span> * Redistribution and use in source and binary forms, with or without<a name="line.24"></a>
<span class="sourceLineNo">025</span> * modification, are permitted provided that the following conditions are<a name="line.25"></a>
<span class="sourceLineNo">026</span> * met:<a name="line.26"></a>
<span class="sourceLineNo">027</span> *<a name="line.27"></a>
<span class="sourceLineNo">028</span> * * Redistributions of source code must retain the above copyright<a name="line.28"></a>
<span class="sourceLineNo">029</span> * notice, this list of conditions and the following disclaimer.<a name="line.29"></a>
<span class="sourceLineNo">030</span> * * Redistributions in binary form must reproduce the above<a name="line.30"></a>
<span class="sourceLineNo">031</span> * copyright notice, this list of conditions and the following disclaimer<a name="line.31"></a>
<span class="sourceLineNo">032</span> * in the documentation and/or other materials provided with the<a name="line.32"></a>
<span class="sourceLineNo">033</span> * distribution.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * * Neither the name of Google Inc. nor the names of its<a name="line.34"></a>
<span class="sourceLineNo">035</span> * contributors may be used to endorse or promote products derived from<a name="line.35"></a>
<span class="sourceLineNo">036</span> * this software without specific prior written permission.<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS<a name="line.38"></a>
<span class="sourceLineNo">039</span> * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT<a name="line.39"></a>
<span class="sourceLineNo">040</span> * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR<a name="line.40"></a>
<span class="sourceLineNo">041</span> * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT<a name="line.41"></a>
<span class="sourceLineNo">042</span> * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,<a name="line.42"></a>
<span class="sourceLineNo">043</span> * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT<a name="line.43"></a>
<span class="sourceLineNo">044</span> * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,<a name="line.44"></a>
<span class="sourceLineNo">045</span> * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY<a name="line.45"></a>
<span class="sourceLineNo">046</span> * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT<a name="line.46"></a>
<span class="sourceLineNo">047</span> * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE<a name="line.47"></a>
<span class="sourceLineNo">048</span> * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.<a name="line.48"></a>
<span class="sourceLineNo">049</span> */<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span>package org.apache.hadoop.hbase.util;<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>/**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * A basic mutable {@link ByteRange} implementation.<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span>@InterfaceAudience.Public<a name="line.58"></a>
<span class="sourceLineNo">059</span>public class SimpleMutableByteRange extends AbstractByteRange {<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * Create a new {@code ByteRange} lacking a backing array and with an<a name="line.62"></a>
<span class="sourceLineNo">063</span> * undefined viewport.<a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span> public SimpleMutableByteRange() {<a name="line.65"></a>
<span class="sourceLineNo">066</span> unset();<a name="line.66"></a>
<span class="sourceLineNo">067</span> }<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> /**<a name="line.69"></a>
<span class="sourceLineNo">070</span> * Create a new {@code ByteRange} over a new backing array of size<a name="line.70"></a>
<span class="sourceLineNo">071</span> * {@code capacity}. The range's offset and length are 0 and {@code capacity},<a name="line.71"></a>
<span class="sourceLineNo">072</span> * respectively.<a name="line.72"></a>
<span class="sourceLineNo">073</span> * <a name="line.73"></a>
<span class="sourceLineNo">074</span> * @param capacity<a name="line.74"></a>
<span class="sourceLineNo">075</span> * the size of the backing array.<a name="line.75"></a>
<span class="sourceLineNo">076</span> */<a name="line.76"></a>
<span class="sourceLineNo">077</span> public SimpleMutableByteRange(int capacity) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> this(new byte[capacity]);<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> /**<a name="line.81"></a>
<span class="sourceLineNo">082</span> * Create a new {@code ByteRange} over the provided {@code bytes}.<a name="line.82"></a>
<span class="sourceLineNo">083</span> * <a name="line.83"></a>
<span class="sourceLineNo">084</span> * @param bytes<a name="line.84"></a>
<span class="sourceLineNo">085</span> * The array to wrap.<a name="line.85"></a>
<span class="sourceLineNo">086</span> */<a name="line.86"></a>
<span class="sourceLineNo">087</span> public SimpleMutableByteRange(byte[] bytes) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> set(bytes);<a name="line.88"></a>
<span class="sourceLineNo">089</span> }<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span> /**<a name="line.91"></a>
<span class="sourceLineNo">092</span> * Create a new {@code ByteRange} over the provided {@code bytes}.<a name="line.92"></a>
<span class="sourceLineNo">093</span> *<a name="line.93"></a>
<span class="sourceLineNo">094</span> * @param bytes<a name="line.94"></a>
<span class="sourceLineNo">095</span> * The array to wrap.<a name="line.95"></a>
<span class="sourceLineNo">096</span> * @param offset<a name="line.96"></a>
<span class="sourceLineNo">097</span> * The offset into {@code bytes} considered the beginning of this<a name="line.97"></a>
<span class="sourceLineNo">098</span> * range.<a name="line.98"></a>
<span class="sourceLineNo">099</span> * @param length<a name="line.99"></a>
<span class="sourceLineNo">100</span> * The length of this range.<a name="line.100"></a>
<span class="sourceLineNo">101</span> */<a name="line.101"></a>
<span class="sourceLineNo">102</span> public SimpleMutableByteRange(byte[] bytes, int offset, int length) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> set(bytes, offset, length);<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> @Override<a name="line.106"></a>
<span class="sourceLineNo">107</span> public ByteRange unset() {<a name="line.107"></a>
<span class="sourceLineNo">108</span> clearHashCache();<a name="line.108"></a>
<span class="sourceLineNo">109</span> bytes = null;<a name="line.109"></a>
<span class="sourceLineNo">110</span> offset = 0;<a name="line.110"></a>
<span class="sourceLineNo">111</span> length = 0;<a name="line.111"></a>
<span class="sourceLineNo">112</span> return this;<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> @Override<a name="line.115"></a>
<span class="sourceLineNo">116</span> public ByteRange put(int index, byte val) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> bytes[offset + index] = val;<a name="line.117"></a>
<span class="sourceLineNo">118</span> clearHashCache();<a name="line.118"></a>
<span class="sourceLineNo">119</span> return this;<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> @Override<a name="line.122"></a>
<span class="sourceLineNo">123</span> public ByteRange put(int index, byte[] val) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> if (0 == val.length)<a name="line.124"></a>
<span class="sourceLineNo">125</span> return this;<a name="line.125"></a>
<span class="sourceLineNo">126</span> return put(index, val, 0, val.length);<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> @Override<a name="line.129"></a>
<span class="sourceLineNo">130</span> public ByteRange put(int index, byte[] val, int offset, int length) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> if (0 == length)<a name="line.131"></a>
<span class="sourceLineNo">132</span> return this;<a name="line.132"></a>
<span class="sourceLineNo">133</span> System.arraycopy(val, offset, this.bytes, this.offset + index, length);<a name="line.133"></a>
<span class="sourceLineNo">134</span> clearHashCache();<a name="line.134"></a>
<span class="sourceLineNo">135</span> return this;<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span> @Override<a name="line.138"></a>
<span class="sourceLineNo">139</span> public ByteRange putShort(int index, short val) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> // This writing is same as BB's putShort. When byte[] is wrapped in a BB and<a name="line.140"></a>
<span class="sourceLineNo">141</span> // call putShort(),<a name="line.141"></a>
<span class="sourceLineNo">142</span> // one can get the same result.<a name="line.142"></a>
<span class="sourceLineNo">143</span> bytes[offset + index + 1] = (byte) val;<a name="line.143"></a>
<span class="sourceLineNo">144</span> val &gt;&gt;= 8;<a name="line.144"></a>
<span class="sourceLineNo">145</span> bytes[offset + index] = (byte) val;<a name="line.145"></a>
<span class="sourceLineNo">146</span> clearHashCache();<a name="line.146"></a>
<span class="sourceLineNo">147</span> return this;<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span> @Override<a name="line.150"></a>
<span class="sourceLineNo">151</span> public ByteRange putInt(int index, int val) {<a name="line.151"></a>
<span class="sourceLineNo">152</span> // This writing is same as BB's putInt. When byte[] is wrapped in a BB and<a name="line.152"></a>
<span class="sourceLineNo">153</span> // call getInt(), one<a name="line.153"></a>
<span class="sourceLineNo">154</span> // can get the same result.<a name="line.154"></a>
<span class="sourceLineNo">155</span> for (int i = Bytes.SIZEOF_INT - 1; i &gt; 0; i--) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> bytes[offset + index + i] = (byte) val;<a name="line.156"></a>
<span class="sourceLineNo">157</span> val &gt;&gt;&gt;= 8;<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span> bytes[offset + index] = (byte) val;<a name="line.159"></a>
<span class="sourceLineNo">160</span> clearHashCache();<a name="line.160"></a>
<span class="sourceLineNo">161</span> return this;<a name="line.161"></a>
<span class="sourceLineNo">162</span> }<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> @Override<a name="line.164"></a>
<span class="sourceLineNo">165</span> public ByteRange putLong(int index, long val) {<a name="line.165"></a>
<span class="sourceLineNo">166</span> // This writing is same as BB's putLong. When byte[] is wrapped in a BB and<a name="line.166"></a>
<span class="sourceLineNo">167</span> // call putLong(), one<a name="line.167"></a>
<span class="sourceLineNo">168</span> // can get the same result.<a name="line.168"></a>
<span class="sourceLineNo">169</span> for (int i = Bytes.SIZEOF_LONG - 1; i &gt; 0; i--) {<a name="line.169"></a>
<span class="sourceLineNo">170</span> bytes[offset + index + i] = (byte) val;<a name="line.170"></a>
<span class="sourceLineNo">171</span> val &gt;&gt;&gt;= 8;<a name="line.171"></a>
<span class="sourceLineNo">172</span> }<a name="line.172"></a>
<span class="sourceLineNo">173</span> bytes[offset + index] = (byte) val;<a name="line.173"></a>
<span class="sourceLineNo">174</span> clearHashCache();<a name="line.174"></a>
<span class="sourceLineNo">175</span> return this;<a name="line.175"></a>
<span class="sourceLineNo">176</span> }<a name="line.176"></a>
<span class="sourceLineNo">177</span><a name="line.177"></a>
<span class="sourceLineNo">178</span> // Copied from com.google.protobuf.CodedOutputStream v2.5.0 writeRawVarint64<a name="line.178"></a>
<span class="sourceLineNo">179</span> @Override<a name="line.179"></a>
<span class="sourceLineNo">180</span> public int putVLong(int index, long val) {<a name="line.180"></a>
<span class="sourceLineNo">181</span> int rPos = 0;<a name="line.181"></a>
<span class="sourceLineNo">182</span> while (true) {<a name="line.182"></a>
<span class="sourceLineNo">183</span> if ((val &amp; ~0x7F) == 0) {<a name="line.183"></a>
<span class="sourceLineNo">184</span> bytes[offset + index + rPos] = (byte) val;<a name="line.184"></a>
<span class="sourceLineNo">185</span> break;<a name="line.185"></a>
<span class="sourceLineNo">186</span> } else {<a name="line.186"></a>
<span class="sourceLineNo">187</span> bytes[offset + index + rPos] = (byte) ((val &amp; 0x7F) | 0x80);<a name="line.187"></a>
<span class="sourceLineNo">188</span> val &gt;&gt;&gt;= 7;<a name="line.188"></a>
<span class="sourceLineNo">189</span> }<a name="line.189"></a>
<span class="sourceLineNo">190</span> rPos++;<a name="line.190"></a>
<span class="sourceLineNo">191</span> }<a name="line.191"></a>
<span class="sourceLineNo">192</span> clearHashCache();<a name="line.192"></a>
<span class="sourceLineNo">193</span> return rPos + 1;<a name="line.193"></a>
<span class="sourceLineNo">194</span> }<a name="line.194"></a>
<span class="sourceLineNo">195</span> // end copied from protobuf<a name="line.195"></a>
<span class="sourceLineNo">196</span><a name="line.196"></a>
<span class="sourceLineNo">197</span> @Override<a name="line.197"></a>
<span class="sourceLineNo">198</span> public ByteRange deepCopy() {<a name="line.198"></a>
<span class="sourceLineNo">199</span> SimpleMutableByteRange clone = new SimpleMutableByteRange(deepCopyToNewArray());<a name="line.199"></a>
<span class="sourceLineNo">200</span> if (isHashCached()) {<a name="line.200"></a>
<span class="sourceLineNo">201</span> clone.hash = hash;<a name="line.201"></a>
<span class="sourceLineNo">202</span> }<a name="line.202"></a>
<span class="sourceLineNo">203</span> return clone;<a name="line.203"></a>
<span class="sourceLineNo">204</span> }<a name="line.204"></a>
<span class="sourceLineNo">205</span><a name="line.205"></a>
<span class="sourceLineNo">206</span> @Override<a name="line.206"></a>
<span class="sourceLineNo">207</span> public ByteRange shallowCopy() {<a name="line.207"></a>
<span class="sourceLineNo">208</span> SimpleMutableByteRange clone = new SimpleMutableByteRange(bytes, offset, length);<a name="line.208"></a>
<span class="sourceLineNo">209</span> if (isHashCached()) {<a name="line.209"></a>
<span class="sourceLineNo">210</span> clone.hash = hash;<a name="line.210"></a>
<span class="sourceLineNo">211</span> }<a name="line.211"></a>
<span class="sourceLineNo">212</span> return clone;<a name="line.212"></a>
<span class="sourceLineNo">213</span> }<a name="line.213"></a>
<span class="sourceLineNo">214</span><a name="line.214"></a>
<span class="sourceLineNo">215</span> @Override<a name="line.215"></a>
<span class="sourceLineNo">216</span> public ByteRange shallowCopySubRange(int innerOffset, int copyLength) {<a name="line.216"></a>
<span class="sourceLineNo">217</span> SimpleMutableByteRange clone = new SimpleMutableByteRange(bytes, offset + innerOffset,<a name="line.217"></a>
<span class="sourceLineNo">218</span> copyLength);<a name="line.218"></a>
<span class="sourceLineNo">219</span> if (isHashCached()) {<a name="line.219"></a>
<span class="sourceLineNo">220</span> clone.hash = hash;<a name="line.220"></a>
<span class="sourceLineNo">221</span> }<a name="line.221"></a>
<span class="sourceLineNo">222</span> return clone;<a name="line.222"></a>
<span class="sourceLineNo">223</span> }<a name="line.223"></a>
<span class="sourceLineNo">224</span><a name="line.224"></a>
<span class="sourceLineNo">225</span> @Override<a name="line.225"></a>
<span class="sourceLineNo">226</span> public boolean equals(Object thatObject) {<a name="line.226"></a>
<span class="sourceLineNo">227</span> if (thatObject == null) {<a name="line.227"></a>
<span class="sourceLineNo">228</span> return false;<a name="line.228"></a>
<span class="sourceLineNo">229</span> }<a name="line.229"></a>
<span class="sourceLineNo">230</span> if (this == thatObject) {<a name="line.230"></a>
<span class="sourceLineNo">231</span> return true;<a name="line.231"></a>
<span class="sourceLineNo">232</span> }<a name="line.232"></a>
<span class="sourceLineNo">233</span> if (hashCode() != thatObject.hashCode()) {<a name="line.233"></a>
<span class="sourceLineNo">234</span> return false;<a name="line.234"></a>
<span class="sourceLineNo">235</span> }<a name="line.235"></a>
<span class="sourceLineNo">236</span> if (!(thatObject instanceof SimpleMutableByteRange)) {<a name="line.236"></a>
<span class="sourceLineNo">237</span> return false;<a name="line.237"></a>
<span class="sourceLineNo">238</span> }<a name="line.238"></a>
<span class="sourceLineNo">239</span> SimpleMutableByteRange that = (SimpleMutableByteRange) thatObject;<a name="line.239"></a>
<span class="sourceLineNo">240</span> return Bytes.equals(bytes, offset, length, that.bytes, that.offset, that.length);<a name="line.240"></a>
<span class="sourceLineNo">241</span> }<a name="line.241"></a>
<span class="sourceLineNo">242</span><a name="line.242"></a>
<span class="sourceLineNo">243</span>}<a name="line.243"></a>
</pre>
</div>
</body>
</html>