| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.io.hfile, interface: InlineBlockWriter"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.io.hfile;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.DataOutput;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.IOException;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">023</span><span id="line-23"></span> |
| <span class="source-line-no">024</span><span id="line-24">/**</span> |
| <span class="source-line-no">025</span><span id="line-25"> * A way to write "inline" blocks into an {@link HFile}. Inline blocks are interspersed with data</span> |
| <span class="source-line-no">026</span><span id="line-26"> * blocks. For example, Bloom filter chunks and leaf-level blocks of a multi-level block index are</span> |
| <span class="source-line-no">027</span><span id="line-27"> * stored as inline blocks.</span> |
| <span class="source-line-no">028</span><span id="line-28"> */</span> |
| <span class="source-line-no">029</span><span id="line-29">@InterfaceAudience.Private</span> |
| <span class="source-line-no">030</span><span id="line-30">public interface InlineBlockWriter {</span> |
| <span class="source-line-no">031</span><span id="line-31"></span> |
| <span class="source-line-no">032</span><span id="line-32"> /**</span> |
| <span class="source-line-no">033</span><span id="line-33"> * Determines whether there is a new block to be written out. whether the file is being closed, in</span> |
| <span class="source-line-no">034</span><span id="line-34"> * which case we need to write out all available data and not wait to accumulate another block</span> |
| <span class="source-line-no">035</span><span id="line-35"> */</span> |
| <span class="source-line-no">036</span><span id="line-36"> boolean shouldWriteBlock(boolean closing);</span> |
| <span class="source-line-no">037</span><span id="line-37"></span> |
| <span class="source-line-no">038</span><span id="line-38"> /**</span> |
| <span class="source-line-no">039</span><span id="line-39"> * Writes the block to the provided stream. Must not write any magic records. Called only if</span> |
| <span class="source-line-no">040</span><span id="line-40"> * {@link #shouldWriteBlock(boolean)} returned true. a stream (usually a compressing stream) to</span> |
| <span class="source-line-no">041</span><span id="line-41"> * write the block to</span> |
| <span class="source-line-no">042</span><span id="line-42"> */</span> |
| <span class="source-line-no">043</span><span id="line-43"> void writeInlineBlock(DataOutput out) throws IOException;</span> |
| <span class="source-line-no">044</span><span id="line-44"></span> |
| <span class="source-line-no">045</span><span id="line-45"> /**</span> |
| <span class="source-line-no">046</span><span id="line-46"> * Called after a block has been written, and its offset, raw size, and compressed size have been</span> |
| <span class="source-line-no">047</span><span id="line-47"> * determined. Can be used to add an entry to a block index. If this type of inline blocks needs a</span> |
| <span class="source-line-no">048</span><span id="line-48"> * block index, the inline block writer is responsible for maintaining it.</span> |
| <span class="source-line-no">049</span><span id="line-49"> * @param offset the offset of the block in the stream</span> |
| <span class="source-line-no">050</span><span id="line-50"> * @param onDiskSize the on-disk size of the block</span> |
| <span class="source-line-no">051</span><span id="line-51"> * @param uncompressedSize the uncompressed size of the block</span> |
| <span class="source-line-no">052</span><span id="line-52"> */</span> |
| <span class="source-line-no">053</span><span id="line-53"> void blockWritten(long offset, int onDiskSize, int uncompressedSize);</span> |
| <span class="source-line-no">054</span><span id="line-54"></span> |
| <span class="source-line-no">055</span><span id="line-55"> /**</span> |
| <span class="source-line-no">056</span><span id="line-56"> * The type of blocks this block writer produces.</span> |
| <span class="source-line-no">057</span><span id="line-57"> */</span> |
| <span class="source-line-no">058</span><span id="line-58"> BlockType getInlineBlockType();</span> |
| <span class="source-line-no">059</span><span id="line-59"></span> |
| <span class="source-line-no">060</span><span id="line-60"> /** Returns true if inline blocks produced by this writer should be cached */</span> |
| <span class="source-line-no">061</span><span id="line-61"> boolean getCacheOnWrite();</span> |
| <span class="source-line-no">062</span><span id="line-62">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
