| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RegionInfo (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.client, interface: RegionInfo"> |
| <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/RegionInfo.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>Constr | </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>Constr | </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.client</a></div> |
| <h1 title="Interface RegionInfo" class="title">Interface RegionInfo</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="MutableRegionInfo.html" title="class in org.apache.hadoop.hbase.client">MutableRegionInfo</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Public |
| </span><span class="modifiers">public interface </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-64">RegionInfo</a></span><span class="extends-implements"> |
| extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>></span></div> |
| <div class="block">Information about a region. A region is a range of keys in the whole keyspace of a table, an |
| identifier (a timestamp) for differentiating between subset ranges (after region split) and a |
| replicaId for differentiating the instance for the same range and some status information about |
| the region. The region has a unique name which consists of the following fields: |
| <ul> |
| <li>tableName : The name of the table</li> |
| <li>startKey : The startKey for the region.</li> |
| <li>regionId : A timestamp when the region is created.</li> |
| <li>replicaId : An id starting from 0 to differentiate replicas of the same region range but |
| hosted in separated servers. The same region range can be hosted in multiple locations.</li> |
| <li>encodedName : An MD5 encoded string for the region name.</li> |
| </ul> |
| <br> |
| Other than the fields in the region name, region info contains: |
| <ul> |
| <li>endKey : the endKey for the region (exclusive)</li> |
| <li>split : Whether the region is split</li> |
| <li>offline : Whether the region is offline</li> |
| </ul></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>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#COMPARATOR" class="member-name-link">COMPARATOR</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_REPLICA_ID" class="member-name-link">DEFAULT_REPLICA_ID</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#ENC_SEPARATOR" class="member-name-link">ENC_SEPARATOR</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Separator used to demarcate the encodedName in a region name in the new format.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final <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"><code><a href="#INVALID_REGION_NAME_FORMAT_MESSAGE" class="member-name-link">INVALID_REGION_NAME_FORMAT_MESSAGE</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#MD5_HEX_LENGTH" class="member-name-link">MD5_HEX_LENGTH</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final byte</code></div> |
| <div class="col-second odd-row-color"><code><a href="#REPLICA_ID_DELIMITER" class="member-name-link">REPLICA_ID_DELIMITER</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final <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="#REPLICA_ID_FORMAT" class="member-name-link">REPLICA_ID_FORMAT</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">to keep appended int's sorted in string format.</div> |
| </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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated 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-tab1"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#areAdjacent(org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.hbase.client.RegionInfo)" class="member-name-link">areAdjacent</a><wbr>(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionA, |
| <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionB)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Check whether two regions are adjacent; i.e.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#compareTo(org.apache.hadoop.hbase.client.RegionInfo)" class="member-name-link">compareTo</a><wbr>(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> other)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#containsRange(byte%5B%5D,byte%5B%5D)" class="member-name-link">containsRange</a><wbr>(byte[] rangeStartKey, |
| byte[] rangeEndKey)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns true if the given inclusive range of rows is fully contained by this region.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#containsRow(byte%5B%5D)" class="member-name-link">containsRow</a><wbr>(byte[] row)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns true if the given row falls in this region.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#createMobRegionInfo(org.apache.hadoop.hbase.TableName)" class="member-name-link">createMobRegionInfo</a><wbr>(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Creates a RegionInfo object for MOB data.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#createRegionName(org.apache.hadoop.hbase.TableName,byte%5B%5D,byte%5B%5D,boolean)" class="member-name-link">createRegionName</a><wbr>(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| byte[] id, |
| boolean newFormat)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Make a region name of passed parameters.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#createRegionName(org.apache.hadoop.hbase.TableName,byte%5B%5D,byte%5B%5D,int,boolean)" class="member-name-link">createRegionName</a><wbr>(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| byte[] id, |
| int replicaId, |
| boolean newFormat)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Make a region name of passed parameters.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#createRegionName(org.apache.hadoop.hbase.TableName,byte%5B%5D,long,boolean)" class="member-name-link">createRegionName</a><wbr>(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| long regionid, |
| boolean newFormat)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Make a region name of passed parameters.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#createRegionName(org.apache.hadoop.hbase.TableName,byte%5B%5D,long,int,boolean)" class="member-name-link">createRegionName</a><wbr>(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| long regionid, |
| int replicaId, |
| boolean newFormat)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Make a region name of passed parameters.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#createRegionName(org.apache.hadoop.hbase.TableName,byte%5B%5D,java.lang.String,boolean)" class="member-name-link">createRegionName</a><wbr>(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| <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> id, |
| boolean newFormat)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Make a region name of passed parameters.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <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 method-summary-table method-summary-table-tab1"><code><a href="#encodeRegionName(byte%5B%5D)" class="member-name-link">encodeRegionName</a><wbr>(byte[] regionName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Returns the encodedName</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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-tab3"><code><a href="#getEncodedName()" class="member-name-link">getEncodedName</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the encoded region name.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getEncodedNameAsBytes()" class="member-name-link">getEncodedNameAsBytes</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the encoded region name as an array of bytes.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getEndKey()" class="member-name-link">getEndKey</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the endKey.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRegionId()" class="member-name-link">getRegionId</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the regionId.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRegionName()" class="member-name-link">getRegionName</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the regionName as an array of bytes.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRegionNameAsString()" class="member-name-link">getRegionNameAsString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns Region name as a String for use in logging, etc.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <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-tab1"><code><a href="#getRegionNameAsString(byte%5B%5D)" class="member-name-link">getRegionNameAsString</a><wbr>(byte[] regionName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <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 method-summary-table method-summary-table-tab1"><code><a href="#getRegionNameAsString(org.apache.hadoop.hbase.client.RegionInfo,byte%5B%5D)" class="member-name-link">getRegionNameAsString</a><wbr>(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> ri, |
| byte[] regionName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getReplicaId()" class="member-name-link">getReplicaId</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns returns region replica id</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getShortNameToLog()" class="member-name-link">getShortNameToLog</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns Return a short, printable name for this region (usually encoded name) for us logging.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <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-tab1"><code><a href="#getShortNameToLog(java.util.List)" class="member-name-link">getShortNameToLog</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>> ris)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Returns a String of short, printable names for <code>hris</code> (usually encoded name) for us |
| logging.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <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 method-summary-table method-summary-table-tab1"><code><a href="#getShortNameToLog(org.apache.hadoop.hbase.client.RegionInfo...)" class="member-name-link">getShortNameToLog</a><wbr>(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>... hris)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Returns a String of short, printable names for <code>hris</code> (usually encoded name) for us |
| logging.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getStartKey()" class="member-name-link">getStartKey</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns the startKey.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#getStartKey(byte%5B%5D)" class="member-name-link">getStartKey</a><wbr>(byte[] regionName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Gets the start key from the specified region name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getTable()" class="member-name-link">getTable</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns current table name of the region</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#getTable(byte%5B%5D)" class="member-name-link">getTable</a><wbr>(byte[] regionName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Gets the table name from the specified region name.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#hasEncodedName(byte%5B%5D)" class="member-name-link">hasEncodedName</a><wbr>(byte[] regionName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Does region name contain its encoded name?</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isAdjacent(org.apache.hadoop.hbase.client.RegionInfo)" class="member-name-link">isAdjacent</a><wbr>(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> other)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns True if region is adjacent, either just before or just after this one.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isDegenerate()" class="member-name-link">isDegenerate</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns True if RegionInfo is degenerate...</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#isEncodedRegionName(byte%5B%5D)" class="member-name-link">isEncodedRegionName</a><wbr>(byte[] regionName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Figure if the passed bytes represent an encoded region name or not.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isFirst()" class="member-name-link">isFirst</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns True if this is first Region in Table</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isLast()" class="member-name-link">isLast</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns True if this is last Region in Table</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isMetaRegion()" class="member-name-link">isMetaRegion</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns true if this region is a meta region.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isNext(org.apache.hadoop.hbase.client.RegionInfo)" class="member-name-link">isNext</a><wbr>(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> after)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns True if region is next, adjacent but 'after' this one.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#isOffline()" class="member-name-link">isOffline</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.0.0 and will be removed in 4.0.0</div> |
| </div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#isOverlap(org.apache.hadoop.hbase.client.RegionInfo)" class="member-name-link">isOverlap</a><wbr>(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> other)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <div class="block">Returns True if an overlap in region range.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isSplit()" class="member-name-link">isSplit</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Returns True if has been split and has daughters.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#isSplitParent()" class="member-name-link">isSplitParent</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.0.0 and will be removed in 4.0.0, Use <a href="#isSplit()"><code>isSplit()</code></a> instead.</div> |
| </div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#parseDelimitedFrom(byte%5B%5D,int,int)" class="member-name-link">parseDelimitedFrom</a><wbr>(byte[] bytes, |
| int offset, |
| int length)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Parses all the RegionInfo instances from the passed in stream until EOF.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#parseFrom(byte%5B%5D)" class="member-name-link">parseFrom</a><wbr>(byte[] bytes)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Returns A deserialized <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionInfo</code></a></div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#parseFrom(byte%5B%5D,int,int)" class="member-name-link">parseFrom</a><wbr>(byte[] bytes, |
| int offset, |
| int len)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Parse a serialized representation of <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionInfo</code></a></div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#parseFrom(java.io.DataInputStream)" class="member-name-link">parseFrom</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> in)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Parses an RegionInfo instance from the passed in stream.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#parseFromOrNull(byte%5B%5D)" class="member-name-link">parseFromOrNull</a><wbr>(byte[] bytes)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Returns A deserialized <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionInfo</code></a> or null if we failed deserialize or passed bytes null</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#parseFromOrNull(byte%5B%5D,int,int)" class="member-name-link">parseFromOrNull</a><wbr>(byte[] bytes, |
| int offset, |
| int len)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Returns A deserialized <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionInfo</code></a> or null if we failed deserialize or passed bytes null</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static byte[][]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#parseRegionName(byte%5B%5D)" class="member-name-link">parseRegionName</a><wbr>(byte[] regionName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Separate elements of a regionName.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static byte[][]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#parseRegionNameOrReturnNull(byte%5B%5D)" class="member-name-link">parseRegionNameOrReturnNull</a><wbr>(byte[] regionName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Separate elements of a regionName.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <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-tab1"><code><a href="#prettyPrint(java.lang.String)" class="member-name-link">prettyPrint</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> encodedRegionName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Use logging.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#toByteArray(org.apache.hadoop.hbase.client.RegionInfo)" class="member-name-link">toByteArray</a><wbr>(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> ri)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Returns This instance serialized as protobuf w/ a magic pb prefix.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static byte[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#toDelimitedByteArray(org.apache.hadoop.hbase.client.RegionInfo)" class="member-name-link">toDelimitedByteArray</a><wbr>(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> ri)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Use this instead of <a href="#toByteArray(org.apache.hadoop.hbase.client.RegionInfo)"><code>toByteArray(RegionInfo)</code></a> when writing to a stream and you |
| want to use the pb mergeDelimitedFrom (w/o the delimiter, pb reads to EOF which may not be what |
| you want).</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1"><code>static byte[]</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1"><code><a href="#toDelimitedByteArray(org.apache.hadoop.hbase.client.RegionInfo...)" class="member-name-link">toDelimitedByteArray</a><wbr>(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>... infos)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1"> |
| <div class="block">Serializes given RegionInfo's as a byte array.</div> |
| </div> |
| </div> |
| </div> |
| </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="ENC_SEPARATOR"> |
| <h3>ENC_SEPARATOR</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-71">ENC_SEPARATOR</a></span></div> |
| <div class="block">Separator used to demarcate the encodedName in a region name in the new format. See description |
| on new format above.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.client.RegionInfo.ENC_SEPARATOR">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MD5_HEX_LENGTH"> |
| <h3>MD5_HEX_LENGTH</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-74">MD5_HEX_LENGTH</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.client.RegionInfo.MD5_HEX_LENGTH">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_REPLICA_ID"> |
| <h3>DEFAULT_REPLICA_ID</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-77">DEFAULT_REPLICA_ID</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.client.RegionInfo.DEFAULT_REPLICA_ID">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="REPLICA_ID_FORMAT"> |
| <h3>REPLICA_ID_FORMAT</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static final</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/client/RegionInfo.html#line-83">REPLICA_ID_FORMAT</a></span></div> |
| <div class="block">to keep appended int's sorted in string format. Only allows 2 bytes to be sorted for replicaId.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.client.RegionInfo.REPLICA_ID_FORMAT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="REPLICA_ID_DELIMITER"> |
| <h3>REPLICA_ID_DELIMITER</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static final</span> <span class="return-type">byte</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-86">REPLICA_ID_DELIMITER</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.client.RegionInfo.REPLICA_ID_DELIMITER">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="INVALID_REGION_NAME_FORMAT_MESSAGE"> |
| <h3>INVALID_REGION_NAME_FORMAT_MESSAGE</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static final</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/client/RegionInfo.html#line-89">INVALID_REGION_NAME_FORMAT_MESSAGE</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.client.RegionInfo.INVALID_REGION_NAME_FORMAT_MESSAGE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="COMPARATOR"> |
| <h3>COMPARATOR</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Comparator.html" title="class or interface in java.util" class="external-link">Comparator</a><<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-92">COMPARATOR</a></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="getShortNameToLog()"> |
| <h3>getShortNameToLog</h3> |
| <div class="member-signature"><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/client/RegionInfo.html#line-149">getShortNameToLog</a></span>()</div> |
| <div class="block">Returns Return a short, printable name for this region (usually encoded name) for us logging.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRegionId()"> |
| <h3>getRegionId</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-152">getRegionId</a></span>()</div> |
| <div class="block">Returns the regionId.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRegionName()"> |
| <h3>getRegionName</h3> |
| <div class="member-signature"><span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-158">getRegionName</a></span>()</div> |
| <div class="block">Returns the regionName as an array of bytes.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#getRegionNameAsString()"><code>getRegionNameAsString()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRegionNameAsString()"> |
| <h3>getRegionNameAsString</h3> |
| <div class="member-signature"><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/client/RegionInfo.html#line-161">getRegionNameAsString</a></span>()</div> |
| <div class="block">Returns Region name as a String for use in logging, etc.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEncodedName()"> |
| <h3>getEncodedName</h3> |
| <div class="member-signature"><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/client/RegionInfo.html#line-164">getEncodedName</a></span>()</div> |
| <div class="block">Returns the encoded region name.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEncodedNameAsBytes()"> |
| <h3>getEncodedNameAsBytes</h3> |
| <div class="member-signature"><span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-167">getEncodedNameAsBytes</a></span>()</div> |
| <div class="block">Returns the encoded region name as an array of bytes.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStartKey()"> |
| <h3>getStartKey</h3> |
| <div class="member-signature"><span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-170">getStartKey</a></span>()</div> |
| <div class="block">Returns the startKey.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEndKey()"> |
| <h3>getEndKey</h3> |
| <div class="member-signature"><span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-173">getEndKey</a></span>()</div> |
| <div class="block">Returns the endKey.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTable()"> |
| <h3>getTable</h3> |
| <div class="member-signature"><span class="return-type"><a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-176">getTable</a></span>()</div> |
| <div class="block">Returns current table name of the region</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReplicaId()"> |
| <h3>getReplicaId</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-179">getReplicaId</a></span>()</div> |
| <div class="block">Returns returns region replica id</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSplit()"> |
| <h3>isSplit</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-182">isSplit</a></span>()</div> |
| <div class="block">Returns True if has been split and has daughters.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isOffline()"> |
| <h3>isOffline</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-189">isOffline</a></span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.0.0 and will be removed in 4.0.0</div> |
| </div> |
| <div class="block">Returns True if this region is offline.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="https://issues.apache.org/jira/browse/HBASE-25210">HBASE-25210</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSplitParent()"> |
| <h3>isSplitParent</h3> |
| <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-197">isSplitParent</a></span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">since 3.0.0 and will be removed in 4.0.0, Use <a href="#isSplit()"><code>isSplit()</code></a> instead.</div> |
| </div> |
| <div class="block">Returns True if this is a split parent region.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="https://issues.apache.org/jira/browse/HBASE-25210">HBASE-25210</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isMetaRegion()"> |
| <h3>isMetaRegion</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-201">isMetaRegion</a></span>()</div> |
| <div class="block">Returns true if this region is a meta region.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="containsRange(byte[],byte[])"> |
| <h3>containsRange</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-209">containsRange</a></span><wbr><span class="parameters">(byte[] rangeStartKey, |
| byte[] rangeEndKey)</span></div> |
| <div class="block">Returns true if the given inclusive range of rows is fully contained by this region. For |
| example, if the region is foo,a,g and this is passed ["b","c"] or ["a","c"] it will return |
| true, but if this is passed ["b","z"] it will return false.</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the range passed is invalid (ie. end < start)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="containsRow(byte[])"> |
| <h3>containsRow</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-212">containsRow</a></span><wbr><span class="parameters">(byte[] row)</span></div> |
| <div class="block">Returns true if the given row falls in this region.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasEncodedName(byte[])"> |
| <h3>hasEncodedName</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-219">hasEncodedName</a></span><wbr><span class="parameters">(byte[] regionName)</span></div> |
| <div class="block">Does region name contain its encoded name?</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>regionName</code> - region name</dd> |
| <dt>Returns:</dt> |
| <dd>boolean indicating if this a new format region name which contains its encoded name.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="encodeRegionName(byte[])"> |
| <h3>encodeRegionName</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static</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/client/RegionInfo.html#line-227">encodeRegionName</a></span><wbr><span class="parameters">(byte[] regionName)</span></div> |
| <div class="block">Returns the encodedName</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRegionNameAsString(byte[])"> |
| <h3>getRegionNameAsString</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static</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/client/RegionInfo.html#line-245">getRegionNameAsString</a></span><wbr><span class="parameters">(byte[] regionName)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRegionNameAsString(org.apache.hadoop.hbase.client.RegionInfo,byte[])"> |
| <h3>getRegionNameAsString</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static</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/client/RegionInfo.html#line-250">getRegionNameAsString</a></span><wbr><span class="parameters">(@CheckForNull |
| <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> ri, |
| byte[] regionName)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getShortNameToLog(org.apache.hadoop.hbase.client.RegionInfo...)"> |
| <h3>getShortNameToLog</h3> |
| <div class="member-signature"><span class="modifiers">static</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/client/RegionInfo.html#line-269">getShortNameToLog</a></span><wbr><span class="parameters">(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>... hris)</span></div> |
| <div class="block">Returns a String of short, printable names for <code>hris</code> (usually encoded name) for us |
| logging.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getShortNameToLog(java.util.List)"> |
| <h3>getShortNameToLog</h3> |
| <div class="member-signature"><span class="modifiers">static</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/client/RegionInfo.html#line-277">getShortNameToLog</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>> ris)</span></div> |
| <div class="block">Returns a String of short, printable names for <code>hris</code> (usually encoded name) for us |
| logging.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTable(byte[])"> |
| <h3>getTable</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static</span> <span class="return-type"><a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-286">getTable</a></span><wbr><span class="parameters">(byte[] regionName)</span></div> |
| <div class="block">Gets the table name from the specified region name.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>regionName</code> - to extract the table name from</dd> |
| <dt>Returns:</dt> |
| <dd>Table name</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStartKey(byte[])"> |
| <h3>getStartKey</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-310">getStartKey</a></span><wbr><span class="parameters">(byte[] regionName)</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">Gets the start key from the specified region name.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Start key.</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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isEncodedRegionName(byte[])"> |
| <h3>isEncodedRegionName</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-319">isEncodedRegionName</a></span><wbr><span class="parameters">(byte[] regionName)</span></div> |
| <div class="block">Figure if the passed bytes represent an encoded region name or not.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>regionName</code> - A Region name either encoded or not.</dd> |
| <dt>Returns:</dt> |
| <dd>True if <code>regionName</code> represents an encoded name.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseFromOrNull(byte[])"> |
| <h3>parseFromOrNull</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static</span> <span class="return-type"><a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-344">parseFromOrNull</a></span><wbr><span class="parameters">(byte[] bytes)</span></div> |
| <div class="block">Returns A deserialized <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionInfo</code></a> or null if we failed deserialize or passed bytes null</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseFromOrNull(byte[],int,int)"> |
| <h3>parseFromOrNull</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static</span> <span class="return-type"><a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-353">parseFromOrNull</a></span><wbr><span class="parameters">(byte[] bytes, |
| int offset, |
| int len)</span></div> |
| <div class="block">Returns A deserialized <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionInfo</code></a> or null if we failed deserialize or passed bytes null</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseFrom(byte[])"> |
| <h3>parseFrom</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static</span> <span class="return-type"><a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-366">parseFrom</a></span><wbr><span class="parameters">(byte[] bytes)</span> |
| throws <span class="exceptions"><a href="../exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></span></div> |
| <div class="block">Returns A deserialized <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionInfo</code></a></div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="../exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseFrom(byte[],int,int)"> |
| <h3>parseFrom</h3> |
| <div class="member-signature"><span class="annotations">@Private |
| </span><span class="modifiers">static</span> <span class="return-type"><a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-379">parseFrom</a></span><wbr><span class="parameters">(byte[] bytes, |
| int offset, |
| int len)</span> |
| throws <span class="exceptions"><a href="../exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></span></div> |
| <div class="block">Parse a serialized representation of <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionInfo</code></a></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bytes</code> - A pb RegionInfo serialized with a pb magic prefix.</dd> |
| <dd><code>offset</code> - starting point in the byte array</dd> |
| <dd><code>len</code> - length to read on the byte array</dd> |
| <dt>Returns:</dt> |
| <dd>A deserialized <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionInfo</code></a></dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="../exceptions/DeserializationException.html" title="class in org.apache.hadoop.hbase.exceptions">DeserializationException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="areAdjacent(org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.hbase.client.RegionInfo)"> |
| <h3>areAdjacent</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-401">areAdjacent</a></span><wbr><span class="parameters">(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionA, |
| <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionB)</span></div> |
| <div class="block">Check whether two regions are adjacent; i.e. lies just before or just after in a table.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if two regions are adjacent</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toByteArray(org.apache.hadoop.hbase.client.RegionInfo)"> |
| <h3>toByteArray</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-421">toByteArray</a></span><wbr><span class="parameters">(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> ri)</span></div> |
| <div class="block">Returns This instance serialized as protobuf w/ a magic pb prefix.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#parseFrom(byte%5B%5D)"><code>parseFrom(byte[])</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="prettyPrint(java.lang.String)"> |
| <h3>prettyPrint</h3> |
| <div class="member-signature"><span class="modifiers">static</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/client/RegionInfo.html#line-432">prettyPrint</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> encodedRegionName)</span></div> |
| <div class="block">Use logging.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>encodedRegionName</code> - The encoded regionname.</dd> |
| <dt>Returns:</dt> |
| <dd><code>hbase:meta</code> if passed <code>1028785192</code> else returns |
| <code>encodedRegionName</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createRegionName(org.apache.hadoop.hbase.TableName,byte[],long,boolean)"> |
| <h3>createRegionName</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-447">createRegionName</a></span><wbr><span class="parameters">(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| long regionid, |
| boolean newFormat)</span></div> |
| <div class="block">Make a region name of passed parameters.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>startKey</code> - Can be null</dd> |
| <dd><code>regionid</code> - Region id (Usually timestamp from when region was created).</dd> |
| <dd><code>newFormat</code> - should we create the region name in the new format (such that it contains its |
| encoded name?).</dd> |
| <dt>Returns:</dt> |
| <dd>Region name made of passed tableName, startKey and id</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createRegionName(org.apache.hadoop.hbase.TableName,byte[],java.lang.String,boolean)"> |
| <h3>createRegionName</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-460">createRegionName</a></span><wbr><span class="parameters">(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| <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> id, |
| boolean newFormat)</span></div> |
| <div class="block">Make a region name of passed parameters.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>startKey</code> - Can be null</dd> |
| <dd><code>id</code> - Region id (Usually timestamp from when region was created).</dd> |
| <dd><code>newFormat</code> - should we create the region name in the new format (such that it contains its |
| encoded name?).</dd> |
| <dt>Returns:</dt> |
| <dd>Region name made of passed tableName, startKey and id</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createRegionName(org.apache.hadoop.hbase.TableName,byte[],long,int,boolean)"> |
| <h3>createRegionName</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-473">createRegionName</a></span><wbr><span class="parameters">(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| long regionid, |
| int replicaId, |
| boolean newFormat)</span></div> |
| <div class="block">Make a region name of passed parameters.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>startKey</code> - Can be null</dd> |
| <dd><code>regionid</code> - Region id (Usually timestamp from when region was created).</dd> |
| <dd><code>newFormat</code> - should we create the region name in the new format (such that it contains its |
| encoded name?).</dd> |
| <dt>Returns:</dt> |
| <dd>Region name made of passed tableName, startKey, id and replicaId</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createRegionName(org.apache.hadoop.hbase.TableName,byte[],byte[],boolean)"> |
| <h3>createRegionName</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-487">createRegionName</a></span><wbr><span class="parameters">(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| byte[] id, |
| boolean newFormat)</span></div> |
| <div class="block">Make a region name of passed parameters.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>startKey</code> - Can be null</dd> |
| <dd><code>id</code> - Region id (Usually timestamp from when region was created).</dd> |
| <dd><code>newFormat</code> - should we create the region name in the new format (such that it contains its |
| encoded name?).</dd> |
| <dt>Returns:</dt> |
| <dd>Region name made of passed tableName, startKey and id</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createRegionName(org.apache.hadoop.hbase.TableName,byte[],byte[],int,boolean)"> |
| <h3>createRegionName</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-499">createRegionName</a></span><wbr><span class="parameters">(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, |
| byte[] startKey, |
| byte[] id, |
| int replicaId, |
| boolean newFormat)</span></div> |
| <div class="block">Make a region name of passed parameters.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>startKey</code> - Can be null</dd> |
| <dd><code>id</code> - Region id (Usually timestamp from when region was created).</dd> |
| <dd><code>newFormat</code> - should we create the region name in the new format</dd> |
| <dt>Returns:</dt> |
| <dd>Region name made of passed tableName, startKey, id and replicaId</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createMobRegionInfo(org.apache.hadoop.hbase.TableName)"> |
| <h3>createMobRegionInfo</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-565">createMobRegionInfo</a></span><wbr><span class="parameters">(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</span></div> |
| <div class="block">Creates a RegionInfo object for MOB data.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>tableName</code> - the name of the table</dd> |
| <dt>Returns:</dt> |
| <dd>the MOB <a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client"><code>RegionInfo</code></a>.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseRegionName(byte[])"> |
| <h3>parseRegionName</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">byte[][]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-577">parseRegionName</a></span><wbr><span class="parameters">(byte[] regionName)</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">Separate elements of a regionName.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Array of byte[] containing tableName, startKey and id OR null if not parseable as a |
| region name.</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 not parseable as regionName.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseRegionNameOrReturnNull(byte[])"> |
| <h3>parseRegionNameOrReturnNull</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">byte[][]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-593">parseRegionNameOrReturnNull</a></span><wbr><span class="parameters">(byte[] regionName)</span></div> |
| <div class="block">Separate elements of a regionName. Region name is of the format: |
| <code>tablename,startkey,regionIdTimestamp[_replicaId][.encodedName.]</code>. Startkey can |
| contain the delimiter (',') so we parse from the start and then parse from the end.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>Array of byte[] containing tableName, startKey and id OR null if not parseable as a |
| region name.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toDelimitedByteArray(org.apache.hadoop.hbase.client.RegionInfo...)"> |
| <h3>toDelimitedByteArray</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-661">toDelimitedByteArray</a></span><wbr><span class="parameters">(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>... infos)</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">Serializes given RegionInfo's as a byte array. Use this instead of |
| <a href="#toByteArray(org.apache.hadoop.hbase.client.RegionInfo)"><code>toByteArray(RegionInfo)</code></a> when writing to a stream and you want to use the pb |
| mergeDelimitedFrom (w/o the delimiter, pb reads to EOF which may not be what you want). |
| <a href="#parseDelimitedFrom(byte%5B%5D,int,int)"><code>parseDelimitedFrom(byte[], int, int)</code></a> can be used to read back the instances.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>infos</code> - RegionInfo objects to serialize</dd> |
| <dt>Returns:</dt> |
| <dd>This instance serialized as a delimited protobuf w/ a magic pb prefix.</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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toDelimitedByteArray(org.apache.hadoop.hbase.client.RegionInfo)"> |
| <h3>toDelimitedByteArray</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-684">toDelimitedByteArray</a></span><wbr><span class="parameters">(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> ri)</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">Use this instead of <a href="#toByteArray(org.apache.hadoop.hbase.client.RegionInfo)"><code>toByteArray(RegionInfo)</code></a> when writing to a stream and you |
| want to use the pb mergeDelimitedFrom (w/o the delimiter, pb reads to EOF which may not be what |
| you want).</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>This instance serialized as a delimied protobuf w/ a magic pb prefix.</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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseFrom(java.io.DataInputStream)"> |
| <h3>parseFrom</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-693">parseFrom</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> in)</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">Parses an RegionInfo instance from the passed in stream. Presumes the RegionInfo was serialized |
| to the stream with <a href="#toDelimitedByteArray(org.apache.hadoop.hbase.client.RegionInfo)"><code>toDelimitedByteArray(RegionInfo)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>An instance of RegionInfo.</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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="parseDelimitedFrom(byte[],int,int)"> |
| <h3>parseDelimitedFrom</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-719">parseDelimitedFrom</a></span><wbr><span class="parameters">(byte[] bytes, |
| int offset, |
| int length)</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">Parses all the RegionInfo instances from the passed in stream until EOF. Presumes the |
| RegionInfo's were serialized to the stream with oDelimitedByteArray()</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>bytes</code> - serialized bytes</dd> |
| <dd><code>offset</code> - the start offset into the byte[] buffer</dd> |
| <dd><code>length</code> - how far we should read into the byte[] buffer</dd> |
| <dt>Returns:</dt> |
| <dd>All the RegionInfos that are in the byte array. Keeps reading till we hit the end.</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></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isFirst()"> |
| <h3>isFirst</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-736">isFirst</a></span>()</div> |
| <div class="block">Returns True if this is first Region in Table</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isLast()"> |
| <h3>isLast</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-741">isLast</a></span>()</div> |
| <div class="block">Returns True if this is last Region in Table</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isNext(org.apache.hadoop.hbase.client.RegionInfo)"> |
| <h3>isNext</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-750">isNext</a></span><wbr><span class="parameters">(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> after)</span></div> |
| <div class="block">Returns True if region is next, adjacent but 'after' this one.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#isAdjacent(org.apache.hadoop.hbase.client.RegionInfo)"><code>isAdjacent(RegionInfo)</code></a></li> |
| <li><a href="#areAdjacent(org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.hbase.client.RegionInfo)"><code>areAdjacent(RegionInfo, RegionInfo)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isAdjacent(org.apache.hadoop.hbase.client.RegionInfo)"> |
| <h3>isAdjacent</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-758">isAdjacent</a></span><wbr><span class="parameters">(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> other)</span></div> |
| <div class="block">Returns True if region is adjacent, either just before or just after this one.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#isNext(org.apache.hadoop.hbase.client.RegionInfo)"><code>isNext(RegionInfo)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isDegenerate()"> |
| <h3>isDegenerate</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-763">isDegenerate</a></span>()</div> |
| <div class="block">Returns True if RegionInfo is degenerate... if startKey > endKey.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isOverlap(org.apache.hadoop.hbase.client.RegionInfo)"> |
| <h3>isOverlap</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-771">isOverlap</a></span><wbr><span class="parameters">(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> other)</span></div> |
| <div class="block">Returns True if an overlap in region range.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#isDegenerate()"><code>isDegenerate()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="compareTo(org.apache.hadoop.hbase.client.RegionInfo)"> |
| <h3>compareTo</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/client/RegionInfo.html#line-794">compareTo</a></span><wbr><span class="parameters">(<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> other)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html#compareTo(T)" title="class or interface in java.lang" class="external-link">compareTo</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a>></code></dd> |
| </dl> |
| </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> |