Google Git
Sign in
apache / hbase-site / 6be7f1c569b0f0f64151e4687d98bbf050cb369a / . / devapidocs / src-html / org / apache / hadoop / hbase / util / AbstractPositionedByteRange.html
blob: 9ed8148a583eaa0b01df35ecf09617ce0404ed5a [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>package org.apache.hadoop.hbase.util;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.yetus.audience.InterfaceStability;<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> * Extends the basic {@link SimpleByteRange} implementation with position support. {@code position}<a name="line.24"></a>
<span class="sourceLineNo">025</span> * is considered transient, not fundamental to the definition of the range, and does not participate<a name="line.25"></a>
<span class="sourceLineNo">026</span> * in {@link #compareTo(ByteRange)}, {@link #hashCode()}, or {@link #equals(Object)}.<a name="line.26"></a>
<span class="sourceLineNo">027</span> * {@code Position} is retained by copy operations.<a name="line.27"></a>
<span class="sourceLineNo">028</span> */<a name="line.28"></a>
<span class="sourceLineNo">029</span>@InterfaceAudience.Private<a name="line.29"></a>
<span class="sourceLineNo">030</span>@InterfaceStability.Evolving<a name="line.30"></a>
<span class="sourceLineNo">031</span>public abstract class AbstractPositionedByteRange extends AbstractByteRange<a name="line.31"></a>
<span class="sourceLineNo">032</span> implements PositionedByteRange {<a name="line.32"></a>
<span class="sourceLineNo">033</span> /**<a name="line.33"></a>
<span class="sourceLineNo">034</span> * The current index into the range. Like {@link java.nio.ByteBuffer} position, it points to the<a name="line.34"></a>
<span class="sourceLineNo">035</span> * next value that will be read/written in the array. It provides the appearance of being<a name="line.35"></a>
<span class="sourceLineNo">036</span> * 0-indexed, even though its value is calculated according to offset.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;p&gt;<a name="line.37"></a>
<span class="sourceLineNo">038</span> * Position is considered transient and does not participate in {@link #equals(Object)} or<a name="line.38"></a>
<span class="sourceLineNo">039</span> * {@link #hashCode()} comparisons.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;/p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span> protected int position = 0;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> protected int limit = 0;<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> @Override<a name="line.46"></a>
<span class="sourceLineNo">047</span> public PositionedByteRange set(int capacity) {<a name="line.47"></a>
<span class="sourceLineNo">048</span> this.position = 0;<a name="line.48"></a>
<span class="sourceLineNo">049</span> super.set(capacity);<a name="line.49"></a>
<span class="sourceLineNo">050</span> this.limit = capacity;<a name="line.50"></a>
<span class="sourceLineNo">051</span> return this;<a name="line.51"></a>
<span class="sourceLineNo">052</span> }<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> @Override<a name="line.54"></a>
<span class="sourceLineNo">055</span> public PositionedByteRange set(byte[] bytes) {<a name="line.55"></a>
<span class="sourceLineNo">056</span> this.position = 0;<a name="line.56"></a>
<span class="sourceLineNo">057</span> super.set(bytes);<a name="line.57"></a>
<span class="sourceLineNo">058</span> this.limit = bytes.length;<a name="line.58"></a>
<span class="sourceLineNo">059</span> return this;<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> @Override<a name="line.62"></a>
<span class="sourceLineNo">063</span> public PositionedByteRange set(byte[] bytes, int offset, int length) {<a name="line.63"></a>
<span class="sourceLineNo">064</span> this.position = 0;<a name="line.64"></a>
<span class="sourceLineNo">065</span> super.set(bytes, offset, length);<a name="line.65"></a>
<span class="sourceLineNo">066</span> limit = length;<a name="line.66"></a>
<span class="sourceLineNo">067</span> return this;<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> /**<a name="line.70"></a>
<span class="sourceLineNo">071</span> * Update the beginning of this range. {@code offset + length} may not be greater than<a name="line.71"></a>
<span class="sourceLineNo">072</span> * {@code bytes.length}. Resets {@code position} to 0. the new start of this range.<a name="line.72"></a>
<span class="sourceLineNo">073</span> * @return this.<a name="line.73"></a>
<span class="sourceLineNo">074</span> */<a name="line.74"></a>
<span class="sourceLineNo">075</span> @Override<a name="line.75"></a>
<span class="sourceLineNo">076</span> public PositionedByteRange setOffset(int offset) {<a name="line.76"></a>
<span class="sourceLineNo">077</span> this.position = 0;<a name="line.77"></a>
<span class="sourceLineNo">078</span> super.setOffset(offset);<a name="line.78"></a>
<span class="sourceLineNo">079</span> return this;<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> /**<a name="line.82"></a>
<span class="sourceLineNo">083</span> * Update the length of this range. {@code offset + length} should not be greater than<a name="line.83"></a>
<span class="sourceLineNo">084</span> * {@code bytes.length}. If {@code position} is greater than the new {@code length}, sets<a name="line.84"></a>
<span class="sourceLineNo">085</span> * {@code position} to {@code length}. The new length of this range.<a name="line.85"></a>
<span class="sourceLineNo">086</span> * @return this.<a name="line.86"></a>
<span class="sourceLineNo">087</span> */<a name="line.87"></a>
<span class="sourceLineNo">088</span> @Override<a name="line.88"></a>
<span class="sourceLineNo">089</span> public PositionedByteRange setLength(int length) {<a name="line.89"></a>
<span class="sourceLineNo">090</span> this.position = Math.min(position, length);<a name="line.90"></a>
<span class="sourceLineNo">091</span> super.setLength(length);<a name="line.91"></a>
<span class="sourceLineNo">092</span> return this;<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> @Override<a name="line.95"></a>
<span class="sourceLineNo">096</span> public int getPosition() {<a name="line.96"></a>
<span class="sourceLineNo">097</span> return position;<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> @Override<a name="line.100"></a>
<span class="sourceLineNo">101</span> public PositionedByteRange setPosition(int position) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> this.position = position;<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><a name="line.105"></a>
<span class="sourceLineNo">106</span> @Override<a name="line.106"></a>
<span class="sourceLineNo">107</span> public int getRemaining() {<a name="line.107"></a>
<span class="sourceLineNo">108</span> return length - position;<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span><a name="line.110"></a>
<span class="sourceLineNo">111</span> @Override<a name="line.111"></a>
<span class="sourceLineNo">112</span> public byte peek() {<a name="line.112"></a>
<span class="sourceLineNo">113</span> return bytes[offset + position];<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> @Override<a name="line.116"></a>
<span class="sourceLineNo">117</span> public byte get() {<a name="line.117"></a>
<span class="sourceLineNo">118</span> return get(position++);<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> @Override<a name="line.121"></a>
<span class="sourceLineNo">122</span> public PositionedByteRange get(byte[] dst) {<a name="line.122"></a>
<span class="sourceLineNo">123</span> if (0 == dst.length) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> return this;<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span><a name="line.126"></a>
<span class="sourceLineNo">127</span> return this.get(dst, 0, dst.length); // be clear we're calling self, not super<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span> @Override<a name="line.130"></a>
<span class="sourceLineNo">131</span> public PositionedByteRange get(byte[] dst, int offset, int length) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> if (0 == length) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> return this;<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> super.get(this.position, dst, offset, length);<a name="line.136"></a>
<span class="sourceLineNo">137</span> this.position += length;<a name="line.137"></a>
<span class="sourceLineNo">138</span> return this;<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> // java boilerplate<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> @Override<a name="line.143"></a>
<span class="sourceLineNo">144</span> public PositionedByteRange get(int index, byte[] dst) {<a name="line.144"></a>
<span class="sourceLineNo">145</span> super.get(index, dst);<a name="line.145"></a>
<span class="sourceLineNo">146</span> return this;<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> @Override<a name="line.149"></a>
<span class="sourceLineNo">150</span> public PositionedByteRange get(int index, byte[] dst, int offset, int length) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> super.get(index, dst, offset, length);<a name="line.151"></a>
<span class="sourceLineNo">152</span> return this;<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> @Override<a name="line.155"></a>
<span class="sourceLineNo">156</span> public short getShort() {<a name="line.156"></a>
<span class="sourceLineNo">157</span> short s = getShort(position);<a name="line.157"></a>
<span class="sourceLineNo">158</span> position += Bytes.SIZEOF_SHORT;<a name="line.158"></a>
<span class="sourceLineNo">159</span> return s;<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> @Override<a name="line.162"></a>
<span class="sourceLineNo">163</span> public int getInt() {<a name="line.163"></a>
<span class="sourceLineNo">164</span> int i = getInt(position);<a name="line.164"></a>
<span class="sourceLineNo">165</span> position += Bytes.SIZEOF_INT;<a name="line.165"></a>
<span class="sourceLineNo">166</span> return i;<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> @Override<a name="line.169"></a>
<span class="sourceLineNo">170</span> public long getLong() {<a name="line.170"></a>
<span class="sourceLineNo">171</span> long l = getLong(position);<a name="line.171"></a>
<span class="sourceLineNo">172</span> position += Bytes.SIZEOF_LONG;<a name="line.172"></a>
<span class="sourceLineNo">173</span> return l;<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> @Override<a name="line.176"></a>
<span class="sourceLineNo">177</span> public long getVLong() {<a name="line.177"></a>
<span class="sourceLineNo">178</span> long p = getVLong(position);<a name="line.178"></a>
<span class="sourceLineNo">179</span> position += getVLongSize(p);<a name="line.179"></a>
<span class="sourceLineNo">180</span> return p;<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span><a name="line.182"></a>
<span class="sourceLineNo">183</span> @Override<a name="line.183"></a>
<span class="sourceLineNo">184</span> public PositionedByteRange setLimit(int limit) {<a name="line.184"></a>
<span class="sourceLineNo">185</span> this.limit = limit;<a name="line.185"></a>
<span class="sourceLineNo">186</span> return this;<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<a name="line.187"></a>
<span class="sourceLineNo">188</span><a name="line.188"></a>
<span class="sourceLineNo">189</span> @Override<a name="line.189"></a>
<span class="sourceLineNo">190</span> public int getLimit() {<a name="line.190"></a>
<span class="sourceLineNo">191</span> return this.limit;<a name="line.191"></a>
<span class="sourceLineNo">192</span> }<a name="line.192"></a>
<span class="sourceLineNo">193</span>}<a name="line.193"></a>
</pre>
</div>
</body>
</html>