Google Git
Sign in
apache / hbase-site / 0dd212ad7c7488fceadc568d4ed9edcae6b5fbc9 / . / devapidocs / org / apache / hadoop / hbase / io / hfile / HFileStreamReader.html
blob: abebc06682425a7bacbfbb3809ef302d6015ffd1 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>HFileStreamReader (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.io.hfile, class: HFileStreamReader">
<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/HFileStreamReader.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>Field&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.io.hfile</a></div>
<h1 title="Class HFileStreamReader" class="title">Class HFileStreamReader</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"><a href="HFileReaderImpl.html" title="class in org.apache.hadoop.hbase.io.hfile">org.apache.hadoop.hbase.io.hfile.HFileReaderImpl</a>
<div class="inheritance">org.apache.hadoop.hbase.io.hfile.HFileStreamReader</div>
</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code>org.apache.hadoop.conf.Configurable</code>, <code><a href="HFile.CachingBlockReader.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFile.CachingBlockReader</a></code>, <code><a href="HFile.Reader.html" title="interface in org.apache.hadoop.hbase.io.hfile">HFile.Reader</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="annotations">@Private
</span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileStreamReader.html#line-28">HFileStreamReader</a></span>
<span class="extends-implements">extends <a href="HFileReaderImpl.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileReaderImpl</a></span></div>
<div class="block">Implementation of <a href="HFile.Reader.html" title="interface in org.apache.hadoop.hbase.io.hfile"><code>HFile.Reader</code></a> to deal with stream read do not perform any prefetch
operations (HFilePreadReader will do this).</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="inherited-list">
<h2 id="nested-classes-inherited-from-class-org.apache.hadoop.hbase.io.hfile.HFileReaderImpl">Nested classes/interfaces inherited from class&nbsp;org.apache.hadoop.hbase.io.hfile.<a href="HFileReaderImpl.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileReaderImpl</a></h2>
<code><a href="HFileReaderImpl.BlockIndexNotLoadedException.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileReaderImpl.BlockIndexNotLoadedException</a>, <a href="HFileReaderImpl.EncodedScanner.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileReaderImpl.EncodedScanner</a>, <a href="HFileReaderImpl.HFileScannerImpl.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileReaderImpl.HFileScannerImpl</a>, <a href="HFileReaderImpl.NotSeekedException.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileReaderImpl.NotSeekedException</a></code></div>
</section>
</li>
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.io.hfile.HFileReaderImpl">Fields inherited from class&nbsp;org.apache.hadoop.hbase.io.hfile.<a href="HFileReaderImpl.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileReaderImpl</a></h3>
<code><a href="HFileReaderImpl.html#cacheConf">cacheConf</a>, <a href="HFileReaderImpl.html#context">context</a>, <a href="HFileReaderImpl.html#dataBlockEncoder">dataBlockEncoder</a>, <a href="HFileReaderImpl.html#dataBlockIndexReader">dataBlockIndexReader</a>, <a href="HFileReaderImpl.html#fileInfo">fileInfo</a>, <a href="HFileReaderImpl.html#fsBlockReader">fsBlockReader</a>, <a href="HFileReaderImpl.html#hfileContext">hfileContext</a>, <a href="HFileReaderImpl.html#KEY_VALUE_LEN_SIZE">KEY_VALUE_LEN_SIZE</a>, <a href="HFileReaderImpl.html#MAX_MINOR_VERSION">MAX_MINOR_VERSION</a>, <a href="HFileReaderImpl.html#metaBlockIndexReader">metaBlockIndexReader</a>, <a href="HFileReaderImpl.html#MIN_MINOR_VERSION">MIN_MINOR_VERSION</a>, <a href="HFileReaderImpl.html#MINOR_VERSION_NO_CHECKSUM">MINOR_VERSION_NO_CHECKSUM</a>, <a href="HFileReaderImpl.html#MINOR_VERSION_WITH_CHECKSUM">MINOR_VERSION_WITH_CHECKSUM</a>, <a href="HFileReaderImpl.html#MINOR_VERSION_WITH_FAKED_KEY">MINOR_VERSION_WITH_FAKED_KEY</a>, <a href="HFileReaderImpl.html#name">name</a>, <a href="HFileReaderImpl.html#path">path</a>, <a href="HFileReaderImpl.html#PBUF_TRAILER_MINOR_VERSION">PBUF_TRAILER_MINOR_VERSION</a>, <a href="HFileReaderImpl.html#trailer">trailer</a></code></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.hbase.io.hfile.ReaderContext,org.apache.hadoop.hbase.io.hfile.HFileInfo,org.apache.hadoop.hbase.io.hfile.CacheConfig,org.apache.hadoop.conf.Configuration)" class="member-name-link">HFileStreamReader</a><wbr>(<a href="ReaderContext.html" title="class in org.apache.hadoop.hbase.io.hfile">ReaderContext</a>&nbsp;context,
<a href="HFileInfo.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileInfo</a>&nbsp;fileInfo,
<a href="CacheConfig.html" title="class in org.apache.hadoop.hbase.io.hfile">CacheConfig</a>&nbsp;cacheConf,
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>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#close(boolean)" class="member-name-link">close</a><wbr>(boolean&nbsp;evictOnClose)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Close method with optional evictOnClose</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.io.hfile.HFileReaderImpl">Methods inherited from class&nbsp;org.apache.hadoop.hbase.io.hfile.<a href="HFileReaderImpl.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileReaderImpl</a></h3>
<code><a href="HFileReaderImpl.html#close()">close</a>, <a href="HFileReaderImpl.html#getCacheConf()">getCacheConf</a>, <a href="HFileReaderImpl.html#getComparator()">getComparator</a>, <a href="HFileReaderImpl.html#getCompressionAlgorithm()">getCompressionAlgorithm</a>, <a href="HFileReaderImpl.html#getConf()">getConf</a>, <a href="HFileReaderImpl.html#getContext()">getContext</a>, <a href="HFileReaderImpl.html#getDataBlockEncoding()">getDataBlockEncoding</a>, <a href="HFileReaderImpl.html#getDataBlockIndexReader()">getDataBlockIndexReader</a>, <a href="HFileReaderImpl.html#getDeleteBloomFilterMetadata()">getDeleteBloomFilterMetadata</a>, <a href="HFileReaderImpl.html#getEffectiveEncodingInCache(boolean)">getEffectiveEncodingInCache</a>, <a href="HFileReaderImpl.html#getEntries()">getEntries</a>, <a href="HFileReaderImpl.html#getFileContext()">getFileContext</a>, <a href="HFileReaderImpl.html#getFirstKey()">getFirstKey</a>, <a href="HFileReaderImpl.html#getFirstRowKey()">getFirstRowKey</a>, <a href="HFileReaderImpl.html#getGeneralBloomFilterMetadata()">getGeneralBloomFilterMetadata</a>, <a href="HFileReaderImpl.html#getHFileInfo()">getHFileInfo</a>, <a href="HFileReaderImpl.html#getLastKey()">getLastKey</a>, <a href="HFileReaderImpl.html#getLastRowKey()">getLastRowKey</a>, <a href="HFileReaderImpl.html#getMajorVersion()">getMajorVersion</a>, <a href="HFileReaderImpl.html#getMetaBlock(java.lang.String,boolean)">getMetaBlock</a>, <a href="HFileReaderImpl.html#getMetaBlockIndexReader()">getMetaBlockIndexReader</a>, <a href="HFileReaderImpl.html#getName()">getName</a>, <a href="HFileReaderImpl.html#getPath()">getPath</a>, <a href="HFileReaderImpl.html#getScanner(org.apache.hadoop.conf.Configuration,boolean,boolean)">getScanner</a>, <a href="HFileReaderImpl.html#getScanner(org.apache.hadoop.conf.Configuration,boolean,boolean,boolean)">getScanner</a>, <a href="HFileReaderImpl.html#getTrailer()">getTrailer</a>, <a href="HFileReaderImpl.html#getUncachedBlockReader()">getUncachedBlockReader</a>, <a href="HFileReaderImpl.html#hasMVCCInfo()">hasMVCCInfo</a>, <a href="HFileReaderImpl.html#indexSize()">indexSize</a>, <a href="HFileReaderImpl.html#isFileInfoLoaded()">isFileInfoLoaded</a>, <a href="HFileReaderImpl.html#isPrimaryReplicaReader()">isPrimaryReplicaReader</a>, <a href="HFileReaderImpl.html#length()">length</a>, <a href="HFileReaderImpl.html#midKey()">midKey</a>, <a href="HFileReaderImpl.html#prefetchComplete()">prefetchComplete</a>, <a href="HFileReaderImpl.html#prefetchStarted()">prefetchStarted</a>, <a href="HFileReaderImpl.html#readBlock(long,long,boolean,boolean,boolean,boolean,org.apache.hadoop.hbase.io.hfile.BlockType,org.apache.hadoop.hbase.io.encoding.DataBlockEncoding)">readBlock</a>, <a href="HFileReaderImpl.html#readBlock(long,long,boolean,boolean,boolean,boolean,org.apache.hadoop.hbase.io.hfile.BlockType,org.apache.hadoop.hbase.io.encoding.DataBlockEncoding,boolean)">readBlock</a>, <a href="HFileReaderImpl.html#setConf(org.apache.hadoop.conf.Configuration)">setConf</a>, <a href="HFileReaderImpl.html#setDataBlockEncoder(org.apache.hadoop.hbase.io.hfile.HFileDataBlockEncoder)">setDataBlockEncoder</a>, <a href="HFileReaderImpl.html#setDataBlockIndexReader(org.apache.hadoop.hbase.io.hfile.HFileBlockIndex.CellBasedKeyBlockIndexReader)">setDataBlockIndexReader</a>, <a href="HFileReaderImpl.html#setMetaBlockIndexReader(org.apache.hadoop.hbase.io.hfile.HFileBlockIndex.ByteArrayKeyBlockIndexReader)">setMetaBlockIndexReader</a>, <a href="HFileReaderImpl.html#toString()">toString</a>, <a href="HFileReaderImpl.html#unbufferStream()">unbufferStream</a></code></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#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">
<!-- ========= 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.hbase.io.hfile.ReaderContext,org.apache.hadoop.hbase.io.hfile.HFileInfo,org.apache.hadoop.hbase.io.hfile.CacheConfig,org.apache.hadoop.conf.Configuration)">
<h3>HFileStreamReader</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileStreamReader.html#line-30">HFileStreamReader</a></span><wbr><span class="parameters">(<a href="ReaderContext.html" title="class in org.apache.hadoop.hbase.io.hfile">ReaderContext</a>&nbsp;context,
<a href="HFileInfo.html" title="class in org.apache.hadoop.hbase.io.hfile">HFileInfo</a>&nbsp;fileInfo,
<a href="CacheConfig.html" title="class in org.apache.hadoop.hbase.io.hfile">CacheConfig</a>&nbsp;cacheConf,
org.apache.hadoop.conf.Configuration&nbsp;conf)</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>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="close(boolean)">
<h3>close</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileStreamReader.html#line-35">close</a></span><wbr><span class="parameters">(boolean&nbsp;evictOnClose)</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"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="HFile.Reader.html#close(boolean)">HFile.Reader</a></code></span></div>
<div class="block">Close method with optional evictOnClose</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>