blob: 643c3be3693c696a7fba4f5c7206f4c5eab7b7a4 [file] [log] [blame]
<!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.io, class: ByteBufferInputStream">
<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.io;</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 java.io.InputStream;</span>
<span class="source-line-no">021</span><span id="line-21">import java.nio.ByteBuffer;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.util.ByteBufferUtils;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">024</span><span id="line-24"></span>
<span class="source-line-no">025</span><span id="line-25">/**</span>
<span class="source-line-no">026</span><span id="line-26"> * Not thread safe!</span>
<span class="source-line-no">027</span><span id="line-27"> * &lt;p&gt;</span>
<span class="source-line-no">028</span><span id="line-28"> * Please note that the reads will cause position movement on wrapped ByteBuffer.</span>
<span class="source-line-no">029</span><span id="line-29"> */</span>
<span class="source-line-no">030</span><span id="line-30">@InterfaceAudience.Private</span>
<span class="source-line-no">031</span><span id="line-31">public class ByteBufferInputStream extends InputStream {</span>
<span class="source-line-no">032</span><span id="line-32"></span>
<span class="source-line-no">033</span><span id="line-33"> private ByteBuffer buf;</span>
<span class="source-line-no">034</span><span id="line-34"></span>
<span class="source-line-no">035</span><span id="line-35"> public ByteBufferInputStream(ByteBuffer buf) {</span>
<span class="source-line-no">036</span><span id="line-36"> this.buf = buf;</span>
<span class="source-line-no">037</span><span id="line-37"> }</span>
<span class="source-line-no">038</span><span id="line-38"></span>
<span class="source-line-no">039</span><span id="line-39"> /**</span>
<span class="source-line-no">040</span><span id="line-40"> * Reads the next byte of data from this input stream. The value byte is returned as an</span>
<span class="source-line-no">041</span><span id="line-41"> * &lt;code&gt;int&lt;/code&gt; in the range &lt;code&gt;0&lt;/code&gt; to &lt;code&gt;255&lt;/code&gt;. If no byte is available</span>
<span class="source-line-no">042</span><span id="line-42"> * because the end of the stream has been reached, the value &lt;code&gt;-1&lt;/code&gt; is returned.</span>
<span class="source-line-no">043</span><span id="line-43"> * @return the next byte of data, or &lt;code&gt;-1&lt;/code&gt; if the end of the stream has been reached.</span>
<span class="source-line-no">044</span><span id="line-44"> */</span>
<span class="source-line-no">045</span><span id="line-45"> @Override</span>
<span class="source-line-no">046</span><span id="line-46"> public int read() {</span>
<span class="source-line-no">047</span><span id="line-47"> if (this.buf.hasRemaining()) {</span>
<span class="source-line-no">048</span><span id="line-48"> return (this.buf.get() &amp; 0xff);</span>
<span class="source-line-no">049</span><span id="line-49"> }</span>
<span class="source-line-no">050</span><span id="line-50"> return -1;</span>
<span class="source-line-no">051</span><span id="line-51"> }</span>
<span class="source-line-no">052</span><span id="line-52"></span>
<span class="source-line-no">053</span><span id="line-53"> /**</span>
<span class="source-line-no">054</span><span id="line-54"> * Reads up to next &lt;code&gt;len&lt;/code&gt; bytes of data from buffer into passed array(starting from</span>
<span class="source-line-no">055</span><span id="line-55"> * given offset).</span>
<span class="source-line-no">056</span><span id="line-56"> * @param b the array into which the data is read.</span>
<span class="source-line-no">057</span><span id="line-57"> * @param off the start offset in the destination array &lt;code&gt;b&lt;/code&gt;</span>
<span class="source-line-no">058</span><span id="line-58"> * @param len the maximum number of bytes to read.</span>
<span class="source-line-no">059</span><span id="line-59"> * @return the total number of bytes actually read into the buffer, or &lt;code&gt;-1&lt;/code&gt; if not even</span>
<span class="source-line-no">060</span><span id="line-60"> * 1 byte can be read because the end of the stream has been reached.</span>
<span class="source-line-no">061</span><span id="line-61"> */</span>
<span class="source-line-no">062</span><span id="line-62"> @Override</span>
<span class="source-line-no">063</span><span id="line-63"> public int read(byte[] b, int off, int len) {</span>
<span class="source-line-no">064</span><span id="line-64"> int avail = available();</span>
<span class="source-line-no">065</span><span id="line-65"> if (avail &lt;= 0) {</span>
<span class="source-line-no">066</span><span id="line-66"> return -1;</span>
<span class="source-line-no">067</span><span id="line-67"> }</span>
<span class="source-line-no">068</span><span id="line-68"></span>
<span class="source-line-no">069</span><span id="line-69"> if (len &gt; avail) {</span>
<span class="source-line-no">070</span><span id="line-70"> len = avail;</span>
<span class="source-line-no">071</span><span id="line-71"> }</span>
<span class="source-line-no">072</span><span id="line-72"> if (len &lt;= 0) {</span>
<span class="source-line-no">073</span><span id="line-73"> return 0;</span>
<span class="source-line-no">074</span><span id="line-74"> }</span>
<span class="source-line-no">075</span><span id="line-75"></span>
<span class="source-line-no">076</span><span id="line-76"> ByteBufferUtils.copyFromBufferToArray(b, this.buf, this.buf.position(), off, len);</span>
<span class="source-line-no">077</span><span id="line-77"> this.buf.position(this.buf.position() + len); // we should advance the buffer position</span>
<span class="source-line-no">078</span><span id="line-78"> return len;</span>
<span class="source-line-no">079</span><span id="line-79"> }</span>
<span class="source-line-no">080</span><span id="line-80"></span>
<span class="source-line-no">081</span><span id="line-81"> /**</span>
<span class="source-line-no">082</span><span id="line-82"> * Skips &lt;code&gt;n&lt;/code&gt; bytes of input from this input stream. Fewer bytes might be skipped if the</span>
<span class="source-line-no">083</span><span id="line-83"> * end of the input stream is reached. The actual number &lt;code&gt;k&lt;/code&gt; of bytes to be skipped is</span>
<span class="source-line-no">084</span><span id="line-84"> * equal to the smaller of &lt;code&gt;n&lt;/code&gt; and remaining bytes in the stream.</span>
<span class="source-line-no">085</span><span id="line-85"> * @param n the number of bytes to be skipped.</span>
<span class="source-line-no">086</span><span id="line-86"> * @return the actual number of bytes skipped.</span>
<span class="source-line-no">087</span><span id="line-87"> */</span>
<span class="source-line-no">088</span><span id="line-88"> @Override</span>
<span class="source-line-no">089</span><span id="line-89"> public long skip(long n) {</span>
<span class="source-line-no">090</span><span id="line-90"> long k = Math.min(n, available());</span>
<span class="source-line-no">091</span><span id="line-91"> if (k &lt; 0) {</span>
<span class="source-line-no">092</span><span id="line-92"> k = 0;</span>
<span class="source-line-no">093</span><span id="line-93"> }</span>
<span class="source-line-no">094</span><span id="line-94"> this.buf.position((int) (this.buf.position() + k));</span>
<span class="source-line-no">095</span><span id="line-95"> return k;</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"></span>
<span class="source-line-no">098</span><span id="line-98"> /**</span>
<span class="source-line-no">099</span><span id="line-99"> * @return the number of remaining bytes that can be read (or skipped over) from this input</span>
<span class="source-line-no">100</span><span id="line-100"> * stream.</span>
<span class="source-line-no">101</span><span id="line-101"> */</span>
<span class="source-line-no">102</span><span id="line-102"> @Override</span>
<span class="source-line-no">103</span><span id="line-103"> public int available() {</span>
<span class="source-line-no">104</span><span id="line-104"> return this.buf.remaining();</span>
<span class="source-line-no">105</span><span id="line-105"> }</span>
<span class="source-line-no">106</span><span id="line-106">}</span>
</pre>
</div>
</main>
</body>
</html>