You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by st...@apache.org on 2016/11/08 14:23:53 UTC
[41/51] [partial] hbase-site git commit: Added 1.1
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/8418e382/1.1/apidocs/org/apache/hadoop/hbase/CellScanner.html
----------------------------------------------------------------------
diff --git a/1.1/apidocs/org/apache/hadoop/hbase/CellScanner.html b/1.1/apidocs/org/apache/hadoop/hbase/CellScanner.html
new file mode 100644
index 0000000..4d1a741
--- /dev/null
+++ b/1.1/apidocs/org/apache/hadoop/hbase/CellScanner.html
@@ -0,0 +1,261 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc (version 1.7.0_80) on Tue Nov 08 06:02:57 PST 2016 -->
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>CellScanner (Apache HBase 1.1.7 API)</title>
+<meta name="date" content="2016-11-08">
+<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
+</head>
+<body>
+<script type="text/javascript"><!--
+ if (location.href.indexOf('is-external=true') == -1) {
+ parent.document.title="CellScanner (Apache HBase 1.1.7 API)";
+ }
+//-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a name="navbar_top">
+<!-- -->
+</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/CellScanner.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">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/hadoop/hbase/CellScannable.html" title="interface in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/hadoop/hbase/CellUtil.html" title="class in org.apache.hadoop.hbase"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/hadoop/hbase/CellScanner.html" target="_top">Frames</a></li>
+<li><a href="CellScanner.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_top");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_top">
+<!-- -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+<!-- ======== START OF CLASS DATA ======== -->
+<div class="header">
+<div class="subTitle">org.apache.hadoop.hbase</div>
+<h2 title="Interface CellScanner" class="title">Interface CellScanner</h2>
+</div>
+<div class="contentContainer">
+<div class="description">
+<ul class="blockList">
+<li class="blockList">
+<dl>
+<dt>All Known Subinterfaces:</dt>
+<dd><a href="../../../../org/apache/hadoop/hbase/codec/prefixtree/scanner/CellSearcher.html" title="interface in org.apache.hadoop.hbase.codec.prefixtree.scanner">CellSearcher</a>, <a href="../../../../org/apache/hadoop/hbase/codec/Codec.Decoder.html" title="interface in org.apache.hadoop.hbase.codec">Codec.Decoder</a>, <a href="../../../../org/apache/hadoop/hbase/codec/prefixtree/scanner/ReversibleCellScanner.html" title="interface in org.apache.hadoop.hbase.codec.prefixtree.scanner">ReversibleCellScanner</a>, <a href="../../../../org/apache/hadoop/hbase/io/SizedCellScanner.html" title="interface in org.apache.hadoop.hbase.io">SizedCellScanner</a></dd>
+</dl>
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../../org/apache/hadoop/hbase/codec/BaseDecoder.html" title="class in org.apache.hadoop.hbase.codec">BaseDecoder</a>, <a href="../../../../org/apache/hadoop/hbase/codec/KeyValueCodec.KeyValueDecoder.html" title="class in org.apache.hadoop.hbase.codec">KeyValueCodec.KeyValueDecoder</a>, <a href="../../../../org/apache/hadoop/hbase/codec/KeyValueCodecWithTags.KeyValueDecoder.html" title="class in org.apache.hadoop.hbase.codec">KeyValueCodecWithTags.KeyValueDecoder</a>, <a href="../../../../org/apache/hadoop/hbase/codec/prefixtree/decode/PrefixTreeArrayReversibleScanner.html" title="class in org.apache.hadoop.hbase.codec.prefixtree.decode">PrefixTreeArrayReversibleScanner</a>, <a href="../../../../org/apache/hadoop/hbase/codec/prefixtree/decode/PrefixTreeArrayScanner.html" title="class in org.apache.hadoop.hbase.codec.prefixtree.decode">PrefixTreeArrayScanner</a>, <a href="../../../../org/apache/hadoop/hbase/codec/prefixtree/decode/PrefixTreeArraySearcher.html" title
="class in org.apache.hadoop.hbase.codec.prefixtree.decode">PrefixTreeArraySearcher</a>, <a href="../../../../org/apache/hadoop/hbase/client/Result.html" title="class in org.apache.hadoop.hbase.client">Result</a></dd>
+</dl>
+<hr>
+<br>
+<pre><a href="../../../../org/apache/hadoop/hbase/classification/InterfaceAudience.Private.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceAudience.Private</a>
+<a href="../../../../org/apache/hadoop/hbase/classification/InterfaceStability.Unstable.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceStability.Unstable</a>
+public interface <span class="strong">CellScanner</span></pre>
+<div class="block">An interface for iterating through a sequence of cells. Similar to Java's Iterator, but without
+ the hasNext() or remove() methods. The hasNext() method is problematic because it may require
+ actually loading the next object, which in turn requires storing the previous object somewhere.
+
+ <p>The core data block decoder should be as fast as possible, so we push the complexity and
+ performance expense of concurrently tracking multiple cells to layers above the CellScanner.
+ <p>
+ The <a href="../../../../org/apache/hadoop/hbase/CellScanner.html#current()"><code>current()</code></a> method will return a reference to a Cell implementation. This reference
+ may or may not point to a reusable cell implementation, so users of the CellScanner should not,
+ for example, accumulate a List of Cells. All of the references may point to the same object,
+ which would be the latest state of the underlying Cell. In short, the Cell is mutable.
+ <p/>
+ Typical usage:
+
+ <pre>
+ while (scanner.advance()) {
+ Cell cell = scanner.current();
+ // do something
+ }
+ </pre>
+ <p>Often used reading <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase"><code>Cell</code></a>s written by
+ <a href="../../../../org/apache/hadoop/hbase/io/CellOutputStream.html" title="interface in org.apache.hadoop.hbase.io"><code>CellOutputStream</code></a>.</div>
+</li>
+</ul>
+</div>
+<div class="summary">
+<ul class="blockList">
+<li class="blockList">
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/CellScanner.html#advance()">advance</a></strong>()</code>
+<div class="block">Advance the scanner 1 cell.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/CellScanner.html#current()">current</a></strong>()</code> </td>
+</tr>
+</table>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="details">
+<ul class="blockList">
+<li class="blockList">
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="current()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>current</h4>
+<pre><a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> current()</pre>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the current Cell which may be mutable</dd></dl>
+</li>
+</ul>
+<a name="advance()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>advance</h4>
+<pre>boolean advance()
+ throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
+<div class="block">Advance the scanner 1 cell.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>true if the next cell is found and <a href="../../../../org/apache/hadoop/hbase/CellScanner.html#current()"><code>current()</code></a> will return a valid Cell</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+</div>
+<!-- ========= END OF CLASS DATA ========= -->
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a name="navbar_bottom">
+<!-- -->
+</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
+<!-- -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="../../../../overview-summary.html">Overview</a></li>
+<li><a href="package-summary.html">Package</a></li>
+<li class="navBarCell1Rev">Class</li>
+<li><a href="class-use/CellScanner.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">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/hadoop/hbase/CellScannable.html" title="interface in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/hadoop/hbase/CellUtil.html" title="class in org.apache.hadoop.hbase"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/hadoop/hbase/CellScanner.html" target="_top">Frames</a></li>
+<li><a href="CellScanner.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li>Constr | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright © 2007-2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
+</body>
+</html>