hbase-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mi...@apache.org
Subject [33/51] [partial] hbase-site git commit: Published site at cadfb21f4bb465d1e305db2a159b8574282c8150.
Date Wed, 23 Mar 2016 15:18:15 GMT
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/123539c5/devapidocs/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html
----------------------------------------------------------------------
diff --git a/devapidocs/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html b/devapidocs/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html
index 0ab9f9f..4d4e170 100644
--- a/devapidocs/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html
+++ b/devapidocs/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html
@@ -99,7 +99,7 @@
 </dl>
 <hr>
 <br>
-<pre>static class <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.html#line.822">HFileBlock.Writer</a>
+<pre>static class <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.html#line.797">HFileBlock.Writer</a>
 extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"
title="class or interface in java.lang">Object</a></pre>
 <div class="block">Unified version 2 <a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFile.html"
title="class in org.apache.hadoop.hbase.io.hfile"><code>HFile</code></a>
block writer. The intended usage pattern
  is as follows:
@@ -152,8 +152,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <tr class="altColor">
 <td class="colFirst"><code>private <a href="../../../../../../org/apache/hadoop/hbase/io/ByteArrayOutputStream.html"
title="class in org.apache.hadoop.hbase.io">ByteArrayOutputStream</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#baosInMemory">baosInMemory</a></strong></code>
-<div class="block">The stream we use to accumulate data in uncompressed format for
each
- block.</div>
+<div class="block">The stream we use to accumulate data into a block in an uncompressed
format.</div>
 </td>
 </tr>
 <tr class="rowColor">
@@ -186,7 +185,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>private byte[]</code></td>
-<td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#onDiskBytesWithHeader">onDiskBytesWithHeader</a></strong></code>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#onDiskBlockBytesWithHeader">onDiskBlockBytesWithHeader</a></strong></code>
 <div class="block">Bytes to be written to the file system, including the header.</div>
 </td>
 </tr>
@@ -222,7 +221,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>private byte[]</code></td>
-<td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#uncompressedBytesWithHeader">uncompressedBytesWithHeader</a></strong></code>
+<td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#uncompressedBlockBytesWithHeader">uncompressedBlockBytesWithHeader</a></strong></code>
 <div class="block">Valid in the READY state.</div>
 </td>
 </tr>
@@ -291,9 +290,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <tr class="rowColor">
 <td class="colFirst"><code>private void</code></td>
 <td class="colLast"><code><strong><a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#finishBlock()">finishBlock</a></strong>()</code>
-<div class="block">An internal method that flushes the compressing stream (if using
- compression), serializes the header, and takes care of the separate
- uncompressed stream for caching on write, if applicable.</div>
+<div class="block">Finish up writing of the block.</div>
 </td>
 </tr>
 <tr class="altColor">
@@ -436,7 +433,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>state</h4>
-<pre>private&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.State.html"
title="enum in org.apache.hadoop.hbase.io.hfile">HFileBlock.Writer.State</a> <a
href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.830">state</a></pre>
+<pre>private&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.State.html"
title="enum in org.apache.hadoop.hbase.io.hfile">HFileBlock.Writer.State</a> <a
href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.805">state</a></pre>
 <div class="block">Writer state. Used to ensure the correct usage protocol.</div>
 </li>
 </ul>
@@ -446,7 +443,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>dataBlockEncoder</h4>
-<pre>private final&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileDataBlockEncoder.html"
title="interface in org.apache.hadoop.hbase.io.hfile">HFileDataBlockEncoder</a> <a
href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.833">dataBlockEncoder</a></pre>
+<pre>private final&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileDataBlockEncoder.html"
title="interface in org.apache.hadoop.hbase.io.hfile">HFileDataBlockEncoder</a> <a
href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.808">dataBlockEncoder</a></pre>
 <div class="block">Data block encoder used for data blocks</div>
 </li>
 </ul>
@@ -456,7 +453,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>dataBlockEncodingCtx</h4>
-<pre>private&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/io/encoding/HFileBlockEncodingContext.html"
title="interface in org.apache.hadoop.hbase.io.encoding">HFileBlockEncodingContext</a>
<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.835">dataBlockEncodingCtx</a></pre>
+<pre>private&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/io/encoding/HFileBlockEncodingContext.html"
title="interface in org.apache.hadoop.hbase.io.encoding">HFileBlockEncodingContext</a>
<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.810">dataBlockEncodingCtx</a></pre>
 </li>
 </ul>
 <a name="defaultBlockEncodingCtx">
@@ -465,7 +462,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>defaultBlockEncodingCtx</h4>
-<pre>private&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/io/encoding/HFileBlockDefaultEncodingContext.html"
title="class in org.apache.hadoop.hbase.io.encoding">HFileBlockDefaultEncodingContext</a>
<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.838">defaultBlockEncodingCtx</a></pre>
+<pre>private&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/io/encoding/HFileBlockDefaultEncodingContext.html"
title="class in org.apache.hadoop.hbase.io.encoding">HFileBlockDefaultEncodingContext</a>
<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.813">defaultBlockEncodingCtx</a></pre>
 <div class="block">block encoding context for non-data blocks</div>
 </li>
 </ul>
@@ -475,9 +472,9 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>baosInMemory</h4>
-<pre>private&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/io/ByteArrayOutputStream.html"
title="class in org.apache.hadoop.hbase.io">ByteArrayOutputStream</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.846">baosInMemory</a></pre>
-<div class="block">The stream we use to accumulate data in uncompressed format for
each
- block. We reset this stream at the end of each block and reuse it. The
+<pre>private&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/io/ByteArrayOutputStream.html"
title="class in org.apache.hadoop.hbase.io">ByteArrayOutputStream</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.821">baosInMemory</a></pre>
+<div class="block">The stream we use to accumulate data into a block in an uncompressed
format.
+ We reset this stream at the end of each block and reuse it. The
  header is written as the first <a href="../../../../../../org/apache/hadoop/hbase/HConstants.html#HFILEBLOCK_HEADER_SIZE"><code>HConstants.HFILEBLOCK_HEADER_SIZE</code></a>
bytes into this
  stream.</div>
 </li>
@@ -488,7 +485,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>blockType</h4>
-<pre>private&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/io/hfile/BlockType.html"
title="enum in org.apache.hadoop.hbase.io.hfile">BlockType</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.853">blockType</a></pre>
+<pre>private&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/io/hfile/BlockType.html"
title="enum in org.apache.hadoop.hbase.io.hfile">BlockType</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.828">blockType</a></pre>
 <div class="block">Current block type. Set in <a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#startWriting(org.apache.hadoop.hbase.io.hfile.BlockType)"><code>startWriting(BlockType)</code></a>.
Could be
  changed in <a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#finishBlock()"><code>finishBlock()</code></a>
from <a href="../../../../../../org/apache/hadoop/hbase/io/hfile/BlockType.html#DATA"><code>BlockType.DATA</code></a>
  to <a href="../../../../../../org/apache/hadoop/hbase/io/hfile/BlockType.html#ENCODED_DATA"><code>BlockType.ENCODED_DATA</code></a>.</div>
@@ -500,7 +497,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>userDataStream</h4>
-<pre>private&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/io/DataOutputStream.html?is-external=true"
title="class or interface in java.io">DataOutputStream</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.859">userDataStream</a></pre>
+<pre>private&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/io/DataOutputStream.html?is-external=true"
title="class or interface in java.io">DataOutputStream</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.834">userDataStream</a></pre>
 <div class="block">A stream that we write uncompressed bytes to, which compresses them
and
  writes them to <a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#baosInMemory"><code>baosInMemory</code></a>.</div>
 </li>
@@ -511,16 +508,16 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>unencodedDataSizeWritten</h4>
-<pre>private&nbsp;int <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.863">unencodedDataSizeWritten</a></pre>
+<pre>private&nbsp;int <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.838">unencodedDataSizeWritten</a></pre>
 </li>
 </ul>
-<a name="onDiskBytesWithHeader">
+<a name="onDiskBlockBytesWithHeader">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
-<h4>onDiskBytesWithHeader</h4>
-<pre>private&nbsp;byte[] <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.870">onDiskBytesWithHeader</a></pre>
+<h4>onDiskBlockBytesWithHeader</h4>
+<pre>private&nbsp;byte[] <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.845">onDiskBlockBytesWithHeader</a></pre>
 <div class="block">Bytes to be written to the file system, including the header. Compressed
  if compression is turned on. It also includes the checksum data that
  immediately follows the block data. (header + data + checksums)</div>
@@ -532,20 +529,20 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>onDiskChecksum</h4>
-<pre>private&nbsp;byte[] <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.878">onDiskChecksum</a></pre>
+<pre>private&nbsp;byte[] <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.853">onDiskChecksum</a></pre>
 <div class="block">The size of the checksum data on disk. It is used only if data is
  not compressed. If data is compressed, then the checksums are already
  part of onDiskBytesWithHeader. If data is uncompressed, then this
  variable stores the checksum data for this block.</div>
 </li>
 </ul>
-<a name="uncompressedBytesWithHeader">
+<a name="uncompressedBlockBytesWithHeader">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
-<h4>uncompressedBytesWithHeader</h4>
-<pre>private&nbsp;byte[] <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.887">uncompressedBytesWithHeader</a></pre>
+<h4>uncompressedBlockBytesWithHeader</h4>
+<pre>private&nbsp;byte[] <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.862">uncompressedBlockBytesWithHeader</a></pre>
 <div class="block">Valid in the READY state. Contains the header and the uncompressed
(but
  potentially encoded, if this is a data block) bytes, so the length is
  <a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.html#uncompressedSizeWithoutHeader"><code>HFileBlock.uncompressedSizeWithoutHeader</code></a>
+
@@ -559,7 +556,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>startOffset</h4>
-<pre>private&nbsp;long <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.893">startOffset</a></pre>
+<pre>private&nbsp;long <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.868">startOffset</a></pre>
 <div class="block">Current block's start offset in the <a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFile.html"
title="class in org.apache.hadoop.hbase.io.hfile"><code>HFile</code></a>.
Set in
  <a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#writeHeaderAndData(org.apache.hadoop.fs.FSDataOutputStream)"><code>writeHeaderAndData(FSDataOutputStream)</code></a>.</div>
 </li>
@@ -570,7 +567,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>prevOffsetByType</h4>
-<pre>private&nbsp;long[] <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.899">prevOffsetByType</a></pre>
+<pre>private&nbsp;long[] <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.874">prevOffsetByType</a></pre>
 <div class="block">Offset of previous block by block type. Updated when the next block
is
  started.</div>
 </li>
@@ -581,7 +578,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>prevOffset</h4>
-<pre>private&nbsp;long <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.902">prevOffset</a></pre>
+<pre>private&nbsp;long <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.877">prevOffset</a></pre>
 <div class="block">The offset of the previous block of the same type</div>
 </li>
 </ul>
@@ -591,7 +588,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockListLast">
 <li class="blockList">
 <h4>fileContext</h4>
-<pre>private&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileContext.html"
title="class in org.apache.hadoop.hbase.io.hfile">HFileContext</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.904">fileContext</a></pre>
+<pre>private&nbsp;<a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileContext.html"
title="class in org.apache.hadoop.hbase.io.hfile">HFileContext</a> <a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.879">fileContext</a></pre>
 <div class="block">Meta data that holds information about the hfileblock</div>
 </li>
 </ul>
@@ -609,7 +606,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockListLast">
 <li class="blockList">
 <h4>HFileBlock.Writer</h4>
-<pre>public&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.909">HFileBlock.Writer</a>(<a
href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileDataBlockEncoder.html" title="interface
in org.apache.hadoop.hbase.io.hfile">HFileDataBlockEncoder</a>&nbsp;dataBlockEncoder,
+<pre>public&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.884">HFileBlock.Writer</a>(<a
href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileDataBlockEncoder.html" title="interface
in org.apache.hadoop.hbase.io.hfile">HFileDataBlockEncoder</a>&nbsp;dataBlockEncoder,
                  <a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileContext.html"
title="class in org.apache.hadoop.hbase.io.hfile">HFileContext</a>&nbsp;fileContext)</pre>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>dataBlockEncoder</code>
- data block encoding algorithm to use</dd></dl>
 </li>
@@ -628,7 +625,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>startWriting</h4>
-<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/io/DataOutputStream.html?is-external=true"
title="class or interface in java.io">DataOutputStream</a>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.939">startWriting</a>(<a
href="../../../../../../org/apache/hadoop/hbase/io/hfile/BlockType.html" title="enum in org.apache.hadoop.hbase.io.hfile">BlockType</a>&nbsp;newBlockType)
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/io/DataOutputStream.html?is-external=true"
title="class or interface in java.io">DataOutputStream</a>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.914">startWriting</a>(<a
href="../../../../../../org/apache/hadoop/hbase/io/hfile/BlockType.html" title="enum in org.apache.hadoop.hbase.io.hfile">BlockType</a>&nbsp;newBlockType)
                         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">Starts writing into the block. The previous block's data is discarded.</div>
 <dl><dt><span class="strong">Returns:</span></dt><dd>the
stream the user can write their data into</dd>
@@ -642,7 +639,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>write</h4>
-<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.969">write</a>(<a
href="../../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>&nbsp;cell)
+<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.944">write</a>(<a
href="../../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>&nbsp;cell)
      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">Writes the Cell to this block</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code>
- </dd>
@@ -656,7 +653,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>getUserDataStream</h4>
-<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/io/DataOutputStream.html?is-external=true"
title="class or interface in java.io">DataOutputStream</a>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.982">getUserDataStream</a>()</pre>
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/io/DataOutputStream.html?is-external=true"
title="class or interface in java.io">DataOutputStream</a>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.957">getUserDataStream</a>()</pre>
 <div class="block">Returns the stream for the user to write to. The block writer takes
care
  of handling compression and buffering for caching on write. Can only be
  called in the "writing" state.</div>
@@ -669,7 +666,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>ensureBlockReady</h4>
-<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.991">ensureBlockReady</a>()
+<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.966">ensureBlockReady</a>()
                 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">Transitions the block writer from the "writing" state to the "block
  ready" state.  Does nothing if a block is already finished.</div>
@@ -683,12 +680,12 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>finishBlock</h4>
-<pre>private&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1008">finishBlock</a>()
+<pre>private&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.984">finishBlock</a>()
                   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">An internal method that flushes the compressing stream (if using
- compression), serializes the header, and takes care of the separate
- uncompressed stream for caching on write, if applicable. Sets block
- write state to "block ready".</div>
+<div class="block">Finish up writing of the block.
+ Flushes the compressing stream (if using compression), fills out the header,
+ does any compression/encryption of bytes to flush out to disk, and manages
+ the cache on write content, if applicable. Sets block write state to "block ready".</div>
 <dl><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>
@@ -699,7 +696,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>putHeader</h4>
-<pre>private&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1061">putHeader</a>(byte[]&nbsp;dest,
+<pre>private&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1036">putHeader</a>(byte[]&nbsp;dest,
              int&nbsp;offset,
              int&nbsp;onDiskSize,
              int&nbsp;uncompressedSize,
@@ -716,7 +713,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>writeHeaderAndData</h4>
-<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1080">writeHeaderAndData</a>(org.apache.hadoop.fs.FSDataOutputStream&nbsp;out)
+<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1055">writeHeaderAndData</a>(org.apache.hadoop.fs.FSDataOutputStream&nbsp;out)
                   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">Similar to <a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#writeHeaderAndData(org.apache.hadoop.fs.FSDataOutputStream)"><code>writeHeaderAndData(FSDataOutputStream)</code></a>,
but records
  the offset of this block so that it can be referenced in the next block
@@ -732,7 +729,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>finishBlockAndWriteHeaderAndData</h4>
-<pre>protected&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1101">finishBlockAndWriteHeaderAndData</a>(<a
href="http://docs.oracle.com/javase/7/docs/api/java/io/DataOutputStream.html?is-external=true"
title="class or interface in java.io">DataOutputStream</a>&nbsp;out)
+<pre>protected&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1076">finishBlockAndWriteHeaderAndData</a>(<a
href="http://docs.oracle.com/javase/7/docs/api/java/io/DataOutputStream.html?is-external=true"
title="class or interface in java.io">DataOutputStream</a>&nbsp;out)
                                          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">Writes the header and the compressed data of this block (or uncompressed
  data when not using compression) into the given stream. Can be called in
@@ -749,7 +746,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>getHeaderAndDataForTest</h4>
-<pre>byte[]&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1118">getHeaderAndDataForTest</a>()
+<pre>byte[]&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1093">getHeaderAndDataForTest</a>()
                          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">Returns the header or the compressed data (or uncompressed data
when not
  using compression) as a byte array. Can be called in the "writing" state
@@ -767,7 +764,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>release</h4>
-<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1135">release</a>()</pre>
+<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1110">release</a>()</pre>
 <div class="block">Releases resources used by this writer.</div>
 </li>
 </ul>
@@ -777,7 +774,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>getOnDiskSizeWithoutHeader</h4>
-<pre>int&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1154">getOnDiskSizeWithoutHeader</a>()</pre>
+<pre>int&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1129">getOnDiskSizeWithoutHeader</a>()</pre>
 <div class="block">Returns the on-disk size of the data portion of the block. This
is the
  compressed size if compression is enabled. Can only be called in the
  "block ready" state. Header is not compressed, and its size is not
@@ -791,7 +788,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>getOnDiskSizeWithHeader</h4>
-<pre>int&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1167">getOnDiskSizeWithHeader</a>()</pre>
+<pre>int&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1142">getOnDiskSizeWithHeader</a>()</pre>
 <div class="block">Returns the on-disk size of the block. Can only be called in the
  "block ready" state.</div>
 <dl><dt><span class="strong">Returns:</span></dt><dd>the
on-disk size of the block ready to be written, including the
@@ -804,7 +801,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>getUncompressedSizeWithoutHeader</h4>
-<pre>int&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1175">getUncompressedSizeWithoutHeader</a>()</pre>
+<pre>int&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1150">getUncompressedSizeWithoutHeader</a>()</pre>
 <div class="block">The uncompressed size of the block data. Does not include header
size.</div>
 </li>
 </ul>
@@ -814,7 +811,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>getUncompressedSizeWithHeader</h4>
-<pre>int&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1183">getUncompressedSizeWithHeader</a>()</pre>
+<pre>int&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1158">getUncompressedSizeWithHeader</a>()</pre>
 <div class="block">The uncompressed size of the block data, including header size.</div>
 </li>
 </ul>
@@ -824,7 +821,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>isWriting</h4>
-<pre>boolean&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1189">isWriting</a>()</pre>
+<pre>boolean&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1164">isWriting</a>()</pre>
 <dl><dt><span class="strong">Returns:</span></dt><dd>true
if a block is being written</dd></dl>
 </li>
 </ul>
@@ -834,7 +831,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>blockSizeWritten</h4>
-<pre>int&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1200">blockSizeWritten</a>()</pre>
+<pre>int&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1175">blockSizeWritten</a>()</pre>
 <div class="block">Returns the number of bytes written into the current block so far,
or
  zero if not writing the block at the moment. Note that this will return
  zero in the "block ready" state as well.</div>
@@ -847,7 +844,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>getUncompressedBufferWithHeader</h4>
-<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true"
title="class or interface in java.nio">ByteBuffer</a>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1213">getUncompressedBufferWithHeader</a>()</pre>
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true"
title="class or interface in java.nio">ByteBuffer</a>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1188">getUncompressedBufferWithHeader</a>()</pre>
 <div class="block">Returns the header followed by the uncompressed data, even if using
  compression. This is needed for storing uncompressed blocks in the block
  cache. Can be called in the "writing" state or the "block ready" state.
@@ -861,7 +858,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>getOnDiskBufferWithHeader</h4>
-<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true"
title="class or interface in java.nio">ByteBuffer</a>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1226">getOnDiskBufferWithHeader</a>()</pre>
+<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true"
title="class or interface in java.nio">ByteBuffer</a>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1201">getOnDiskBufferWithHeader</a>()</pre>
 <div class="block">Returns the header followed by the on-disk (compressed/encoded/encrypted)
data. This is
  needed for storing packed blocks in the block cache. Expects calling semantics identical
to
  <a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#getUncompressedBufferWithHeader()"><code>getUncompressedBufferWithHeader()</code></a>.
Returns only the header and data,
@@ -875,7 +872,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>expectState</h4>
-<pre>private&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1231">expectState</a>(<a
href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.State.html" title="enum
in org.apache.hadoop.hbase.io.hfile">HFileBlock.Writer.State</a>&nbsp;expectedState)</pre>
+<pre>private&nbsp;void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1206">expectState</a>(<a
href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.State.html" title="enum
in org.apache.hadoop.hbase.io.hfile">HFileBlock.Writer.State</a>&nbsp;expectedState)</pre>
 </li>
 </ul>
 <a name="writeBlock(org.apache.hadoop.hbase.io.hfile.HFileBlock.BlockWritable, org.apache.hadoop.fs.FSDataOutputStream)">
@@ -884,7 +881,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockList">
 <li class="blockList">
 <h4>writeBlock</h4>
-<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1248">writeBlock</a>(<a
href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.BlockWritable.html" title="interface
in org.apache.hadoop.hbase.io.hfile">HFileBlock.BlockWritable</a>&nbsp;bw,
+<pre>void&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1223">writeBlock</a>(<a
href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.BlockWritable.html" title="interface
in org.apache.hadoop.hbase.io.hfile">HFileBlock.BlockWritable</a>&nbsp;bw,
               org.apache.hadoop.fs.FSDataOutputStream&nbsp;out)
           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">Takes the given <a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.BlockWritable.html"
title="interface in org.apache.hadoop.hbase.io.hfile"><code>HFileBlock.BlockWritable</code></a>
instance, creates a new block of
@@ -902,12 +899,16 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?
 <ul class="blockListLast">
 <li class="blockList">
 <h4>getBlockForCaching</h4>
-<pre><a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.html"
title="class in org.apache.hadoop.hbase.io.hfile">HFileBlock</a>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1261">getBlockForCaching</a>(<a
href="../../../../../../org/apache/hadoop/hbase/io/hfile/CacheConfig.html" title="class in
org.apache.hadoop.hbase.io.hfile">CacheConfig</a>&nbsp;cacheConf)</pre>
+<pre><a href="../../../../../../org/apache/hadoop/hbase/io/hfile/HFileBlock.html"
title="class in org.apache.hadoop.hbase.io.hfile">HFileBlock</a>&nbsp;<a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/HFileBlock.Writer.html#line.1240">getBlockForCaching</a>(<a
href="../../../../../../org/apache/hadoop/hbase/io/hfile/CacheConfig.html" title="class in
org.apache.hadoop.hbase.io.hfile">CacheConfig</a>&nbsp;cacheConf)</pre>
 <div class="block">Creates a new HFileBlock. Checksums have already been validated,
so
  the byte buffer passed into the constructor of this newly created
  block does not have checksum data even though the header minor
  version is MINOR_VERSION_WITH_CHECKSUM. This is indicated by setting a
- 0 value in bytesPerChecksum.</div>
+ 0 value in bytesPerChecksum.
+
+ <p>TODO: Should there be an option where a cache can ask that hbase preserve block
+ checksums for checking after a block comes out of the cache? Otehrwise, cache is responsible
+ for blocks being wholesome (ECC memory or if file-backed, it does checksumming).</div>
 </li>
 </ul>
 </li>


Mime
View raw message