blob: da1c55813e792570c4389c88b76fee733aa36fd7 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>CellBlockBuilder (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.hadoop.hbase.ipc, class: CellBlockBuilder">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/CellBlockBuilder.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.hadoop.hbase.ipc</a></div>
<h1 title="Class CellBlockBuilder" class="title">Class CellBlockBuilder</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.hadoop.hbase.ipc.CellBlockBuilder</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="annotations">@Private
</span><span class="modifiers">class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/CellBlockBuilder.html#line-56">CellBlockBuilder</a></span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">Helper class for building cell block.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private static final class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="CellBlockBuilder.ByteBufferOutputStreamSupplier.html" class="type-name-link" title="class in org.apache.hadoop.hbase.ipc">CellBlockBuilder.ByteBufferOutputStreamSupplier</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>private static final class&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="CellBlockBuilder.ByteBufOutputStreamSupplier.html" class="type-name-link" title="class in org.apache.hadoop.hbase.ipc">CellBlockBuilder.ByteBufOutputStreamSupplier</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>private static interface&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="CellBlockBuilder.OutputStreamSupplier.html" class="type-name-link" title="interface in org.apache.hadoop.hbase.ipc">CellBlockBuilder.OutputStreamSupplier</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="caption"><span>Fields</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Field</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>private final int</code></div>
<div class="col-second even-row-color"><code><a href="#cellBlockBuildingInitialBufferSize" class="member-name-link">cellBlockBuildingInitialBufferSize</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>private final int</code></div>
<div class="col-second odd-row-color"><code><a href="#cellBlockDecompressionMultiplier" class="member-name-link">cellBlockDecompressionMultiplier</a></code></div>
<div class="col-last odd-row-color">
<div class="block">How much we think the decompressor will expand the original compressed content.</div>
</div>
<div class="col-first even-row-color"><code>private final org.apache.hadoop.conf.Configuration</code></div>
<div class="col-second even-row-color"><code><a href="#conf" class="member-name-link">conf</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>(package private) static final org.slf4j.Logger</code></div>
<div class="col-second odd-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.conf.Configuration)" class="member-name-link">CellBlockBuilder</a><wbr>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildCellBlock(org.apache.hadoop.hbase.codec.Codec,org.apache.hadoop.io.compress.CompressionCodec,org.apache.hadoop.hbase.ExtendedCellScanner)" class="member-name-link">buildCellBlock</a><wbr>(<a href="../codec/Codec.html" title="interface in org.apache.hadoop.hbase.codec">Codec</a>&nbsp;codec,
org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a>&nbsp;cellScanner)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Puts CellScanner Cells into a cell block using passed in <code>codec</code> and/or
<code>compressor</code>.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildCellBlock(org.apache.hadoop.hbase.codec.Codec,org.apache.hadoop.io.compress.CompressionCodec,org.apache.hadoop.hbase.ExtendedCellScanner,org.apache.hadoop.hbase.ipc.CellBlockBuilder.OutputStreamSupplier)" class="member-name-link">buildCellBlock</a><wbr>(<a href="../codec/Codec.html" title="interface in org.apache.hadoop.hbase.codec">Codec</a>&nbsp;codec,
org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a>&nbsp;cellScanner,
<a href="CellBlockBuilder.OutputStreamSupplier.html" title="interface in org.apache.hadoop.hbase.ipc">CellBlockBuilder.OutputStreamSupplier</a>&nbsp;supplier)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>org.apache.hbase.thirdparty.io.netty.buffer.ByteBuf</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildCellBlock(org.apache.hadoop.hbase.codec.Codec,org.apache.hadoop.io.compress.CompressionCodec,org.apache.hadoop.hbase.ExtendedCellScanner,org.apache.hbase.thirdparty.io.netty.buffer.ByteBufAllocator)" class="member-name-link">buildCellBlock</a><wbr>(<a href="../codec/Codec.html" title="interface in org.apache.hadoop.hbase.codec">Codec</a>&nbsp;codec,
org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a>&nbsp;cellScanner,
org.apache.hbase.thirdparty.io.netty.buffer.ByteBufAllocator&nbsp;alloc)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../io/ByteBufferListOutputStream.html" title="class in org.apache.hadoop.hbase.io">ByteBufferListOutputStream</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#buildCellBlockStream(org.apache.hadoop.hbase.codec.Codec,org.apache.hadoop.io.compress.CompressionCodec,org.apache.hadoop.hbase.ExtendedCellScanner,org.apache.hadoop.hbase.io.ByteBuffAllocator)" class="member-name-link">buildCellBlockStream</a><wbr>(<a href="../codec/Codec.html" title="interface in org.apache.hadoop.hbase.codec">Codec</a>&nbsp;codec,
org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a>&nbsp;cellScanner,
<a href="../io/ByteBuffAllocator.html" title="class in org.apache.hadoop.hbase.io">ByteBuffAllocator</a>&nbsp;allocator)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Puts CellScanner Cells into a cell block using passed in <code>codec</code> and/or
<code>compressor</code>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createCellScanner(org.apache.hadoop.hbase.codec.Codec,org.apache.hadoop.io.compress.CompressionCodec,byte%5B%5D)" class="member-name-link">createCellScanner</a><wbr>(<a href="../codec/Codec.html" title="interface in org.apache.hadoop.hbase.codec">Codec</a>&nbsp;codec,
org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
byte[]&nbsp;cellBlock)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Create a cell scanner.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createCellScannerReusingBuffers(org.apache.hadoop.hbase.codec.Codec,org.apache.hadoop.io.compress.CompressionCodec,org.apache.hadoop.hbase.nio.ByteBuff)" class="member-name-link">createCellScannerReusingBuffers</a><wbr>(<a href="../codec/Codec.html" title="interface in org.apache.hadoop.hbase.codec">Codec</a>&nbsp;codec,
org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
<a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a>&nbsp;cellBlock)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Create a cell scanner using an existing bytebuff.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#decompress(org.apache.hadoop.io.compress.CompressionCodec,byte%5B%5D)" class="member-name-link">decompress</a><wbr>(org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
byte[]&nbsp;compressedCellBlock)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#decompress(org.apache.hadoop.io.compress.CompressionCodec,java.io.InputStream,int)" class="member-name-link">decompress</a><wbr>(org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&nbsp;cellBlockStream,
int&nbsp;osInitialSize)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private <a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#decompress(org.apache.hadoop.io.compress.CompressionCodec,org.apache.hadoop.hbase.nio.ByteBuff)" class="member-name-link">decompress</a><wbr>(org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
<a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a>&nbsp;compressedCellBlock)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#encodeCellsTo(java.io.OutputStream,org.apache.hadoop.hbase.ExtendedCellScanner,org.apache.hadoop.hbase.codec.Codec,org.apache.hadoop.io.compress.CompressionCodec)" class="member-name-link">encodeCellsTo</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&nbsp;os,
<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a>&nbsp;cellScanner,
<a href="../codec/Codec.html" title="interface in org.apache.hadoop.hbase.codec">Codec</a>&nbsp;codec,
org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ FIELD DETAIL =========== -->
<li>
<section class="field-details" id="field-detail">
<h2>Field Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="LOG">
<h3>LOG</h3>
<div class="member-signature"><span class="modifiers">static final</span>&nbsp;<span class="return-type">org.slf4j.Logger</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/CellBlockBuilder.html#line-60">LOG</a></span></div>
</section>
</li>
<li>
<section class="detail" id="conf">
<h3>conf</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">org.apache.hadoop.conf.Configuration</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/CellBlockBuilder.html#line-62">conf</a></span></div>
</section>
</li>
<li>
<section class="detail" id="cellBlockDecompressionMultiplier">
<h3>cellBlockDecompressionMultiplier</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/CellBlockBuilder.html#line-67">cellBlockDecompressionMultiplier</a></span></div>
<div class="block">How much we think the decompressor will expand the original compressed content.</div>
</section>
</li>
<li>
<section class="detail" id="cellBlockBuildingInitialBufferSize">
<h3>cellBlockBuildingInitialBufferSize</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/CellBlockBuilder.html#line-69">cellBlockBuildingInitialBufferSize</a></span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(org.apache.hadoop.conf.Configuration)">
<h3>CellBlockBuilder</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/CellBlockBuilder.html#line-71">CellBlockBuilder</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration&nbsp;conf)</span></div>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="buildCellBlock(org.apache.hadoop.hbase.codec.Codec,org.apache.hadoop.io.compress.CompressionCodec,org.apache.hadoop.hbase.ExtendedCellScanner)">
<h3>buildCellBlock</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/CellBlockBuilder.html#line-112">buildCellBlock</a></span><wbr><span class="parameters">(<a href="../codec/Codec.html" title="interface in org.apache.hadoop.hbase.codec">Codec</a>&nbsp;codec,
org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a>&nbsp;cellScanner)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">Puts CellScanner Cells into a cell block using passed in <code>codec</code> and/or
<code>compressor</code>.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Null or byte buffer filled with a cellblock filled with passed-in Cells encoded using
passed in <code>codec</code> and/or <code>compressor</code>; the returned buffer has
been flipped and is ready for reading. Use limit to find total size.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="buildCellBlock(org.apache.hadoop.hbase.codec.Codec,org.apache.hadoop.io.compress.CompressionCodec,org.apache.hadoop.hbase.ExtendedCellScanner,org.apache.hbase.thirdparty.io.netty.buffer.ByteBufAllocator)">
<h3>buildCellBlock</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">org.apache.hbase.thirdparty.io.netty.buffer.ByteBuf</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/CellBlockBuilder.html#line-147">buildCellBlock</a></span><wbr><span class="parameters">(<a href="../codec/Codec.html" title="interface in org.apache.hadoop.hbase.codec">Codec</a>&nbsp;codec,
org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a>&nbsp;cellScanner,
org.apache.hbase.thirdparty.io.netty.buffer.ByteBufAllocator&nbsp;alloc)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="buildCellBlock(org.apache.hadoop.hbase.codec.Codec,org.apache.hadoop.io.compress.CompressionCodec,org.apache.hadoop.hbase.ExtendedCellScanner,org.apache.hadoop.hbase.ipc.CellBlockBuilder.OutputStreamSupplier)">
<h3>buildCellBlock</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/CellBlockBuilder.html#line-157">buildCellBlock</a></span><wbr><span class="parameters">(<a href="../codec/Codec.html" title="interface in org.apache.hadoop.hbase.codec">Codec</a>&nbsp;codec,
org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a>&nbsp;cellScanner,
<a href="CellBlockBuilder.OutputStreamSupplier.html" title="interface in org.apache.hadoop.hbase.ipc">CellBlockBuilder.OutputStreamSupplier</a>&nbsp;supplier)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="encodeCellsTo(java.io.OutputStream,org.apache.hadoop.hbase.ExtendedCellScanner,org.apache.hadoop.hbase.codec.Codec,org.apache.hadoop.io.compress.CompressionCodec)">
<h3>encodeCellsTo</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/CellBlockBuilder.html#line-174">encodeCellsTo</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/OutputStream.html" title="class or interface in java.io" class="external-link">OutputStream</a>&nbsp;os,
<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a>&nbsp;cellScanner,
<a href="../codec/Codec.html" title="interface in org.apache.hadoop.hbase.codec">Codec</a>&nbsp;codec,
org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="buildCellBlockStream(org.apache.hadoop.hbase.codec.Codec,org.apache.hadoop.io.compress.CompressionCodec,org.apache.hadoop.hbase.ExtendedCellScanner,org.apache.hadoop.hbase.io.ByteBuffAllocator)">
<h3>buildCellBlockStream</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../io/ByteBufferListOutputStream.html" title="class in org.apache.hadoop.hbase.io">ByteBufferListOutputStream</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/CellBlockBuilder.html#line-214">buildCellBlockStream</a></span><wbr><span class="parameters">(<a href="../codec/Codec.html" title="interface in org.apache.hadoop.hbase.codec">Codec</a>&nbsp;codec,
org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a>&nbsp;cellScanner,
<a href="../io/ByteBuffAllocator.html" title="class in org.apache.hadoop.hbase.io">ByteBuffAllocator</a>&nbsp;allocator)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">Puts CellScanner Cells into a cell block using passed in <code>codec</code> and/or
<code>compressor</code>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>codec</code> - to use for encoding</dd>
<dd><code>compressor</code> - to use for encoding</dd>
<dd><code>cellScanner</code> - to encode</dd>
<dd><code>allocator</code> - to allocate the <a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio"><code>ByteBuff</code></a>.</dd>
<dt>Returns:</dt>
<dd>Null or byte buffer filled with a cellblock filled with passed-in Cells encoded using
passed in <code>codec</code> and/or <code>compressor</code>; the returned buffer has
been flipped and is ready for reading. Use limit to find total size. If
<code>pool</code> was not null, then this returned ByteBuffer came from there and
should be returned to the pool when done.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if encoding the cells fail</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createCellScanner(org.apache.hadoop.hbase.codec.Codec,org.apache.hadoop.io.compress.CompressionCodec,byte[])">
<h3>createCellScanner</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/CellBlockBuilder.html#line-238">createCellScanner</a></span><wbr><span class="parameters">(<a href="../codec/Codec.html" title="interface in org.apache.hadoop.hbase.codec">Codec</a>&nbsp;codec,
org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
byte[]&nbsp;cellBlock)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">Create a cell scanner.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>codec</code> - to use for cellblock</dd>
<dd><code>cellBlock</code> - to encode</dd>
<dt>Returns:</dt>
<dd>CellScanner to work against the content of <code>cellBlock</code></dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if encoding fails</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="createCellScannerReusingBuffers(org.apache.hadoop.hbase.codec.Codec,org.apache.hadoop.io.compress.CompressionCodec,org.apache.hadoop.hbase.nio.ByteBuff)">
<h3>createCellScannerReusingBuffers</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/CellBlockBuilder.html#line-261">createCellScannerReusingBuffers</a></span><wbr><span class="parameters">(<a href="../codec/Codec.html" title="interface in org.apache.hadoop.hbase.codec">Codec</a>&nbsp;codec,
org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
<a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a>&nbsp;cellBlock)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">Create a cell scanner using an existing bytebuff.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>codec</code> - to use for cellblock</dd>
<dd><code>cellBlock</code> - ByteBuffer containing the cells written by the Codec. The buffer should be
position()'ed at the start of the cell block and limit()'ed at the end.</dd>
<dt>Returns:</dt>
<dd>CellScanner to work against the content of <code>cellBlock</code>. All cells created
out of the CellScanner will share the same ByteBuffer being passed.</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if cell encoding fails</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="decompress(org.apache.hadoop.io.compress.CompressionCodec,byte[])">
<h3>decompress</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/CellBlockBuilder.html#line-272">decompress</a></span><wbr><span class="parameters">(org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
byte[]&nbsp;compressedCellBlock)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="decompress(org.apache.hadoop.io.compress.CompressionCodec,org.apache.hadoop.hbase.nio.ByteBuff)">
<h3>decompress</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/CellBlockBuilder.html#line-279">decompress</a></span><wbr><span class="parameters">(org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
<a href="../nio/ByteBuff.html" title="class in org.apache.hadoop.hbase.nio">ByteBuff</a>&nbsp;compressedCellBlock)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="decompress(org.apache.hadoop.io.compress.CompressionCodec,java.io.InputStream,int)">
<h3>decompress</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/CellBlockBuilder.html#line-286">decompress</a></span><wbr><span class="parameters">(org.apache.hadoop.io.compress.CompressionCodec&nbsp;compressor,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/InputStream.html" title="class or interface in java.io" class="external-link">InputStream</a>&nbsp;cellBlockStream,
int&nbsp;osInitialSize)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<dl class="notes">
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2007&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>