blob: f88981831b7c5d8bdc772d9f4191d5393943954a [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: ByteBufferOutputStream">
<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.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.io.OutputStream;</span>
<span class="source-line-no">022</span><span id="line-22">import java.nio.BufferOverflowException;</span>
<span class="source-line-no">023</span><span id="line-23">import java.nio.ByteBuffer;</span>
<span class="source-line-no">024</span><span id="line-24">import java.nio.ByteOrder;</span>
<span class="source-line-no">025</span><span id="line-25">import java.nio.channels.Channels;</span>
<span class="source-line-no">026</span><span id="line-26">import java.nio.channels.WritableByteChannel;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.util.ByteBufferUtils;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">030</span><span id="line-30"></span>
<span class="source-line-no">031</span><span id="line-31">/**</span>
<span class="source-line-no">032</span><span id="line-32"> * Not thread safe!</span>
<span class="source-line-no">033</span><span id="line-33"> */</span>
<span class="source-line-no">034</span><span id="line-34">@InterfaceAudience.Public</span>
<span class="source-line-no">035</span><span id="line-35">public class ByteBufferOutputStream extends OutputStream implements ByteBufferWriter {</span>
<span class="source-line-no">036</span><span id="line-36"></span>
<span class="source-line-no">037</span><span id="line-37"> // Borrowed from openJDK:</span>
<span class="source-line-no">038</span><span id="line-38"> // http://grepcode.com/file/repository.grepcode.com/java/root/jdk/openjdk/8-b132/java/util/ArrayList.java#221</span>
<span class="source-line-no">039</span><span id="line-39"> private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;</span>
<span class="source-line-no">040</span><span id="line-40"></span>
<span class="source-line-no">041</span><span id="line-41"> protected ByteBuffer curBuf = null;</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43"> ByteBufferOutputStream() {</span>
<span class="source-line-no">044</span><span id="line-44"></span>
<span class="source-line-no">045</span><span id="line-45"> }</span>
<span class="source-line-no">046</span><span id="line-46"></span>
<span class="source-line-no">047</span><span id="line-47"> public ByteBufferOutputStream(int capacity) {</span>
<span class="source-line-no">048</span><span id="line-48"> this(capacity, false);</span>
<span class="source-line-no">049</span><span id="line-49"> }</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51"> public ByteBufferOutputStream(int capacity, boolean useDirectByteBuffer) {</span>
<span class="source-line-no">052</span><span id="line-52"> this(allocate(capacity, useDirectByteBuffer));</span>
<span class="source-line-no">053</span><span id="line-53"> }</span>
<span class="source-line-no">054</span><span id="line-54"></span>
<span class="source-line-no">055</span><span id="line-55"> /**</span>
<span class="source-line-no">056</span><span id="line-56"> * @param bb ByteBuffer to use. If too small, will be discarded and a new one allocated in its</span>
<span class="source-line-no">057</span><span id="line-57"> * place; i.e. the passed in BB may NOT BE RETURNED!! Minimally it will be altered. SIDE</span>
<span class="source-line-no">058</span><span id="line-58"> * EFFECT!! If you want to get the newly allocated ByteBuffer, you'll need to pick it up</span>
<span class="source-line-no">059</span><span id="line-59"> * when done with this instance by calling {@link #getByteBuffer()}. All this</span>
<span class="source-line-no">060</span><span id="line-60"> * encapsulation violation is so we can recycle buffers rather than allocate each time;</span>
<span class="source-line-no">061</span><span id="line-61"> * it can get expensive especially if the buffers are big doing allocations each time or</span>
<span class="source-line-no">062</span><span id="line-62"> * having them undergo resizing because initial allocation was small.</span>
<span class="source-line-no">063</span><span id="line-63"> * @see #getByteBuffer()</span>
<span class="source-line-no">064</span><span id="line-64"> */</span>
<span class="source-line-no">065</span><span id="line-65"> public ByteBufferOutputStream(final ByteBuffer bb) {</span>
<span class="source-line-no">066</span><span id="line-66"> assert bb.order() == ByteOrder.BIG_ENDIAN;</span>
<span class="source-line-no">067</span><span id="line-67"> this.curBuf = bb;</span>
<span class="source-line-no">068</span><span id="line-68"> this.curBuf.clear();</span>
<span class="source-line-no">069</span><span id="line-69"> }</span>
<span class="source-line-no">070</span><span id="line-70"></span>
<span class="source-line-no">071</span><span id="line-71"> public int size() {</span>
<span class="source-line-no">072</span><span id="line-72"> return curBuf.position();</span>
<span class="source-line-no">073</span><span id="line-73"> }</span>
<span class="source-line-no">074</span><span id="line-74"></span>
<span class="source-line-no">075</span><span id="line-75"> private static ByteBuffer allocate(final int capacity, final boolean useDirectByteBuffer) {</span>
<span class="source-line-no">076</span><span id="line-76"> if (capacity &gt; MAX_ARRAY_SIZE) { // avoid OutOfMemoryError</span>
<span class="source-line-no">077</span><span id="line-77"> throw new BufferOverflowException();</span>
<span class="source-line-no">078</span><span id="line-78"> }</span>
<span class="source-line-no">079</span><span id="line-79"> return useDirectByteBuffer</span>
<span class="source-line-no">080</span><span id="line-80"> ? ByteBuffer.allocateDirect(capacity)</span>
<span class="source-line-no">081</span><span id="line-81"> : ByteBuffer.allocate(capacity);</span>
<span class="source-line-no">082</span><span id="line-82"> }</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"> * This flips the underlying BB so be sure to use it _last_!</span>
<span class="source-line-no">086</span><span id="line-86"> */</span>
<span class="source-line-no">087</span><span id="line-87"> public ByteBuffer getByteBuffer() {</span>
<span class="source-line-no">088</span><span id="line-88"> curBuf.flip();</span>
<span class="source-line-no">089</span><span id="line-89"> return curBuf;</span>
<span class="source-line-no">090</span><span id="line-90"> }</span>
<span class="source-line-no">091</span><span id="line-91"></span>
<span class="source-line-no">092</span><span id="line-92"> protected void checkSizeAndGrow(int extra) {</span>
<span class="source-line-no">093</span><span id="line-93"> long capacityNeeded = curBuf.position() + (long) extra;</span>
<span class="source-line-no">094</span><span id="line-94"> if (capacityNeeded &gt; curBuf.limit()) {</span>
<span class="source-line-no">095</span><span id="line-95"> // guarantee it's possible to fit</span>
<span class="source-line-no">096</span><span id="line-96"> if (capacityNeeded &gt; MAX_ARRAY_SIZE) {</span>
<span class="source-line-no">097</span><span id="line-97"> throw new BufferOverflowException();</span>
<span class="source-line-no">098</span><span id="line-98"> }</span>
<span class="source-line-no">099</span><span id="line-99"> // double until hit the cap</span>
<span class="source-line-no">100</span><span id="line-100"> long nextCapacity = Math.min(curBuf.capacity() * 2L, MAX_ARRAY_SIZE);</span>
<span class="source-line-no">101</span><span id="line-101"> // but make sure there is enough if twice the existing capacity is still too small</span>
<span class="source-line-no">102</span><span id="line-102"> nextCapacity = Math.max(nextCapacity, capacityNeeded);</span>
<span class="source-line-no">103</span><span id="line-103"> ByteBuffer newBuf = allocate((int) nextCapacity, curBuf.isDirect());</span>
<span class="source-line-no">104</span><span id="line-104"> curBuf.flip();</span>
<span class="source-line-no">105</span><span id="line-105"> ByteBufferUtils.copyFromBufferToBuffer(curBuf, newBuf);</span>
<span class="source-line-no">106</span><span id="line-106"> curBuf = newBuf;</span>
<span class="source-line-no">107</span><span id="line-107"> }</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"> // OutputStream</span>
<span class="source-line-no">111</span><span id="line-111"> @Override</span>
<span class="source-line-no">112</span><span id="line-112"> public void write(int b) throws IOException {</span>
<span class="source-line-no">113</span><span id="line-113"> checkSizeAndGrow(Bytes.SIZEOF_BYTE);</span>
<span class="source-line-no">114</span><span id="line-114"> curBuf.put((byte) b);</span>
<span class="source-line-no">115</span><span id="line-115"> }</span>
<span class="source-line-no">116</span><span id="line-116"></span>
<span class="source-line-no">117</span><span id="line-117"> /**</span>
<span class="source-line-no">118</span><span id="line-118"> * Writes the complete contents of this byte buffer output stream to the specified output stream</span>
<span class="source-line-no">119</span><span id="line-119"> * argument.</span>
<span class="source-line-no">120</span><span id="line-120"> * @param out the output stream to which to write the data.</span>
<span class="source-line-no">121</span><span id="line-121"> * @exception IOException if an I/O error occurs.</span>
<span class="source-line-no">122</span><span id="line-122"> */</span>
<span class="source-line-no">123</span><span id="line-123"> public void writeTo(OutputStream out) throws IOException {</span>
<span class="source-line-no">124</span><span id="line-124"> WritableByteChannel channel = Channels.newChannel(out);</span>
<span class="source-line-no">125</span><span id="line-125"> ByteBuffer bb = curBuf.duplicate();</span>
<span class="source-line-no">126</span><span id="line-126"> bb.flip();</span>
<span class="source-line-no">127</span><span id="line-127"> channel.write(bb);</span>
<span class="source-line-no">128</span><span id="line-128"> }</span>
<span class="source-line-no">129</span><span id="line-129"></span>
<span class="source-line-no">130</span><span id="line-130"> @Override</span>
<span class="source-line-no">131</span><span id="line-131"> public void write(byte[] b) throws IOException {</span>
<span class="source-line-no">132</span><span id="line-132"> write(b, 0, b.length);</span>
<span class="source-line-no">133</span><span id="line-133"> }</span>
<span class="source-line-no">134</span><span id="line-134"></span>
<span class="source-line-no">135</span><span id="line-135"> @Override</span>
<span class="source-line-no">136</span><span id="line-136"> public void write(byte[] b, int off, int len) throws IOException {</span>
<span class="source-line-no">137</span><span id="line-137"> checkSizeAndGrow(len);</span>
<span class="source-line-no">138</span><span id="line-138"> ByteBufferUtils.copyFromArrayToBuffer(curBuf, b, off, len);</span>
<span class="source-line-no">139</span><span id="line-139"> }</span>
<span class="source-line-no">140</span><span id="line-140"></span>
<span class="source-line-no">141</span><span id="line-141"> @Override</span>
<span class="source-line-no">142</span><span id="line-142"> public void write(ByteBuffer b, int off, int len) throws IOException {</span>
<span class="source-line-no">143</span><span id="line-143"> checkSizeAndGrow(len);</span>
<span class="source-line-no">144</span><span id="line-144"> ByteBufferUtils.copyFromBufferToBuffer(b, curBuf, off, len);</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"> /**</span>
<span class="source-line-no">148</span><span id="line-148"> * Writes an &lt;code&gt;int&lt;/code&gt; to the underlying output stream as four bytes, high byte first.</span>
<span class="source-line-no">149</span><span id="line-149"> * @param i the &lt;code&gt;int&lt;/code&gt; to write</span>
<span class="source-line-no">150</span><span id="line-150"> * @throws IOException if an I/O error occurs.</span>
<span class="source-line-no">151</span><span id="line-151"> */</span>
<span class="source-line-no">152</span><span id="line-152"> @Override</span>
<span class="source-line-no">153</span><span id="line-153"> public void writeInt(int i) throws IOException {</span>
<span class="source-line-no">154</span><span id="line-154"> checkSizeAndGrow(Bytes.SIZEOF_INT);</span>
<span class="source-line-no">155</span><span id="line-155"> ByteBufferUtils.putInt(this.curBuf, i);</span>
<span class="source-line-no">156</span><span id="line-156"> }</span>
<span class="source-line-no">157</span><span id="line-157"></span>
<span class="source-line-no">158</span><span id="line-158"> @Override</span>
<span class="source-line-no">159</span><span id="line-159"> public void flush() throws IOException {</span>
<span class="source-line-no">160</span><span id="line-160"> // noop</span>
<span class="source-line-no">161</span><span id="line-161"> }</span>
<span class="source-line-no">162</span><span id="line-162"></span>
<span class="source-line-no">163</span><span id="line-163"> @Override</span>
<span class="source-line-no">164</span><span id="line-164"> public void close() throws IOException {</span>
<span class="source-line-no">165</span><span id="line-165"> // noop again. heh</span>
<span class="source-line-no">166</span><span id="line-166"> }</span>
<span class="source-line-no">167</span><span id="line-167"></span>
<span class="source-line-no">168</span><span id="line-168"> public byte[] toByteArray(int offset, int length) {</span>
<span class="source-line-no">169</span><span id="line-169"> ByteBuffer bb = curBuf.duplicate();</span>
<span class="source-line-no">170</span><span id="line-170"> bb.flip();</span>
<span class="source-line-no">171</span><span id="line-171"></span>
<span class="source-line-no">172</span><span id="line-172"> byte[] chunk = new byte[length];</span>
<span class="source-line-no">173</span><span id="line-173"></span>
<span class="source-line-no">174</span><span id="line-174"> bb.position(offset);</span>
<span class="source-line-no">175</span><span id="line-175"> bb.get(chunk, 0, length);</span>
<span class="source-line-no">176</span><span id="line-176"> return chunk;</span>
<span class="source-line-no">177</span><span id="line-177"> }</span>
<span class="source-line-no">178</span><span id="line-178">}</span>
</pre>
</div>
</main>
</body>
</html>