| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>CollectionBackedScanner (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.util, class: CollectionBackedScanner"> |
| <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/CollectionBackedScanner.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: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </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> <a href="package-summary.html">org.apache.hadoop.hbase.util</a></div> |
| <h1 title="Class CollectionBackedScanner" class="title">Class CollectionBackedScanner</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="../regionserver/NonLazyKeyValueScanner.html" title="class in org.apache.hadoop.hbase.regionserver">org.apache.hadoop.hbase.regionserver.NonLazyKeyValueScanner</a> |
| <div class="inheritance"><a href="../regionserver/NonReversedNonLazyKeyValueScanner.html" title="class in org.apache.hadoop.hbase.regionserver">org.apache.hadoop.hbase.regionserver.NonReversedNonLazyKeyValueScanner</a> |
| <div class="inheritance">org.apache.hadoop.hbase.util.CollectionBackedScanner</div> |
| </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><a href="../regionserver/KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></code>, <code><a href="../regionserver/Shipper.html" title="interface in org.apache.hadoop.hbase.regionserver">Shipper</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/util/CollectionBackedScanner.html#line-33">CollectionBackedScanner</a></span> |
| <span class="extends-implements">extends <a href="../regionserver/NonReversedNonLazyKeyValueScanner.html" title="class in org.apache.hadoop.hbase.regionserver">NonReversedNonLazyKeyValueScanner</a></span></div> |
| <div class="block">Utility scanner that wraps a sortable collection and serves as a KeyValueScanner.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== 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>(package private) final <a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#comparator" class="member-name-link">comparator</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private <a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#current" class="member-name-link">current</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#data" class="member-name-link">data</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#iter" class="member-name-link">iter</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.regionserver.KeyValueScanner">Fields inherited from interface org.apache.hadoop.hbase.regionserver.<a href="../regionserver/KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></h3> |
| <code><a href="../regionserver/KeyValueScanner.html#NO_NEXT_INDEXED_KEY">NO_NEXT_INDEXED_KEY</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(java.util.List)" class="member-name-link">CollectionBackedScanner</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>> list)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.util.List,org.apache.hadoop.hbase.CellComparator)" class="member-name-link">CollectionBackedScanner</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>> list, |
| <a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a> comparator)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.util.SortedSet)" class="member-name-link">CollectionBackedScanner</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/SortedSet.html" title="class or interface in java.util" class="external-link">SortedSet</a><<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>> set)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.util.SortedSet,org.apache.hadoop.hbase.CellComparator)" class="member-name-link">CollectionBackedScanner</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/SortedSet.html" title="class or interface in java.util" class="external-link">SortedSet</a><<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>> set, |
| <a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a> comparator)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.hbase.CellComparator,org.apache.hadoop.hbase.ExtendedCell...)" class="member-name-link">CollectionBackedScanner</a><wbr>(<a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a> comparator, |
| <a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>... array)</code></div> |
| <div class="col-last even-row-color"> </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()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Close the KeyValue scanner.</div> |
| </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="#init()" class="member-name-link">init</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#next()" class="member-name-link">next</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return the next Cell in this scanner, iterating the scanner</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#peek()" class="member-name-link">peek</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Look at the next Cell in this scanner, but do not iterate scanner.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reseek(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">reseek</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> seekCell)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Reseek the scanner at or after the specified KeyValue.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#seek(org.apache.hadoop.hbase.ExtendedCell)" class="member-name-link">seek</a><wbr>(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> seekCell)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Seek the scanner at or after the specified KeyValue.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.regionserver.NonReversedNonLazyKeyValueScanner">Methods inherited from class org.apache.hadoop.hbase.regionserver.<a href="../regionserver/NonReversedNonLazyKeyValueScanner.html" title="class in org.apache.hadoop.hbase.regionserver">NonReversedNonLazyKeyValueScanner</a></h3> |
| <code><a href="../regionserver/NonReversedNonLazyKeyValueScanner.html#backwardSeek(org.apache.hadoop.hbase.ExtendedCell)">backwardSeek</a>, <a href="../regionserver/NonReversedNonLazyKeyValueScanner.html#seekToLastRow()">seekToLastRow</a>, <a href="../regionserver/NonReversedNonLazyKeyValueScanner.html#seekToPreviousRow(org.apache.hadoop.hbase.ExtendedCell)">seekToPreviousRow</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.regionserver.NonLazyKeyValueScanner">Methods inherited from class org.apache.hadoop.hbase.regionserver.<a href="../regionserver/NonLazyKeyValueScanner.html" title="class in org.apache.hadoop.hbase.regionserver">NonLazyKeyValueScanner</a></h3> |
| <code><a href="../regionserver/NonLazyKeyValueScanner.html#doRealSeek(org.apache.hadoop.hbase.regionserver.KeyValueScanner,org.apache.hadoop.hbase.ExtendedCell,boolean)">doRealSeek</a>, <a href="../regionserver/NonLazyKeyValueScanner.html#enforceSeek()">enforceSeek</a>, <a href="../regionserver/NonLazyKeyValueScanner.html#getFilePath()">getFilePath</a>, <a href="../regionserver/NonLazyKeyValueScanner.html#getNextIndexedKey()">getNextIndexedKey</a>, <a href="../regionserver/NonLazyKeyValueScanner.html#isFileScanner()">isFileScanner</a>, <a href="../regionserver/NonLazyKeyValueScanner.html#realSeekDone()">realSeekDone</a>, <a href="../regionserver/NonLazyKeyValueScanner.html#recordBlockSize(java.util.function.IntConsumer)">recordBlockSize</a>, <a href="../regionserver/NonLazyKeyValueScanner.html#requestSeek(org.apache.hadoop.hbase.ExtendedCell,boolean,boolean)">requestSeek</a>, <a href="../regionserver/NonLazyKeyValueScanner.html#shipped()">shipped</a>, <a href="../regionserver/NonLazyKeyValueScanner.html#shouldUseScanner(org.apache.hadoop.hbase.client.Scan,org.apache.hadoop.hbase.regionserver.HStore,long)">shouldUseScanner</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.regionserver.KeyValueScanner">Methods inherited from interface org.apache.hadoop.hbase.regionserver.<a href="../regionserver/KeyValueScanner.html" title="interface in org.apache.hadoop.hbase.regionserver">KeyValueScanner</a></h3> |
| <code><a href="../regionserver/KeyValueScanner.html#getScannerOrder()">getScannerOrder</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="data"> |
| <h3>data</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Iterable.html" title="class or interface in java.lang" class="external-link">Iterable</a><<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/CollectionBackedScanner.html#line-35">data</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="comparator"> |
| <h3>comparator</h3> |
| <div class="member-signature"><span class="modifiers">final</span> <span class="return-type"><a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/CollectionBackedScanner.html#line-36">comparator</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="iter"> |
| <h3>iter</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Iterator.html" title="class or interface in java.util" class="external-link">Iterator</a><<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/CollectionBackedScanner.html#line-37">iter</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="current"> |
| <h3>current</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/CollectionBackedScanner.html#line-38">current</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="<init>(java.util.SortedSet)"> |
| <h3>CollectionBackedScanner</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/CollectionBackedScanner.html#line-40">CollectionBackedScanner</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/SortedSet.html" title="class or interface in java.util" class="external-link">SortedSet</a><<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>> set)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.util.SortedSet,org.apache.hadoop.hbase.CellComparator)"> |
| <h3>CollectionBackedScanner</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/CollectionBackedScanner.html#line-44">CollectionBackedScanner</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/SortedSet.html" title="class or interface in java.util" class="external-link">SortedSet</a><<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>> set, |
| <a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a> comparator)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.util.List)"> |
| <h3>CollectionBackedScanner</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/CollectionBackedScanner.html#line-50">CollectionBackedScanner</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>> list)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.util.List,org.apache.hadoop.hbase.CellComparator)"> |
| <h3>CollectionBackedScanner</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/CollectionBackedScanner.html#line-54">CollectionBackedScanner</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>> list, |
| <a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a> comparator)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.hbase.CellComparator,org.apache.hadoop.hbase.ExtendedCell...)"> |
| <h3>CollectionBackedScanner</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/CollectionBackedScanner.html#line-61">CollectionBackedScanner</a></span><wbr><span class="parameters">(<a href="../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a> comparator, |
| <a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>... array)</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="init()"> |
| <h3>init</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/CollectionBackedScanner.html#line-71">init</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="peek()"> |
| <h3>peek</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/CollectionBackedScanner.html#line-78">peek</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../regionserver/KeyValueScanner.html#peek()">KeyValueScanner</a></code></span></div> |
| <div class="block">Look at the next Cell in this scanner, but do not iterate scanner. NOTICE: The returned cell |
| has not been passed into ScanQueryMatcher. So it may not be what the user need.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the next Cell</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="next()"> |
| <h3>next</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/CollectionBackedScanner.html#line-83">next</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../regionserver/KeyValueScanner.html#next()">KeyValueScanner</a></code></span></div> |
| <div class="block">Return the next Cell in this scanner, iterating the scanner</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the next Cell</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="seek(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>seek</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/CollectionBackedScanner.html#line-94">seek</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> seekCell)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../regionserver/KeyValueScanner.html#seek(org.apache.hadoop.hbase.ExtendedCell)">KeyValueScanner</a></code></span></div> |
| <div class="block">Seek the scanner at or after the specified KeyValue.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>seekCell</code> - seek value</dd> |
| <dt>Returns:</dt> |
| <dd>true if scanner has values left, false if end of scanner</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reseek(org.apache.hadoop.hbase.ExtendedCell)"> |
| <h3>reseek</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/CollectionBackedScanner.html#line-101">reseek</a></span><wbr><span class="parameters">(<a href="../ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a> seekCell)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../regionserver/KeyValueScanner.html#reseek(org.apache.hadoop.hbase.ExtendedCell)">KeyValueScanner</a></code></span></div> |
| <div class="block">Reseek the scanner at or after the specified KeyValue. This method is guaranteed to seek at or |
| after the required key only if the key comes after the current position of the scanner. Should |
| not be used to seek to a key which may come before the current position.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>seekCell</code> - seek value (should be non-null)</dd> |
| <dt>Returns:</dt> |
| <dd>true if scanner has values left, false if end of scanner</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/util/CollectionBackedScanner.html#line-114">close</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../regionserver/KeyValueScanner.html#close()">KeyValueScanner</a></code></span></div> |
| <div class="block">Close the KeyValue scanner.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
