Google Git
Sign in
apache / hbase-site / 8ac68d4b7a8449d1b079203ac526389e2358d31e / . / devapidocs / src-html / org / apache / hadoop / hbase / util / PositionedByteRange.html
blob: 4775e0eee0a52fa90cfbb391b8a74234d74068d8 [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><a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>/**<a name="line.24"></a>
<span class="sourceLineNo">025</span> * &lt;p&gt;<a name="line.25"></a>
<span class="sourceLineNo">026</span> * Extends {@link ByteRange} with additional methods to support tracking a<a name="line.26"></a>
<span class="sourceLineNo">027</span> * consumers position within the viewport. The API is extended with methods<a name="line.27"></a>
<span class="sourceLineNo">028</span> * {@link #get()} and {@link #put(byte)} for interacting with the backing<a name="line.28"></a>
<span class="sourceLineNo">029</span> * array from the current position forward. This frees the caller from managing<a name="line.29"></a>
<span class="sourceLineNo">030</span> * their own index into the array.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;/p&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> * &lt;p&gt;<a name="line.32"></a>
<span class="sourceLineNo">033</span> * Designed to be a slimmed-down, mutable alternative to {@link java.nio.ByteBuffer}.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;/p&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> */<a name="line.35"></a>
<span class="sourceLineNo">036</span>@InterfaceAudience.Public<a name="line.36"></a>
<span class="sourceLineNo">037</span>public interface PositionedByteRange extends ByteRange {<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span> // net new API is here.<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span> /**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * The current {@code position} marker. This valuae is 0-indexed, relative to<a name="line.42"></a>
<span class="sourceLineNo">043</span> * the beginning of the range.<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span> public int getPosition();<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Update the {@code position} index. May not be greater than {@code length}.<a name="line.48"></a>
<span class="sourceLineNo">049</span> * @param position the new position in this range.<a name="line.49"></a>
<span class="sourceLineNo">050</span> * @return this.<a name="line.50"></a>
<span class="sourceLineNo">051</span> */<a name="line.51"></a>
<span class="sourceLineNo">052</span> public PositionedByteRange setPosition(int position);<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> /**<a name="line.54"></a>
<span class="sourceLineNo">055</span> * The number of bytes remaining between position and the end of the range.<a name="line.55"></a>
<span class="sourceLineNo">056</span> */<a name="line.56"></a>
<span class="sourceLineNo">057</span> public int getRemaining();<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> /**<a name="line.59"></a>
<span class="sourceLineNo">060</span> * Retrieve the next byte from this range without incrementing position.<a name="line.60"></a>
<span class="sourceLineNo">061</span> */<a name="line.61"></a>
<span class="sourceLineNo">062</span> public byte peek();<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> * Retrieve the next byte from this range.<a name="line.65"></a>
<span class="sourceLineNo">066</span> */<a name="line.66"></a>
<span class="sourceLineNo">067</span> public byte get();<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> * Retrieve the next short value from this range.<a name="line.70"></a>
<span class="sourceLineNo">071</span> */<a name="line.71"></a>
<span class="sourceLineNo">072</span> public short getShort();<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> /**<a name="line.74"></a>
<span class="sourceLineNo">075</span> * Retrieve the next int value from this range.<a name="line.75"></a>
<span class="sourceLineNo">076</span> */<a name="line.76"></a>
<span class="sourceLineNo">077</span> public int getInt();<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> /**<a name="line.79"></a>
<span class="sourceLineNo">080</span> * Retrieve the next long value from this range.<a name="line.80"></a>
<span class="sourceLineNo">081</span> */<a name="line.81"></a>
<span class="sourceLineNo">082</span> public long getLong();<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> * Retrieve the next long value, which is stored as VLong, from this range<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @return the long value which is stored as VLong<a name="line.86"></a>
<span class="sourceLineNo">087</span> */<a name="line.87"></a>
<span class="sourceLineNo">088</span> public long getVLong();<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> * Fill {@code dst} with bytes from the range, starting from {@code position}.<a name="line.91"></a>
<span class="sourceLineNo">092</span> * This range's {@code position} is incremented by the length of {@code dst},<a name="line.92"></a>
<span class="sourceLineNo">093</span> * the number of bytes copied.<a name="line.93"></a>
<span class="sourceLineNo">094</span> * @param dst the destination of the copy.<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @return this.<a name="line.95"></a>
<span class="sourceLineNo">096</span> */<a name="line.96"></a>
<span class="sourceLineNo">097</span> public PositionedByteRange get(byte[] dst);<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span> /**<a name="line.99"></a>
<span class="sourceLineNo">100</span> * Fill {@code dst} with bytes from the range, starting from the current<a name="line.100"></a>
<span class="sourceLineNo">101</span> * {@code position}. {@code length} bytes are copied into {@code dst},<a name="line.101"></a>
<span class="sourceLineNo">102</span> * starting at {@code offset}. This range's {@code position} is incremented<a name="line.102"></a>
<span class="sourceLineNo">103</span> * by the number of bytes copied.<a name="line.103"></a>
<span class="sourceLineNo">104</span> * @param dst the destination of the copy.<a name="line.104"></a>
<span class="sourceLineNo">105</span> * @param offset the offset into {@code dst} to start the copy.<a name="line.105"></a>
<span class="sourceLineNo">106</span> * @param length the number of bytes to copy into {@code dst}.<a name="line.106"></a>
<span class="sourceLineNo">107</span> * @return this.<a name="line.107"></a>
<span class="sourceLineNo">108</span> */<a name="line.108"></a>
<span class="sourceLineNo">109</span> public PositionedByteRange get(byte[] dst, int offset, int length);<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> /**<a name="line.111"></a>
<span class="sourceLineNo">112</span> * Store {@code val} at the next position in this range.<a name="line.112"></a>
<span class="sourceLineNo">113</span> * @param val the new value.<a name="line.113"></a>
<span class="sourceLineNo">114</span> * @return this.<a name="line.114"></a>
<span class="sourceLineNo">115</span> */<a name="line.115"></a>
<span class="sourceLineNo">116</span> public PositionedByteRange put(byte val);<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> /**<a name="line.118"></a>
<span class="sourceLineNo">119</span> * Store short {@code val} at the next position in this range.<a name="line.119"></a>
<span class="sourceLineNo">120</span> * @param val the new value.<a name="line.120"></a>
<span class="sourceLineNo">121</span> * @return this.<a name="line.121"></a>
<span class="sourceLineNo">122</span> */<a name="line.122"></a>
<span class="sourceLineNo">123</span> public PositionedByteRange putShort(short val);<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> /**<a name="line.125"></a>
<span class="sourceLineNo">126</span> * Store int {@code val} at the next position in this range.<a name="line.126"></a>
<span class="sourceLineNo">127</span> * @param val the new value.<a name="line.127"></a>
<span class="sourceLineNo">128</span> * @return this.<a name="line.128"></a>
<span class="sourceLineNo">129</span> */<a name="line.129"></a>
<span class="sourceLineNo">130</span> public PositionedByteRange putInt(int val);<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> /**<a name="line.132"></a>
<span class="sourceLineNo">133</span> * Store long {@code val} at the next position in this range.<a name="line.133"></a>
<span class="sourceLineNo">134</span> * @param val the new value.<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> public PositionedByteRange putLong(long val);<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> /**<a name="line.139"></a>
<span class="sourceLineNo">140</span> * Store the long {@code val} at the next position as a VLong<a name="line.140"></a>
<span class="sourceLineNo">141</span> * @param val the value to store<a name="line.141"></a>
<span class="sourceLineNo">142</span> * @return number of bytes written<a name="line.142"></a>
<span class="sourceLineNo">143</span> */<a name="line.143"></a>
<span class="sourceLineNo">144</span> public int putVLong(long val);<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> /**<a name="line.146"></a>
<span class="sourceLineNo">147</span> * Store the content of {@code val} in this range, starting at the next position.<a name="line.147"></a>
<span class="sourceLineNo">148</span> * @param val the new value.<a name="line.148"></a>
<span class="sourceLineNo">149</span> * @return this.<a name="line.149"></a>
<span class="sourceLineNo">150</span> */<a name="line.150"></a>
<span class="sourceLineNo">151</span> public PositionedByteRange put(byte[] val);<a name="line.151"></a>
<span class="sourceLineNo">152</span><a name="line.152"></a>
<span class="sourceLineNo">153</span> /**<a name="line.153"></a>
<span class="sourceLineNo">154</span> * Store {@code length} bytes from {@code val} into this range. Bytes from<a name="line.154"></a>
<span class="sourceLineNo">155</span> * {@code val} are copied starting at {@code offset} into the range, starting at<a name="line.155"></a>
<span class="sourceLineNo">156</span> * the current position.<a name="line.156"></a>
<span class="sourceLineNo">157</span> * @param val the new value.<a name="line.157"></a>
<span class="sourceLineNo">158</span> * @param offset the offset in {@code val} from which to start copying.<a name="line.158"></a>
<span class="sourceLineNo">159</span> * @param length the number of bytes to copy from {@code val}.<a name="line.159"></a>
<span class="sourceLineNo">160</span> * @return this.<a name="line.160"></a>
<span class="sourceLineNo">161</span> */<a name="line.161"></a>
<span class="sourceLineNo">162</span> public PositionedByteRange put(byte[] val, int offset, int length);<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> /**<a name="line.164"></a>
<span class="sourceLineNo">165</span> * Limits the byte range upto a specified value. Limit cannot be greater than<a name="line.165"></a>
<span class="sourceLineNo">166</span> * capacity<a name="line.166"></a>
<span class="sourceLineNo">167</span> *<a name="line.167"></a>
<span class="sourceLineNo">168</span> * @param limit<a name="line.168"></a>
<span class="sourceLineNo">169</span> * @return PositionedByteRange<a name="line.169"></a>
<span class="sourceLineNo">170</span> */<a name="line.170"></a>
<span class="sourceLineNo">171</span> public PositionedByteRange setLimit(int limit);<a name="line.171"></a>
<span class="sourceLineNo">172</span><a name="line.172"></a>
<span class="sourceLineNo">173</span> /**<a name="line.173"></a>
<span class="sourceLineNo">174</span> * Return the current limit<a name="line.174"></a>
<span class="sourceLineNo">175</span> *<a name="line.175"></a>
<span class="sourceLineNo">176</span> * @return limit<a name="line.176"></a>
<span class="sourceLineNo">177</span> */<a name="line.177"></a>
<span class="sourceLineNo">178</span> public int getLimit();<a name="line.178"></a>
<span class="sourceLineNo">179</span><a name="line.179"></a>
<span class="sourceLineNo">180</span> // override parent interface declarations to return this interface.<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span> @Override<a name="line.182"></a>
<span class="sourceLineNo">183</span> public PositionedByteRange unset();<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span> @Override<a name="line.185"></a>
<span class="sourceLineNo">186</span> public PositionedByteRange set(int capacity);<a name="line.186"></a>
<span class="sourceLineNo">187</span><a name="line.187"></a>
<span class="sourceLineNo">188</span> @Override<a name="line.188"></a>
<span class="sourceLineNo">189</span> public PositionedByteRange set(byte[] bytes);<a name="line.189"></a>
<span class="sourceLineNo">190</span><a name="line.190"></a>
<span class="sourceLineNo">191</span> @Override<a name="line.191"></a>
<span class="sourceLineNo">192</span> public PositionedByteRange set(byte[] bytes, int offset, int length);<a name="line.192"></a>
<span class="sourceLineNo">193</span><a name="line.193"></a>
<span class="sourceLineNo">194</span> @Override<a name="line.194"></a>
<span class="sourceLineNo">195</span> public PositionedByteRange setOffset(int offset);<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 PositionedByteRange setLength(int length);<a name="line.198"></a>
<span class="sourceLineNo">199</span><a name="line.199"></a>
<span class="sourceLineNo">200</span> @Override<a name="line.200"></a>
<span class="sourceLineNo">201</span> public PositionedByteRange get(int index, byte[] dst);<a name="line.201"></a>
<span class="sourceLineNo">202</span><a name="line.202"></a>
<span class="sourceLineNo">203</span> @Override<a name="line.203"></a>
<span class="sourceLineNo">204</span> public PositionedByteRange get(int index, byte[] dst, int offset, int length);<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 PositionedByteRange put(int index, byte val);<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span> @Override<a name="line.209"></a>
<span class="sourceLineNo">210</span> public PositionedByteRange putShort(int index, short val);<a name="line.210"></a>
<span class="sourceLineNo">211</span><a name="line.211"></a>
<span class="sourceLineNo">212</span> @Override<a name="line.212"></a>
<span class="sourceLineNo">213</span> public PositionedByteRange putInt(int index, int val);<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 PositionedByteRange putLong(int index, long val);<a name="line.216"></a>
<span class="sourceLineNo">217</span><a name="line.217"></a>
<span class="sourceLineNo">218</span> @Override<a name="line.218"></a>
<span class="sourceLineNo">219</span> public PositionedByteRange put(int index, byte[] val);<a name="line.219"></a>
<span class="sourceLineNo">220</span><a name="line.220"></a>
<span class="sourceLineNo">221</span> @Override<a name="line.221"></a>
<span class="sourceLineNo">222</span> public PositionedByteRange put(int index, byte[] val, int offset, int length);<a name="line.222"></a>
<span class="sourceLineNo">223</span><a name="line.223"></a>
<span class="sourceLineNo">224</span> @Override<a name="line.224"></a>
<span class="sourceLineNo">225</span> public PositionedByteRange deepCopy();<a name="line.225"></a>
<span class="sourceLineNo">226</span><a name="line.226"></a>
<span class="sourceLineNo">227</span> @Override<a name="line.227"></a>
<span class="sourceLineNo">228</span> public PositionedByteRange shallowCopy();<a name="line.228"></a>
<span class="sourceLineNo">229</span><a name="line.229"></a>
<span class="sourceLineNo">230</span> @Override<a name="line.230"></a>
<span class="sourceLineNo">231</span> public PositionedByteRange shallowCopySubRange(int innerOffset, int copyLength);<a name="line.231"></a>
<span class="sourceLineNo">232</span>}<a name="line.232"></a>
</pre>
</div>
</body>
</html>