| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>FixedFileTrailer (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase.io.hfile, class: FixedFileTrailer"> |
| <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/FixedFileTrailer.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.io.hfile</a></div> |
| <h1 title="Class FixedFileTrailer" class="title">Class FixedFileTrailer</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">org.apache.hadoop.hbase.io.hfile.FixedFileTrailer</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-51">FixedFileTrailer</a></span> |
| <span class="extends-implements">extends <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></span></div> |
| <div class="block">The <a href="HFile.html" title="class in org.apache.hadoop.hbase.io.hfile"><code>HFile</code></a> has a fixed trailer which contains offsets to other variable parts of the file. |
| Also includes basic metadata on this file. The trailer size is fixed within a given <a href="HFile.html" title="class in org.apache.hadoop.hbase.io.hfile"><code>HFile</code></a> |
| format version only, but we always store the version number as the last four-byte integer of the |
| file. The version number itself is split into two portions, a major version and a minor version. |
| The last three bytes of a file are the major version and a single preceding byte is the minor |
| number. The major version determines which readers/writers to use to read/write a hfile while a |
| minor version determines smaller changes in hfile format that do not need a new reader/writer |
| type.</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>private <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#comparatorClassName" class="member-name-link">comparatorClassName</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Raw key comparator class name in version 3</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private <a href="../compress/Compression.Algorithm.html" title="enum class in org.apache.hadoop.hbase.io.compress">Compression.Algorithm</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#compressionCodec" class="member-name-link">compressionCodec</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The compression codec used for all blocks.</div> |
| </div> |
| <div class="col-first even-row-color"><code>private int</code></div> |
| <div class="col-second even-row-color"><code><a href="#dataIndexCount" class="member-name-link">dataIndexCount</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The number of entries in the root data index.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private byte[]</code></div> |
| <div class="col-second odd-row-color"><code><a href="#encryptionKey" class="member-name-link">encryptionKey</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The encryption key</div> |
| </div> |
| <div class="col-first even-row-color"><code>private long</code></div> |
| <div class="col-second even-row-color"><code><a href="#entryCount" class="member-name-link">entryCount</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The number of key/value pairs in the file.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#fileInfoOffset" class="member-name-link">fileInfoOffset</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Offset to the fileinfo data, a small block of vitals.</div> |
| </div> |
| <div class="col-first even-row-color"><code>private long</code></div> |
| <div class="col-second even-row-color"><code><a href="#firstDataBlockOffset" class="member-name-link">firstDataBlockOffset</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The offset of the first data block.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#lastDataBlockOffset" class="member-name-link">lastDataBlockOffset</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">It is guaranteed that no key/value data blocks start after this offset in the file.</div> |
| </div> |
| <div class="col-first even-row-color"><code>private long</code></div> |
| <div class="col-second even-row-color"><code><a href="#loadOnOpenDataOffset" class="member-name-link">loadOnOpenDataOffset</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">In version 1, the offset to the data block index.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private static final org.slf4j.Logger</code></div> |
| <div class="col-second odd-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#majorVersion" class="member-name-link">majorVersion</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The <a href="HFile.html" title="class in org.apache.hadoop.hbase.io.hfile"><code>HFile</code></a> format major version.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#MAX_COMPARATOR_NAME_LENGTH" class="member-name-link">MAX_COMPARATOR_NAME_LENGTH</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">We store the comparator class name as a fixed-length field in the trailer.</div> |
| </div> |
| <div class="col-first even-row-color"><code>private static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#MAX_TRAILER_SIZE" class="member-name-link">MAX_TRAILER_SIZE</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#metaIndexCount" class="member-name-link">metaIndexCount</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The number of entries in the meta index</div> |
| </div> |
| <div class="col-first even-row-color"><code>private final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#minorVersion" class="member-name-link">minorVersion</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The <a href="HFile.html" title="class in org.apache.hadoop.hbase.io.hfile"><code>HFile</code></a> format minor version.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#NOT_PB_SIZE" class="member-name-link">NOT_PB_SIZE</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private int</code></div> |
| <div class="col-second even-row-color"><code><a href="#numDataIndexLevels" class="member-name-link">numDataIndexLevels</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The number of levels in the potentially multi-level data index.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#totalUncompressedBytes" class="member-name-link">totalUncompressedBytes</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">The total uncompressed size of keys/values stored in the file.</div> |
| </div> |
| <div class="col-first even-row-color"><code>private static final int[]</code></div> |
| <div class="col-second even-row-color"><code><a href="#TRAILER_SIZE" class="member-name-link">TRAILER_SIZE</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#uncompressedDataIndexSize" class="member-name-link">uncompressedDataIndexSize</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Total uncompressed size of all blocks of the data index</div> |
| </div> |
| </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(int,int)" class="member-name-link">FixedFileTrailer</a><wbr>(int majorVersion, |
| int minorVersion)</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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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>private void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#append(java.lang.StringBuilder,java.lang.String)" class="member-name-link">append</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> sb, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static int[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#computeTrailerSizeByVersion()" class="member-name-link">computeTrailerSizeByVersion</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) <a href="../../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createComparator()" class="member-name-link">createComparator</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static <a href="../../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createComparator(java.lang.String)" class="member-name-link">createComparator</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> comparatorClassName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deserialize(java.io.DataInputStream)" class="member-name-link">deserialize</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataInputStream.html" title="class or interface in java.io" class="external-link">DataInputStream</a> inputStream)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Deserialize the fixed file trailer from the given stream.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package 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="#deserializeFromPB(java.io.DataInputStream)" class="member-name-link">deserializeFromPB</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataInputStream.html" title="class or interface in java.io" class="external-link">DataInputStream</a> inputStream)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Deserialize the file trailer as protobuf</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#deserializeFromWritable(java.io.DataInput)" class="member-name-link">deserializeFromWritable</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataInput.html" title="class or interface in java.io" class="external-link">DataInput</a> input)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Deserialize the file trailer as writable data</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#expectAtLeastMajorVersion(int)" class="member-name-link">expectAtLeastMajorVersion</a><wbr>(int lowerBound)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#expectMajorVersion(int)" class="member-name-link">expectMajorVersion</a><wbr>(int expected)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#expectMinorVersion(int)" class="member-name-link">expectMinorVersion</a><wbr>(int expected)</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-tab1 method-summary-table-tab4"><code>private static int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#extractMajorVersion(int)" class="member-name-link">extractMajorVersion</a><wbr>(int serializedVersion)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Extracts the major version for a 4-byte serialized version data.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#extractMinorVersion(int)" class="member-name-link">extractMinorVersion</a><wbr>(int serializedVersion)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Extracts the minor version for a 4-byte serialized version data.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="../../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getComparatorClass(java.lang.String)" class="member-name-link">getComparatorClass</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> comparatorClassName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getComparatorClassName()" class="member-name-link">getComparatorClassName</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="../compress/Compression.Algorithm.html" title="enum class in org.apache.hadoop.hbase.io.compress">Compression.Algorithm</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCompressionCodec()" class="member-name-link">getCompressionCodec</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDataIndexCount()" class="member-name-link">getDataIndexCount</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>byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEncryptionKey()" class="member-name-link">getEncryptionKey</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEntryCount()" class="member-name-link">getEntryCount</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>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFileInfoOffset()" class="member-name-link">getFileInfoOffset</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFirstDataBlockOffset()" class="member-name-link">getFirstDataBlockOffset</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>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLastDataBlockOffset()" class="member-name-link">getLastDataBlockOffset</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLoadOnOpenDataOffset()" class="member-name-link">getLoadOnOpenDataOffset</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>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMajorVersion()" class="member-name-link">getMajorVersion</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the major version of this HFile format</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getMaxTrailerSize()" class="member-name-link">getMaxTrailerSize</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMetaIndexCount()" class="member-name-link">getMetaIndexCount</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMinorVersion()" class="member-name-link">getMinorVersion</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the minor version of this HFile format</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNumDataIndexLevels()" class="member-name-link">getNumDataIndexLevels</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTotalUncompressedBytes()" class="member-name-link">getTotalUncompressedBytes</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>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTrailerSize()" class="member-name-link">getTrailerSize</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getTrailerSize(int)" class="member-name-link">getTrailerSize</a><wbr>(int version)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getUncompressedDataIndexSize()" class="member-name-link">getUncompressedDataIndexSize</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#materializeVersion(int,int)" class="member-name-link">materializeVersion</a><wbr>(int majorVersion, |
| int minorVersion)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Create a 4 byte serialized version number by combining the minor and major version numbers.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FixedFileTrailer.html" title="class in org.apache.hadoop.hbase.io.hfile">FixedFileTrailer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#readFromStream(org.apache.hadoop.fs.FSDataInputStream,long)" class="member-name-link">readFromStream</a><wbr>(org.apache.hadoop.fs.FSDataInputStream istream, |
| long fileSize)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Reads a file trailer from the given file.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package 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="#serialize(java.io.DataOutputStream)" class="member-name-link">serialize</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataOutputStream.html" title="class or interface in java.io" class="external-link">DataOutputStream</a> outputStream)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Write the trailer to a data stream.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#serializeAsPB(java.io.DataOutputStream)" class="member-name-link">serializeAsPB</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataOutputStream.html" title="class or interface in java.io" class="external-link">DataOutputStream</a> output)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Write trailer data as protobuf.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setComparatorClass(java.lang.Class)" class="member-name-link">setComparatorClass</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="../../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a>> klass)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCompressionCodec(org.apache.hadoop.hbase.io.compress.Compression.Algorithm)" class="member-name-link">setCompressionCodec</a><wbr>(<a href="../compress/Compression.Algorithm.html" title="enum class in org.apache.hadoop.hbase.io.compress">Compression.Algorithm</a> compressionCodec)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDataIndexCount(int)" class="member-name-link">setDataIndexCount</a><wbr>(int dataIndexCount)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEncryptionKey(byte%5B%5D)" class="member-name-link">setEncryptionKey</a><wbr>(byte[] keyBytes)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setEntryCount(long)" class="member-name-link">setEntryCount</a><wbr>(long newEntryCount)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFileInfoOffset(long)" class="member-name-link">setFileInfoOffset</a><wbr>(long fileInfoOffset)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFirstDataBlockOffset(long)" class="member-name-link">setFirstDataBlockOffset</a><wbr>(long firstDataBlockOffset)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLastDataBlockOffset(long)" class="member-name-link">setLastDataBlockOffset</a><wbr>(long lastDataBlockOffset)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setLoadOnOpenOffset(long)" class="member-name-link">setLoadOnOpenOffset</a><wbr>(long loadOnOpenDataOffset)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setMetaIndexCount(int)" class="member-name-link">setMetaIndexCount</a><wbr>(int metaIndexCount)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setNumDataIndexLevels(int)" class="member-name-link">setNumDataIndexLevels</a><wbr>(int numDataIndexLevels)</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>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTotalUncompressedBytes(long)" class="member-name-link">setTotalUncompressedBytes</a><wbr>(long totalUncompressedBytes)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setUncompressedDataIndexSize(long)" class="member-name-link">setUncompressedDataIndexSize</a><wbr>(long uncompressedDataIndexSize)</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>(package private) org.apache.hadoop.hbase.shaded.protobuf.generated.HFileProtos.FileTrailerProto</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toProtobuf()" class="member-name-link">toProtobuf</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </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#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="LOG"> |
| <h3>LOG</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">org.slf4j.Logger</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-53">LOG</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MAX_COMPARATOR_NAME_LENGTH"> |
| <h3>MAX_COMPARATOR_NAME_LENGTH</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-58">MAX_COMPARATOR_NAME_LENGTH</a></span></div> |
| <div class="block">We store the comparator class name as a fixed-length field in the trailer.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.FixedFileTrailer.MAX_COMPARATOR_NAME_LENGTH">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="fileInfoOffset"> |
| <h3>fileInfoOffset</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-64">fileInfoOffset</a></span></div> |
| <div class="block">Offset to the fileinfo data, a small block of vitals. Necessary in v1 but only potentially |
| useful for pretty-printing in v2.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="loadOnOpenDataOffset"> |
| <h3>loadOnOpenDataOffset</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-72">loadOnOpenDataOffset</a></span></div> |
| <div class="block">In version 1, the offset to the data block index. Starting from version 2, the meaning of this |
| field is the offset to the section of the file that should be loaded at the time the file is |
| being opened: i.e. on open we load the root index, file info, etc. See |
| http://hbase.apache.org/book.html#_hfile_format_2 in the reference guide.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dataIndexCount"> |
| <h3>dataIndexCount</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-77">dataIndexCount</a></span></div> |
| <div class="block">The number of entries in the root data index.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="uncompressedDataIndexSize"> |
| <h3>uncompressedDataIndexSize</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-82">uncompressedDataIndexSize</a></span></div> |
| <div class="block">Total uncompressed size of all blocks of the data index</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="metaIndexCount"> |
| <h3>metaIndexCount</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-87">metaIndexCount</a></span></div> |
| <div class="block">The number of entries in the meta index</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="totalUncompressedBytes"> |
| <h3>totalUncompressedBytes</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-92">totalUncompressedBytes</a></span></div> |
| <div class="block">The total uncompressed size of keys/values stored in the file.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="entryCount"> |
| <h3>entryCount</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-97">entryCount</a></span></div> |
| <div class="block">The number of key/value pairs in the file. This field was int in version 1, but is now long.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="compressionCodec"> |
| <h3>compressionCodec</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../compress/Compression.Algorithm.html" title="enum class in org.apache.hadoop.hbase.io.compress">Compression.Algorithm</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-102">compressionCodec</a></span></div> |
| <div class="block">The compression codec used for all blocks.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="numDataIndexLevels"> |
| <h3>numDataIndexLevels</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-107">numDataIndexLevels</a></span></div> |
| <div class="block">The number of levels in the potentially multi-level data index. Used from version 2 onwards.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="firstDataBlockOffset"> |
| <h3>firstDataBlockOffset</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-112">firstDataBlockOffset</a></span></div> |
| <div class="block">The offset of the first data block.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="lastDataBlockOffset"> |
| <h3>lastDataBlockOffset</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-117">lastDataBlockOffset</a></span></div> |
| <div class="block">It is guaranteed that no key/value data blocks start after this offset in the file.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="comparatorClassName"> |
| <h3>comparatorClassName</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/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-123">comparatorClassName</a></span></div> |
| <div class="block">Raw key comparator class name in version 3</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="encryptionKey"> |
| <h3>encryptionKey</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-129">encryptionKey</a></span></div> |
| <div class="block">The encryption key</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="majorVersion"> |
| <h3>majorVersion</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-134">majorVersion</a></span></div> |
| <div class="block">The <a href="HFile.html" title="class in org.apache.hadoop.hbase.io.hfile"><code>HFile</code></a> format major version.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="minorVersion"> |
| <h3>minorVersion</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-139">minorVersion</a></span></div> |
| <div class="block">The <a href="HFile.html" title="class in org.apache.hadoop.hbase.io.hfile"><code>HFile</code></a> format minor version.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TRAILER_SIZE"> |
| <h3>TRAILER_SIZE</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">int[]</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-168">TRAILER_SIZE</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MAX_TRAILER_SIZE"> |
| <h3>MAX_TRAILER_SIZE</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-169">MAX_TRAILER_SIZE</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="NOT_PB_SIZE"> |
| <h3>NOT_PB_SIZE</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-171">NOT_PB_SIZE</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../constant-values.html#org.apache.hadoop.hbase.io.hfile.FixedFileTrailer.NOT_PB_SIZE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </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>(int,int)"> |
| <h3>FixedFileTrailer</h3> |
| <div class="member-signature"><span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-141">FixedFileTrailer</a></span><wbr><span class="parameters">(int majorVersion, |
| int minorVersion)</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="computeTrailerSizeByVersion()"> |
| <h3>computeTrailerSizeByVersion</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">int[]</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-147">computeTrailerSizeByVersion</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaxTrailerSize()"> |
| <h3>getMaxTrailerSize</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-160">getMaxTrailerSize</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTrailerSize(int)"> |
| <h3>getTrailerSize</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-173">getTrailerSize</a></span><wbr><span class="parameters">(int version)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTrailerSize()"> |
| <h3>getTrailerSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-177">getTrailerSize</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="serialize(java.io.DataOutputStream)"> |
| <h3>serialize</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-185">serialize</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataOutputStream.html" title="class or interface in java.io" class="external-link">DataOutputStream</a> outputStream)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Write the trailer to a data stream. We support writing version 1 for testing and for |
| determining version 1 trailer size. It is also easy to see what fields changed in version 2.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toProtobuf()"> |
| <h3>toProtobuf</h3> |
| <div class="member-signature"><span class="return-type">org.apache.hadoop.hbase.shaded.protobuf.generated.HFileProtos.FileTrailerProto</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-200">toProtobuf</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="serializeAsPB(java.io.DataOutputStream)"> |
| <h3>serializeAsPB</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-218">serializeAsPB</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataOutputStream.html" title="class or interface in java.io" class="external-link">DataOutputStream</a> output)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Write trailer data as protobuf.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deserialize(java.io.DataInputStream)"> |
| <h3>deserialize</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-241">deserialize</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataInputStream.html" title="class or interface in java.io" class="external-link">DataInputStream</a> inputStream)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Deserialize the fixed file trailer from the given stream. The version needs to already be |
| specified. Make sure this is consistent with <a href="#serialize(java.io.DataOutputStream)"><code>serialize(DataOutputStream)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deserializeFromPB(java.io.DataInputStream)"> |
| <h3>deserializeFromPB</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-264">deserializeFromPB</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataInputStream.html" title="class or interface in java.io" class="external-link">DataInputStream</a> inputStream)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Deserialize the file trailer as protobuf</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="deserializeFromWritable(java.io.DataInput)"> |
| <h3>deserializeFromWritable</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-319">deserializeFromWritable</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/DataInput.html" title="class or interface in java.io" class="external-link">DataInput</a> input)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Deserialize the file trailer as writable data</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="append(java.lang.StringBuilder,java.lang.String)"> |
| <h3>append</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/io/hfile/FixedFileTrailer.html#line-338">append</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> sb, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> s)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-345">toString</a></span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readFromStream(org.apache.hadoop.fs.FSDataInputStream,long)"> |
| <h3>readFromStream</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FixedFileTrailer.html" title="class in org.apache.hadoop.hbase.io.hfile">FixedFileTrailer</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-379">readFromStream</a></span><wbr><span class="parameters">(org.apache.hadoop.fs.FSDataInputStream istream, |
| long fileSize)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Reads a file trailer from the given file.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>istream</code> - the input stream with the ability to seek. Does not have to be buffered, as |
| only one read operation is made.</dd> |
| <dd><code>fileSize</code> - the file size. Can be obtained using |
| <code>FileSystem.getFileStatus(org.apache.hadoop.fs.Path)</code>.</dd> |
| <dt>Returns:</dt> |
| <dd>the fixed file trailer read</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - if failed to read from the underlying stream, or the trailer is corrupted, |
| or the version of the trailer is unsupported</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="expectMajorVersion(int)"> |
| <h3>expectMajorVersion</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/io/hfile/FixedFileTrailer.html#line-412">expectMajorVersion</a></span><wbr><span class="parameters">(int expected)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="expectMinorVersion(int)"> |
| <h3>expectMinorVersion</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/io/hfile/FixedFileTrailer.html#line-419">expectMinorVersion</a></span><wbr><span class="parameters">(int expected)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="expectAtLeastMajorVersion(int)"> |
| <h3>expectAtLeastMajorVersion</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/io/hfile/FixedFileTrailer.html#line-426">expectAtLeastMajorVersion</a></span><wbr><span class="parameters">(int lowerBound)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFileInfoOffset()"> |
| <h3>getFileInfoOffset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-433">getFileInfoOffset</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFileInfoOffset(long)"> |
| <h3>setFileInfoOffset</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/io/hfile/FixedFileTrailer.html#line-437">setFileInfoOffset</a></span><wbr><span class="parameters">(long fileInfoOffset)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLoadOnOpenDataOffset()"> |
| <h3>getLoadOnOpenDataOffset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-441">getLoadOnOpenDataOffset</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLoadOnOpenOffset(long)"> |
| <h3>setLoadOnOpenOffset</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/io/hfile/FixedFileTrailer.html#line-445">setLoadOnOpenOffset</a></span><wbr><span class="parameters">(long loadOnOpenDataOffset)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDataIndexCount()"> |
| <h3>getDataIndexCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-449">getDataIndexCount</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDataIndexCount(int)"> |
| <h3>setDataIndexCount</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/io/hfile/FixedFileTrailer.html#line-453">setDataIndexCount</a></span><wbr><span class="parameters">(int dataIndexCount)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMetaIndexCount()"> |
| <h3>getMetaIndexCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-457">getMetaIndexCount</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setMetaIndexCount(int)"> |
| <h3>setMetaIndexCount</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/io/hfile/FixedFileTrailer.html#line-461">setMetaIndexCount</a></span><wbr><span class="parameters">(int metaIndexCount)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTotalUncompressedBytes()"> |
| <h3>getTotalUncompressedBytes</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-465">getTotalUncompressedBytes</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTotalUncompressedBytes(long)"> |
| <h3>setTotalUncompressedBytes</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/io/hfile/FixedFileTrailer.html#line-469">setTotalUncompressedBytes</a></span><wbr><span class="parameters">(long totalUncompressedBytes)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEntryCount()"> |
| <h3>getEntryCount</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-473">getEntryCount</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setEntryCount(long)"> |
| <h3>setEntryCount</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/io/hfile/FixedFileTrailer.html#line-477">setEntryCount</a></span><wbr><span class="parameters">(long newEntryCount)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCompressionCodec()"> |
| <h3>getCompressionCodec</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../compress/Compression.Algorithm.html" title="enum class in org.apache.hadoop.hbase.io.compress">Compression.Algorithm</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-481">getCompressionCodec</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCompressionCodec(org.apache.hadoop.hbase.io.compress.Compression.Algorithm)"> |
| <h3>setCompressionCodec</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/io/hfile/FixedFileTrailer.html#line-485">setCompressionCodec</a></span><wbr><span class="parameters">(<a href="../compress/Compression.Algorithm.html" title="enum class in org.apache.hadoop.hbase.io.compress">Compression.Algorithm</a> compressionCodec)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNumDataIndexLevels()"> |
| <h3>getNumDataIndexLevels</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-489">getNumDataIndexLevels</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setNumDataIndexLevels(int)"> |
| <h3>setNumDataIndexLevels</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/io/hfile/FixedFileTrailer.html#line-494">setNumDataIndexLevels</a></span><wbr><span class="parameters">(int numDataIndexLevels)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLastDataBlockOffset()"> |
| <h3>getLastDataBlockOffset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-499">getLastDataBlockOffset</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setLastDataBlockOffset(long)"> |
| <h3>setLastDataBlockOffset</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/io/hfile/FixedFileTrailer.html#line-504">setLastDataBlockOffset</a></span><wbr><span class="parameters">(long lastDataBlockOffset)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFirstDataBlockOffset()"> |
| <h3>getFirstDataBlockOffset</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-509">getFirstDataBlockOffset</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFirstDataBlockOffset(long)"> |
| <h3>setFirstDataBlockOffset</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/io/hfile/FixedFileTrailer.html#line-514">setFirstDataBlockOffset</a></span><wbr><span class="parameters">(long firstDataBlockOffset)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getComparatorClassName()"> |
| <h3>getComparatorClassName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-519">getComparatorClassName</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMajorVersion()"> |
| <h3>getMajorVersion</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-526">getMajorVersion</a></span>()</div> |
| <div class="block">Returns the major version of this HFile format</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMinorVersion()"> |
| <h3>getMinorVersion</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-533">getMinorVersion</a></span>()</div> |
| <div class="block">Returns the minor version of this HFile format</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setComparatorClass(java.lang.Class)"> |
| <h3>setComparatorClass</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/io/hfile/FixedFileTrailer.html#line-537">setComparatorClass</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <a href="../../CellComparator.html" title="interface in org.apache.hadoop.hbase">CellComparator</a>> klass)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getComparatorClass(java.lang.String)"> |
| <h3>getComparatorClass</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><? extends <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/io/hfile/FixedFileTrailer.html#line-552">getComparatorClass</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> comparatorClassName)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createComparator(java.lang.String)"> |
| <h3>createComparator</h3> |
| <div class="member-signature"><span class="modifiers">static</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/io/hfile/FixedFileTrailer.html#line-593">createComparator</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> comparatorClassName)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createComparator()"> |
| <h3>createComparator</h3> |
| <div class="member-signature"><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/io/hfile/FixedFileTrailer.html#line-615">createComparator</a></span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUncompressedDataIndexSize()"> |
| <h3>getUncompressedDataIndexSize</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-620">getUncompressedDataIndexSize</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setUncompressedDataIndexSize(long)"> |
| <h3>setUncompressedDataIndexSize</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/io/hfile/FixedFileTrailer.html#line-624">setUncompressedDataIndexSize</a></span><wbr><span class="parameters">(long uncompressedDataIndexSize)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEncryptionKey()"> |
| <h3>getEncryptionKey</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-629">getEncryptionKey</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setEncryptionKey(byte[])"> |
| <h3>setEncryptionKey</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/io/hfile/FixedFileTrailer.html#line-636">setEncryptionKey</a></span><wbr><span class="parameters">(byte[] keyBytes)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="extractMajorVersion(int)"> |
| <h3>extractMajorVersion</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-644">extractMajorVersion</a></span><wbr><span class="parameters">(int serializedVersion)</span></div> |
| <div class="block">Extracts the major version for a 4-byte serialized version data. The major version is the 3 |
| least significant bytes</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="extractMinorVersion(int)"> |
| <h3>extractMinorVersion</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-652">extractMinorVersion</a></span><wbr><span class="parameters">(int serializedVersion)</span></div> |
| <div class="block">Extracts the minor version for a 4-byte serialized version data. The major version are the 3 |
| the most significant bytes</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="materializeVersion(int,int)"> |
| <h3>materializeVersion</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../../src-html/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.html#line-659">materializeVersion</a></span><wbr><span class="parameters">(int majorVersion, |
| int minorVersion)</span></div> |
| <div class="block">Create a 4 byte serialized version number by combining the minor and major version numbers.</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> |
