Google Git
Sign in
apache / hbase-site / 690a3160206c1db10da5912f1efe153de9843573 / . / devapidocs / src-html / org / apache / hadoop / hbase / util / ByteRange.html
blob: f248d316720af7f93cf14f8edc9b9fd1c44b44d5 [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><a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.hadoop.hbase.util;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>/**<a name="line.23"></a>
<span class="sourceLineNo">024</span> * Lightweight, reusable class for specifying ranges of byte[]'s.<a name="line.24"></a>
<span class="sourceLineNo">025</span> * &lt;p&gt;<a name="line.25"></a>
<span class="sourceLineNo">026</span> * {@code ByteRange} maintains an underlying byte[] and a viewport into that<a name="line.26"></a>
<span class="sourceLineNo">027</span> * byte[] as a range of bytes. The {@code ByteRange} is a mutable, reusable<a name="line.27"></a>
<span class="sourceLineNo">028</span> * object, so the underlying byte[] can be modified after instantiation. This<a name="line.28"></a>
<span class="sourceLineNo">029</span> * is done using the {@link #set(byte[])} and {@link #unset()} methods. Direct<a name="line.29"></a>
<span class="sourceLineNo">030</span> * access to the byte[] is also available via {@link #getBytes()}. The viewport<a name="line.30"></a>
<span class="sourceLineNo">031</span> * is defined by an {@code offset} into the byte[] and a {@code length}. The<a name="line.31"></a>
<span class="sourceLineNo">032</span> * range of bytes is 0-indexed, and is accessed by index via the<a name="line.32"></a>
<span class="sourceLineNo">033</span> * {@link #get(int)} and {@link #put(int, byte)} methods.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;/p&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * &lt;p&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * This interface differs from ByteBuffer:<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;/p&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;ul&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;li&gt;On-heap bytes only&lt;/li&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;li&gt;Raw {@code byte} access only; does not encode other primitives.&lt;/li&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;li&gt;Implements {@code equals(Object)}, {@code #hashCode()}, and<a name="line.41"></a>
<span class="sourceLineNo">042</span> * {@code #compareTo(ByteRange)} so that it can be used in standard java<a name="line.42"></a>
<span class="sourceLineNo">043</span> * Collections. Comparison operations are lexicographic, which is native to<a name="line.43"></a>
<span class="sourceLineNo">044</span> * HBase.&lt;/li&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;li&gt;Allows the addition of simple core methods like the deep and shallow<a name="line.45"></a>
<span class="sourceLineNo">046</span> * copy methods.&lt;/li&gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;li&gt;Can be reused in tight loops like a major compaction which can save<a name="line.47"></a>
<span class="sourceLineNo">048</span> * significant amounts of garbage. (Without reuse, we throw off garbage like<a name="line.48"></a>
<span class="sourceLineNo">049</span> * &lt;a href="http://www.youtube.com/watch?v=lkmBH-MjZF4"&gt;this thing&lt;/a&gt;.)&lt;/li&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;/ul&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> * &lt;p&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span> * Mutable, and always evaluates {@code #equals(Object)}, {@code #hashCode()},<a name="line.52"></a>
<span class="sourceLineNo">053</span> * and {@code #compareTo(ByteRange)} based on the current contents.<a name="line.53"></a>
<span class="sourceLineNo">054</span> * &lt;/p&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;p&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> * Can contain convenience methods for comparing, printing, cloning, spawning<a name="line.56"></a>
<span class="sourceLineNo">057</span> * new arrays, copying to other arrays, etc. Please place non-core methods into<a name="line.57"></a>
<span class="sourceLineNo">058</span> * {@link ByteRangeUtils}.<a name="line.58"></a>
<span class="sourceLineNo">059</span> * &lt;/p&gt;<a name="line.59"></a>
<span class="sourceLineNo">060</span> */<a name="line.60"></a>
<span class="sourceLineNo">061</span>@InterfaceAudience.Public<a name="line.61"></a>
<span class="sourceLineNo">062</span>public interface ByteRange extends Comparable&lt;ByteRange&gt; {<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> /**<a name="line.64"></a>
<span class="sourceLineNo">065</span> * The underlying byte[].<a name="line.65"></a>
<span class="sourceLineNo">066</span> */<a name="line.66"></a>
<span class="sourceLineNo">067</span> public byte[] getBytes();<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> * Nullifies this ByteRange. That is, it becomes a husk, being a range over<a name="line.70"></a>
<span class="sourceLineNo">071</span> * no byte[] whatsoever.<a name="line.71"></a>
<span class="sourceLineNo">072</span> * @return this<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span> public ByteRange unset();<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> /**<a name="line.76"></a>
<span class="sourceLineNo">077</span> * Reuse this {@code ByteRange} over a new byte[]. {@code offset} is set to<a name="line.77"></a>
<span class="sourceLineNo">078</span> * 0 and {@code length} is set to {@code capacity}.<a name="line.78"></a>
<span class="sourceLineNo">079</span> * @param capacity the size of a new byte[].<a name="line.79"></a>
<span class="sourceLineNo">080</span> * @return this<a name="line.80"></a>
<span class="sourceLineNo">081</span> */<a name="line.81"></a>
<span class="sourceLineNo">082</span> public ByteRange set(int capacity);<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> /**<a name="line.84"></a>
<span class="sourceLineNo">085</span> * Reuse this {@code ByteRange} over a new byte[]. {@code offset} is set to<a name="line.85"></a>
<span class="sourceLineNo">086</span> * 0 and {@code length} is set to {@code bytes.length}. A null {@code bytes}<a name="line.86"></a>
<span class="sourceLineNo">087</span> * IS supported, in which case this method will behave equivalently to<a name="line.87"></a>
<span class="sourceLineNo">088</span> * {@link #unset()}.<a name="line.88"></a>
<span class="sourceLineNo">089</span> * @param bytes the array to wrap.<a name="line.89"></a>
<span class="sourceLineNo">090</span> * @return this<a name="line.90"></a>
<span class="sourceLineNo">091</span> */<a name="line.91"></a>
<span class="sourceLineNo">092</span> public ByteRange set(byte[] bytes);<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> /**<a name="line.94"></a>
<span class="sourceLineNo">095</span> * Reuse this {@code ByteRange} over a new byte[]. A null {@code bytes} IS<a name="line.95"></a>
<span class="sourceLineNo">096</span> * supported, in which case this method will behave equivalently to<a name="line.96"></a>
<span class="sourceLineNo">097</span> * {@link #unset()}, regardless of the values of {@code offset} and<a name="line.97"></a>
<span class="sourceLineNo">098</span> * {@code length}.<a name="line.98"></a>
<span class="sourceLineNo">099</span> * @param bytes The array to wrap.<a name="line.99"></a>
<span class="sourceLineNo">100</span> * @param offset The offset into {@code bytes} considered the beginning of<a name="line.100"></a>
<span class="sourceLineNo">101</span> * this range.<a name="line.101"></a>
<span class="sourceLineNo">102</span> * @param length The length of this range.<a name="line.102"></a>
<span class="sourceLineNo">103</span> * @return this.<a name="line.103"></a>
<span class="sourceLineNo">104</span> */<a name="line.104"></a>
<span class="sourceLineNo">105</span> public ByteRange set(byte[] bytes, int offset, int length);<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> /**<a name="line.107"></a>
<span class="sourceLineNo">108</span> * The offset, the index into the underlying byte[] at which this range<a name="line.108"></a>
<span class="sourceLineNo">109</span> * begins.<a name="line.109"></a>
<span class="sourceLineNo">110</span> * @see #getBytes()<a name="line.110"></a>
<span class="sourceLineNo">111</span> */<a name="line.111"></a>
<span class="sourceLineNo">112</span> public int getOffset();<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> * Update the beginning of this range. {@code offset + length} may not be<a name="line.115"></a>
<span class="sourceLineNo">116</span> * greater than {@code bytes.length}.<a name="line.116"></a>
<span class="sourceLineNo">117</span> * @param offset the new start of this range.<a name="line.117"></a>
<span class="sourceLineNo">118</span> * @return this.<a name="line.118"></a>
<span class="sourceLineNo">119</span> */<a name="line.119"></a>
<span class="sourceLineNo">120</span> public ByteRange setOffset(int offset);<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> /**<a name="line.122"></a>
<span class="sourceLineNo">123</span> * The length of the range.<a name="line.123"></a>
<span class="sourceLineNo">124</span> */<a name="line.124"></a>
<span class="sourceLineNo">125</span> public int getLength();<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> /**<a name="line.127"></a>
<span class="sourceLineNo">128</span> * Update the length of this range. {@code offset + length} should not be<a name="line.128"></a>
<span class="sourceLineNo">129</span> * greater than {@code bytes.length}.<a name="line.129"></a>
<span class="sourceLineNo">130</span> * @param length The new length of this range.<a name="line.130"></a>
<span class="sourceLineNo">131</span> * @return this.<a name="line.131"></a>
<span class="sourceLineNo">132</span> */<a name="line.132"></a>
<span class="sourceLineNo">133</span> public ByteRange setLength(int length);<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span> /**<a name="line.135"></a>
<span class="sourceLineNo">136</span> * @return true when this range is of zero length, false otherwise.<a name="line.136"></a>
<span class="sourceLineNo">137</span> */<a name="line.137"></a>
<span class="sourceLineNo">138</span> public boolean isEmpty();<a name="line.138"></a>
<span class="sourceLineNo">139</span><a name="line.139"></a>
<span class="sourceLineNo">140</span> /**<a name="line.140"></a>
<span class="sourceLineNo">141</span> * Retrieve the byte at {@code index}.<a name="line.141"></a>
<span class="sourceLineNo">142</span> * @param index zero-based index into this range.<a name="line.142"></a>
<span class="sourceLineNo">143</span> * @return single byte at index.<a name="line.143"></a>
<span class="sourceLineNo">144</span> */<a name="line.144"></a>
<span class="sourceLineNo">145</span> public byte get(int index);<a name="line.145"></a>
<span class="sourceLineNo">146</span><a name="line.146"></a>
<span class="sourceLineNo">147</span> /**<a name="line.147"></a>
<span class="sourceLineNo">148</span> * Retrieve the short value at {@code index}<a name="line.148"></a>
<span class="sourceLineNo">149</span> * @param index zero-based index into this range<a name="line.149"></a>
<span class="sourceLineNo">150</span> * @return the short value at {@code index}<a name="line.150"></a>
<span class="sourceLineNo">151</span> */<a name="line.151"></a>
<span class="sourceLineNo">152</span> public short getShort(int index);<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> /**<a name="line.154"></a>
<span class="sourceLineNo">155</span> * Retrieve the int value at {@code index}<a name="line.155"></a>
<span class="sourceLineNo">156</span> * @param index zero-based index into this range<a name="line.156"></a>
<span class="sourceLineNo">157</span> * @return the int value at {@code index}<a name="line.157"></a>
<span class="sourceLineNo">158</span> */<a name="line.158"></a>
<span class="sourceLineNo">159</span> public int getInt(int index);<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span> /**<a name="line.161"></a>
<span class="sourceLineNo">162</span> * Retrieve the long value at {@code index}<a name="line.162"></a>
<span class="sourceLineNo">163</span> * @param index zero-based index into this range<a name="line.163"></a>
<span class="sourceLineNo">164</span> * @return the long value at {@code index}<a name="line.164"></a>
<span class="sourceLineNo">165</span> */<a name="line.165"></a>
<span class="sourceLineNo">166</span> public long getLong(int index);<a name="line.166"></a>
<span class="sourceLineNo">167</span><a name="line.167"></a>
<span class="sourceLineNo">168</span> /**<a name="line.168"></a>
<span class="sourceLineNo">169</span> * Retrieve the long value at {@code index} which is stored as VLong<a name="line.169"></a>
<span class="sourceLineNo">170</span> * @param index zero-based index into this range<a name="line.170"></a>
<span class="sourceLineNo">171</span> * @return the long value at {@code index} which is stored as VLong<a name="line.171"></a>
<span class="sourceLineNo">172</span> */<a name="line.172"></a>
<span class="sourceLineNo">173</span> public long getVLong(int index);<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span> /**<a name="line.175"></a>
<span class="sourceLineNo">176</span> * Fill {@code dst} with bytes from the range, starting from {@code index}.<a name="line.176"></a>
<span class="sourceLineNo">177</span> * @param index zero-based index into this range.<a name="line.177"></a>
<span class="sourceLineNo">178</span> * @param dst the destination of the copy.<a name="line.178"></a>
<span class="sourceLineNo">179</span> * @return this.<a name="line.179"></a>
<span class="sourceLineNo">180</span> */<a name="line.180"></a>
<span class="sourceLineNo">181</span> public ByteRange get(int index, byte[] dst);<a name="line.181"></a>
<span class="sourceLineNo">182</span><a name="line.182"></a>
<span class="sourceLineNo">183</span> /**<a name="line.183"></a>
<span class="sourceLineNo">184</span> * Fill {@code dst} with bytes from the range, starting from {@code index}.<a name="line.184"></a>
<span class="sourceLineNo">185</span> * {@code length} bytes are copied into {@code dst}, starting at {@code offset}.<a name="line.185"></a>
<span class="sourceLineNo">186</span> * @param index zero-based index into this range.<a name="line.186"></a>
<span class="sourceLineNo">187</span> * @param dst the destination of the copy.<a name="line.187"></a>
<span class="sourceLineNo">188</span> * @param offset the offset into {@code dst} to start the copy.<a name="line.188"></a>
<span class="sourceLineNo">189</span> * @param length the number of bytes to copy into {@code dst}.<a name="line.189"></a>
<span class="sourceLineNo">190</span> * @return this.<a name="line.190"></a>
<span class="sourceLineNo">191</span> */<a name="line.191"></a>
<span class="sourceLineNo">192</span> public ByteRange get(int index, byte[] dst, int offset, int length);<a name="line.192"></a>
<span class="sourceLineNo">193</span><a name="line.193"></a>
<span class="sourceLineNo">194</span> /**<a name="line.194"></a>
<span class="sourceLineNo">195</span> * Store {@code val} at {@code index}.<a name="line.195"></a>
<span class="sourceLineNo">196</span> * @param index the index in the range where {@code val} is stored.<a name="line.196"></a>
<span class="sourceLineNo">197</span> * @param val the value to store.<a name="line.197"></a>
<span class="sourceLineNo">198</span> * @return this.<a name="line.198"></a>
<span class="sourceLineNo">199</span> */<a name="line.199"></a>
<span class="sourceLineNo">200</span> public ByteRange put(int index, byte val);<a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span> /**<a name="line.202"></a>
<span class="sourceLineNo">203</span> * Store the short value at {@code index}<a name="line.203"></a>
<span class="sourceLineNo">204</span> * @param index the index in the range where {@code val} is stored<a name="line.204"></a>
<span class="sourceLineNo">205</span> * @param val the value to store<a name="line.205"></a>
<span class="sourceLineNo">206</span> * @return this<a name="line.206"></a>
<span class="sourceLineNo">207</span> */<a name="line.207"></a>
<span class="sourceLineNo">208</span> public ByteRange putShort(int index, short val);<a name="line.208"></a>
<span class="sourceLineNo">209</span><a name="line.209"></a>
<span class="sourceLineNo">210</span> /**<a name="line.210"></a>
<span class="sourceLineNo">211</span> * Store the int value at {@code index}<a name="line.211"></a>
<span class="sourceLineNo">212</span> * @param index the index in the range where {@code val} is stored<a name="line.212"></a>
<span class="sourceLineNo">213</span> * @param val the value to store<a name="line.213"></a>
<span class="sourceLineNo">214</span> * @return this<a name="line.214"></a>
<span class="sourceLineNo">215</span> */<a name="line.215"></a>
<span class="sourceLineNo">216</span> public ByteRange putInt(int index, int val);<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span> /**<a name="line.218"></a>
<span class="sourceLineNo">219</span> * Store the long value at {@code index}<a name="line.219"></a>
<span class="sourceLineNo">220</span> * @param index the index in the range where {@code val} is stored<a name="line.220"></a>
<span class="sourceLineNo">221</span> * @param val the value to store<a name="line.221"></a>
<span class="sourceLineNo">222</span> * @return this<a name="line.222"></a>
<span class="sourceLineNo">223</span> */<a name="line.223"></a>
<span class="sourceLineNo">224</span> public ByteRange putLong(int index, long val);<a name="line.224"></a>
<span class="sourceLineNo">225</span><a name="line.225"></a>
<span class="sourceLineNo">226</span> /**<a name="line.226"></a>
<span class="sourceLineNo">227</span> * Store the long value at {@code index} as a VLong<a name="line.227"></a>
<span class="sourceLineNo">228</span> * @param index the index in the range where {@code val} is stored<a name="line.228"></a>
<span class="sourceLineNo">229</span> * @param val the value to store<a name="line.229"></a>
<span class="sourceLineNo">230</span> * @return number of bytes written<a name="line.230"></a>
<span class="sourceLineNo">231</span> */<a name="line.231"></a>
<span class="sourceLineNo">232</span> public int putVLong(int index, long val);<a name="line.232"></a>
<span class="sourceLineNo">233</span><a name="line.233"></a>
<span class="sourceLineNo">234</span> /**<a name="line.234"></a>
<span class="sourceLineNo">235</span> * Store {@code val} at {@code index}.<a name="line.235"></a>
<span class="sourceLineNo">236</span> * @param index the index in the range where {@code val} is stored.<a name="line.236"></a>
<span class="sourceLineNo">237</span> * @param val the value to store.<a name="line.237"></a>
<span class="sourceLineNo">238</span> * @return this.<a name="line.238"></a>
<span class="sourceLineNo">239</span> */<a name="line.239"></a>
<span class="sourceLineNo">240</span> public ByteRange put(int index, byte[] val);<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> * Store {@code length} bytes from {@code val} into this range, starting at<a name="line.243"></a>
<span class="sourceLineNo">244</span> * {@code index}. Bytes from {@code val} are copied starting at {@code offset}<a name="line.244"></a>
<span class="sourceLineNo">245</span> * into the range.<a name="line.245"></a>
<span class="sourceLineNo">246</span> * @param index position in this range to start the copy.<a name="line.246"></a>
<span class="sourceLineNo">247</span> * @param val the value to store.<a name="line.247"></a>
<span class="sourceLineNo">248</span> * @param offset the offset in {@code val} from which to start copying.<a name="line.248"></a>
<span class="sourceLineNo">249</span> * @param length the number of bytes to copy from {@code val}.<a name="line.249"></a>
<span class="sourceLineNo">250</span> * @return this.<a name="line.250"></a>
<span class="sourceLineNo">251</span> */<a name="line.251"></a>
<span class="sourceLineNo">252</span> public ByteRange put(int index, byte[] val, int offset, int length);<a name="line.252"></a>
<span class="sourceLineNo">253</span><a name="line.253"></a>
<span class="sourceLineNo">254</span> /**<a name="line.254"></a>
<span class="sourceLineNo">255</span> * Instantiate a new byte[] with exact length, which is at least 24 bytes +<a name="line.255"></a>
<span class="sourceLineNo">256</span> * length. Copy the contents of this range into it.<a name="line.256"></a>
<span class="sourceLineNo">257</span> * @return The newly cloned byte[].<a name="line.257"></a>
<span class="sourceLineNo">258</span> */<a name="line.258"></a>
<span class="sourceLineNo">259</span> public byte[] deepCopyToNewArray();<a name="line.259"></a>
<span class="sourceLineNo">260</span><a name="line.260"></a>
<span class="sourceLineNo">261</span> /**<a name="line.261"></a>
<span class="sourceLineNo">262</span> * Create a new {@code ByteRange} with new backing byte[] containing a copy<a name="line.262"></a>
<span class="sourceLineNo">263</span> * of the content from {@code this} range's window.<a name="line.263"></a>
<span class="sourceLineNo">264</span> * @return Deep copy<a name="line.264"></a>
<span class="sourceLineNo">265</span> */<a name="line.265"></a>
<span class="sourceLineNo">266</span> public ByteRange deepCopy();<a name="line.266"></a>
<span class="sourceLineNo">267</span><a name="line.267"></a>
<span class="sourceLineNo">268</span> /**<a name="line.268"></a>
<span class="sourceLineNo">269</span> * Wrapper for System.arraycopy. Copy the contents of this range into the<a name="line.269"></a>
<span class="sourceLineNo">270</span> * provided array.<a name="line.270"></a>
<span class="sourceLineNo">271</span> * @param destination Copy to this array<a name="line.271"></a>
<span class="sourceLineNo">272</span> * @param destinationOffset First index in the destination array.<a name="line.272"></a>
<span class="sourceLineNo">273</span> */<a name="line.273"></a>
<span class="sourceLineNo">274</span> public void deepCopyTo(byte[] destination, int destinationOffset);<a name="line.274"></a>
<span class="sourceLineNo">275</span><a name="line.275"></a>
<span class="sourceLineNo">276</span> /**<a name="line.276"></a>
<span class="sourceLineNo">277</span> * Wrapper for System.arraycopy. Copy the contents of this range into the<a name="line.277"></a>
<span class="sourceLineNo">278</span> * provided array.<a name="line.278"></a>
<span class="sourceLineNo">279</span> * @param innerOffset Start copying from this index in this source<a name="line.279"></a>
<span class="sourceLineNo">280</span> * ByteRange. First byte copied is bytes[offset + innerOffset]<a name="line.280"></a>
<span class="sourceLineNo">281</span> * @param copyLength Copy this many bytes<a name="line.281"></a>
<span class="sourceLineNo">282</span> * @param destination Copy to this array<a name="line.282"></a>
<span class="sourceLineNo">283</span> * @param destinationOffset First index in the destination array.<a name="line.283"></a>
<span class="sourceLineNo">284</span> */<a name="line.284"></a>
<span class="sourceLineNo">285</span> public void deepCopySubRangeTo(int innerOffset, int copyLength, byte[] destination,<a name="line.285"></a>
<span class="sourceLineNo">286</span> int destinationOffset);<a name="line.286"></a>
<span class="sourceLineNo">287</span><a name="line.287"></a>
<span class="sourceLineNo">288</span> /**<a name="line.288"></a>
<span class="sourceLineNo">289</span> * Create a new {@code ByteRange} that points at this range's byte[].<a name="line.289"></a>
<span class="sourceLineNo">290</span> * Modifying the shallowCopy will modify the bytes in this range's array.<a name="line.290"></a>
<span class="sourceLineNo">291</span> * Pass over the hash code if it is already cached.<a name="line.291"></a>
<span class="sourceLineNo">292</span> * @return new {@code ByteRange} object referencing this range's byte[].<a name="line.292"></a>
<span class="sourceLineNo">293</span> */<a name="line.293"></a>
<span class="sourceLineNo">294</span> public ByteRange shallowCopy();<a name="line.294"></a>
<span class="sourceLineNo">295</span><a name="line.295"></a>
<span class="sourceLineNo">296</span> /**<a name="line.296"></a>
<span class="sourceLineNo">297</span> * Create a new {@code ByteRange} that points at this range's byte[]. The new<a name="line.297"></a>
<span class="sourceLineNo">298</span> * range can have different values for offset and length, but modifying the<a name="line.298"></a>
<span class="sourceLineNo">299</span> * shallowCopy will modify the bytes in this range's array. Pass over the<a name="line.299"></a>
<span class="sourceLineNo">300</span> * hash code if it is already cached.<a name="line.300"></a>
<span class="sourceLineNo">301</span> * @param innerOffset First byte of clone will be this.offset + copyOffset.<a name="line.301"></a>
<span class="sourceLineNo">302</span> * @param copyLength Number of bytes in the clone.<a name="line.302"></a>
<span class="sourceLineNo">303</span> * @return new {@code ByteRange} object referencing this range's byte[].<a name="line.303"></a>
<span class="sourceLineNo">304</span> */<a name="line.304"></a>
<span class="sourceLineNo">305</span> public ByteRange shallowCopySubRange(int innerOffset, int copyLength);<a name="line.305"></a>
<span class="sourceLineNo">306</span><a name="line.306"></a>
<span class="sourceLineNo">307</span>}<a name="line.307"></a>
</pre>
</div>
</body>
</html>