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