HRegionInfo (Apache HBase 2.3.0 API)

java.lang.Object
- org.apache.hadoop.hbase.HRegionInfo

All Implemented Interfaces:

Comparable<RegionInfo>, RegionInfo

Direct Known Subclasses:

HbckRegionInfo.MetaEntry, ImmutableHRegionInfo, UnmodifyableHRegionInfo

Deprecated.
As of release 2.0.0, this will be removed in HBase 3.0.0. use RegionInfoBuilder to build RegionInfo.
```
@Deprecated
 @InterfaceAudience.Public
public class HRegionInfo
extends Object
implements RegionInfo
```
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:
- tableName : The name of the table
- startKey : The startKey for the region.
- regionId : A timestamp when the region is created.
- 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.
- encodedName : An MD5 encoded string for the region name.
Other than the fields in the region name, region info contains:
- endKey : the endKey for the region (exclusive)
- split : Whether the region is split
- offline : Whether the region is offline
In 0.98 or before, a list of table's regions would fully cover the total keyspace, and at any point in time, a row key always belongs to a single region, which is hosted in a single server. In 0.99+, a region can have multiple instances (called replicas), and thus a range (or row) can correspond to multiple HRegionInfo's. These HRI's share the same fields however except the replicaId field. If the replicaId is not set, it defaults to 0, which is compatible with the previous behavior of a range corresponding to 1 region.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static String`	`DISPLAY_KEYS_KEY` Deprecated.
`static String`	`ENCODED_REGION_NAME_REGEX` Deprecated. A non-capture group so that this can be embedded.
`private String`	`encodedName` Deprecated.
`private byte[]`	`encodedNameAsBytes` Deprecated.
`private byte[]`	`endKey` Deprecated.
`static HRegionInfo`	`FIRST_META_REGIONINFO` Deprecated. HRegionInfo for first meta region
`private int`	`hashCode` Deprecated.
`static byte[]`	`HIDDEN_END_KEY` Deprecated.
`static byte[]`	`HIDDEN_START_KEY` Deprecated.
`private static org.slf4j.Logger`	`LOG` Deprecated.
`private static int`	`MAX_REPLICA_ID` Deprecated.
`static String`	`NO_HASH` Deprecated.
`private boolean`	`offLine` Deprecated.
`private long`	`regionId` Deprecated.
`private byte[]`	`regionName` Deprecated.
`private int`	`replicaId` Deprecated.
`private boolean`	`split` Deprecated.
`private byte[]`	`startKey` Deprecated.
`private TableName`	`tableName` Deprecated.

Fields inherited from interface org.apache.hadoop.hbase.client.RegionInfo
COMPARATOR, DEFAULT_REPLICA_ID, ENC_SEPARATOR, INVALID_REGION_NAME_FORMAT_MESSAGE, MD5_HEX_LENGTH, REPLICA_ID_DELIMITER, REPLICA_ID_FORMAT, UNDEFINED

Constructor Summary

Constructors
Modifier	Constructor and Description
	`HRegionInfo(HRegionInfo other, int replicaId)` Deprecated.
`private`	`HRegionInfo(long regionId, TableName tableName)` Deprecated. Private constructor used constructing HRegionInfo for the first meta regions
	`HRegionInfo(long regionId, TableName tableName, int replicaId)` Deprecated.
	`HRegionInfo(RegionInfo other)` Deprecated. Costruct a copy of another HRegionInfo
	`HRegionInfo(TableName tableName)` Deprecated.
	`HRegionInfo(TableName tableName, byte[] startKey, byte[] endKey)` Deprecated. Construct HRegionInfo with explicit parameters
	`HRegionInfo(TableName tableName, byte[] startKey, byte[] endKey, boolean split)` Deprecated. Construct HRegionInfo with explicit parameters
	`HRegionInfo(TableName tableName, byte[] startKey, byte[] endKey, boolean split, long regionid)` Deprecated. Construct HRegionInfo with explicit parameters
	`HRegionInfo(TableName tableName, byte[] startKey, byte[] endKey, boolean split, long regionid, int replicaId)` Deprecated. Construct HRegionInfo with explicit parameters

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static boolean`	`areAdjacent(HRegionInfo regionA, HRegionInfo regionB)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.areAdjacent(RegionInfo, RegionInfo)`.
`boolean`	`containsRange(byte[] rangeStartKey, byte[] rangeEndKey)` Deprecated. Returns true if the given inclusive range of rows is fully contained by this region.
`boolean`	`containsRow(byte[] row)` Deprecated.
`(package private) org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.RegionInfo`	`convert()` Deprecated. Convert a HRegionInfo to the protobuf RegionInfo
`static HRegionInfo`	`convert(org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.RegionInfo proto)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use toRegionInfo(HBaseProtos.RegionInfo) in org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil.
`static org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.RegionInfo`	`convert(HRegionInfo info)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use toRegionInfo(org.apache.hadoop.hbase.client.RegionInfo) in org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil.
`static byte[]`	`createRegionName(TableName tableName, byte[] startKey, byte[] id, boolean newFormat)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.createRegionName(TableName, byte[], byte[], boolean)`.
`static byte[]`	`createRegionName(TableName tableName, byte[] startKey, byte[] id, int replicaId, boolean newFormat)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.createRegionName(TableName, byte[], byte[], int, boolean)`.
`static byte[]`	`createRegionName(TableName tableName, byte[] startKey, long regionid, boolean newFormat)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.createRegionName(TableName, byte[], long, boolean)`.
`static byte[]`	`createRegionName(TableName tableName, byte[] startKey, long regionid, int replicaId, boolean newFormat)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.createRegionName(TableName, byte[], long, int, boolean)`.
`static byte[]`	`createRegionName(TableName tableName, byte[] startKey, String id, boolean newFormat)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.createRegionName(TableName, byte[], String, boolean)`.
`static String`	`encodeRegionName(byte[] regionName)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.encodeRegionName(byte[])`.
`boolean`	`equals(Object o)` Deprecated.
`KeyValue.KVComparator`	`getComparator()` Deprecated. Use Region#getCellComparator(). deprecated for hbase 2.0, remove for hbase 3.0
`static String`	`getDescriptiveNameFromRegionStateForDisplay(RegionState state, org.apache.hadoop.conf.Configuration conf)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfoDisplay#getDescriptiveNameFromRegionStateForDisplay(RegionState, Configuration) over in hbase-server module.
`String`	`getEncodedName()` Deprecated.
`byte[]`	`getEncodedNameAsBytes()` Deprecated.
`byte[]`	`getEndKey()` Deprecated.
`static byte[]`	`getEndKeyForDisplay(HRegionInfo hri, org.apache.hadoop.conf.Configuration conf)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfoDisplay#getEndKeyForDisplay(RegionInfo, Configuration) over in hbase-server module.
`long`	`getRegionId()` Deprecated.
`byte[]`	`getRegionName()` Deprecated.
`String`	`getRegionNameAsString()` Deprecated.
`static String`	`getRegionNameAsStringForDisplay(HRegionInfo hri, org.apache.hadoop.conf.Configuration conf)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfoDisplay#getRegionNameAsStringForDisplay(RegionInfo, Configuration) over in hbase-server module.
`static byte[]`	`getRegionNameForDisplay(HRegionInfo hri, org.apache.hadoop.conf.Configuration conf)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfoDisplay#getRegionNameForDisplay(RegionInfo, Configuration) over in hbase-server module.
`int`	`getReplicaId()` Deprecated. Returns the region replica id
`String`	`getShortNameToLog()` Deprecated.
`static String`	`getShortNameToLog(HRegionInfo... hris)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.getShortNameToLog(RegionInfo...)`.
`static String`	`getShortNameToLog(List<HRegionInfo> hris)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.getShortNameToLog(List)`)}.
`byte[]`	`getStartKey()` Deprecated.
`static byte[]`	`getStartKey(byte[] regionName)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.getStartKey(byte[])`.
`static byte[]`	`getStartKeyForDisplay(HRegionInfo hri, org.apache.hadoop.conf.Configuration conf)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfoDisplay#getStartKeyForDisplay(RegionInfo, Configuration) over in hbase-server module.
`TableName`	`getTable()` Deprecated. Get current table name of the region
`static TableName`	`getTable(byte[] regionName)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.getTable(byte[])`.
`int`	`hashCode()` Deprecated.
`static boolean`	`isEncodedRegionName(byte[] regionName)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.isEncodedRegionName(byte[])`.
`boolean`	`isMetaRegion()` Deprecated.
`boolean`	`isMetaTable()` Deprecated.
`boolean`	`isOffline()` Deprecated.
`boolean`	`isSplit()` Deprecated.
`boolean`	`isSplitParent()` Deprecated.
`boolean`	`isSystemTable()` Deprecated.
`static List<HRegionInfo>`	`parseDelimitedFrom(byte[] bytes, int offset, int length)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.parseDelimitedFrom(byte[], int, int)`.
`static HRegionInfo`	`parseFrom(byte[] bytes)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.parseFrom(byte[])`.
`static HRegionInfo`	`parseFrom(byte[] bytes, int offset, int len)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.parseFrom(byte[], int, int)`.
`static HRegionInfo`	`parseFrom(DataInputStream in)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.parseFrom(DataInputStream)`.
`static HRegionInfo`	`parseFromOrNull(byte[] bytes)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.parseFromOrNull(byte[])`.
`static HRegionInfo`	`parseFromOrNull(byte[] bytes, int offset, int len)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.parseFromOrNull(byte[], int, int)`.
`static byte[][]`	`parseRegionName(byte[] regionName)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.parseRegionName(byte[])`.
`static String`	`prettyPrint(String encodedRegionName)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.prettyPrint(String)`.
`private void`	`setHashCode()` Deprecated.
`void`	`setOffline(boolean offLine)` Deprecated. The parent of a region split is offline while split daughters hold references to the parent.
`void`	`setSplit(boolean split)` Deprecated.
`byte[]`	`toByteArray()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.toByteArray(RegionInfo)`.
`byte[]`	`toDelimitedByteArray()` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.toDelimitedByteArray(RegionInfo)`.
`static byte[]`	`toDelimitedByteArray(HRegionInfo... infos)` Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use `RegionInfo.toDelimitedByteArray(RegionInfo...)`.
`String`	`toString()` Deprecated.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.hadoop.hbase.client.RegionInfo
areAdjacent, compareTo, createMobRegionInfo, getRegionNameAsString, getRegionNameAsString, getShortNameToLog, getShortNameToLog, hasEncodedName, isAdjacent, isDegenerate, isFirst, isLast, isNext, isOverlap, parseRegionNameOrReturnNull, toByteArray, toDelimitedByteArray, toDelimitedByteArray

- Field Detail
  - LOG
```
private static final org.slf4j.Logger LOG
```
    Deprecated.
  - ENCODED_REGION_NAME_REGEX
```
public static final String ENCODED_REGION_NAME_REGEX
```
    Deprecated.
    
    A non-capture group so that this can be embedded.
    
    See Also:
    
    Constant Field Values
  - MAX_REPLICA_ID
```
private static final int MAX_REPLICA_ID
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - endKey
```
private byte[] endKey
```
    Deprecated.
  - offLine
```
private boolean offLine
```
    Deprecated.
  - regionId
```
private long regionId
```
    Deprecated.
  - regionName
```
private transient byte[] regionName
```
    Deprecated.
  - split
```
private boolean split
```
    Deprecated.
  - startKey
```
private byte[] startKey
```
    Deprecated.
  - hashCode
```
private int hashCode
```
    Deprecated.
  - NO_HASH
```
public static final String NO_HASH
```
    Deprecated.
  - encodedName
```
private String encodedName
```
    Deprecated.
  - encodedNameAsBytes
```
private byte[] encodedNameAsBytes
```
    Deprecated.
  - replicaId
```
private int replicaId
```
    Deprecated.
  - tableName
```
private TableName tableName
```
    Deprecated.
  - DISPLAY_KEYS_KEY
```
static final String DISPLAY_KEYS_KEY
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - HIDDEN_END_KEY
```
public static final byte[] HIDDEN_END_KEY
```
    Deprecated.
  - HIDDEN_START_KEY
```
public static final byte[] HIDDEN_START_KEY
```
    Deprecated.
  - FIRST_META_REGIONINFO
```
public static final HRegionInfo FIRST_META_REGIONINFO
```
    Deprecated.
    
    HRegionInfo for first meta region
- Constructor Detail
  - HRegionInfo
```
private HRegionInfo(long regionId,
                    TableName tableName)
```
    Deprecated.
    
    Private constructor used constructing HRegionInfo for the first meta regions
  - HRegionInfo
```
public HRegionInfo(long regionId,
                   TableName tableName,
                   int replicaId)
```
    Deprecated.
  - HRegionInfo
```
public HRegionInfo(TableName tableName)
```
    Deprecated.
  - HRegionInfo
```
public HRegionInfo(TableName tableName,
                   byte[] startKey,
                   byte[] endKey)
            throws IllegalArgumentException
```
    Deprecated.
    
    Construct HRegionInfo with explicit parameters
    
    Parameters:
    
    tableName - the table name
    
    startKey - first key in region
    
    endKey - end of key range
    
    Throws:
    
    IllegalArgumentException
  - HRegionInfo
```
public HRegionInfo(TableName tableName,
                   byte[] startKey,
                   byte[] endKey,
                   boolean split)
            throws IllegalArgumentException
```
    Deprecated.
    
    Construct HRegionInfo with explicit parameters
    
    Parameters:
    
    tableName - the table descriptor
    
    startKey - first key in region
    
    endKey - end of key range
    
    split - true if this region has split and we have daughter regions regions that may or may not hold references to this region.
    
    Throws:
    
    IllegalArgumentException
  - HRegionInfo
```
public HRegionInfo(TableName tableName,
                   byte[] startKey,
                   byte[] endKey,
                   boolean split,
                   long regionid)
            throws IllegalArgumentException
```
    Deprecated.
    
    Construct HRegionInfo with explicit parameters
    
    Parameters:
    
    tableName - the table descriptor
    
    startKey - first key in region
    
    endKey - end of key range
    
    split - true if this region has split and we have daughter regions regions that may or may not hold references to this region.
    
    regionid - Region id to use.
    
    Throws:
    
    IllegalArgumentException
  - HRegionInfo
```
public HRegionInfo(TableName tableName,
                   byte[] startKey,
                   byte[] endKey,
                   boolean split,
                   long regionid,
                   int replicaId)
            throws IllegalArgumentException
```
    Deprecated.
    
    Construct HRegionInfo with explicit parameters
    
    Parameters:
    
    tableName - the table descriptor
    
    startKey - first key in region
    
    endKey - end of key range
    
    split - true if this region has split and we have daughter regions regions that may or may not hold references to this region.
    
    regionid - Region id to use.
    
    replicaId - the replicaId to use
    
    Throws:
    
    IllegalArgumentException
  - HRegionInfo
```
public HRegionInfo(RegionInfo other)
```
    Deprecated.
    
    Costruct a copy of another HRegionInfo
    
    Parameters:
    
    other -
  - HRegionInfo
```
public HRegionInfo(HRegionInfo other,
                   int replicaId)
```
    Deprecated.
- Method Detail
  - encodeRegionName
```
@Deprecated
public static String encodeRegionName(byte[] regionName)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.encodeRegionName(byte[]).
    
    Specified by:
    
    encodeRegionName in interface RegionInfo
    
    Parameters:
    
    regionName -
    
    Returns:
    
    the encodedName
  - getShortNameToLog
```
public String getShortNameToLog()
```
    Deprecated.
    
    Specified by:
    
    getShortNameToLog in interface RegionInfo
    
    Returns:
    
    Return a short, printable name for this region (usually encoded name) for us logging.
  - getShortNameToLog
```
@Deprecated
public static String getShortNameToLog(HRegionInfo... hris)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.getShortNameToLog(RegionInfo...).
  - getShortNameToLog
```
@Deprecated
public static String getShortNameToLog(List<HRegionInfo> hris)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.getShortNameToLog(List))}.
    
    Returns:
    
    Return a String of short, printable names for hris (usually encoded name) for us logging.
  - prettyPrint
```
@Deprecated
 @InterfaceAudience.Private
public static String prettyPrint(String encodedRegionName)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.prettyPrint(String).
    
    Use logging.
    
    Specified by:
    
    prettyPrint in interface RegionInfo
    
    Parameters:
    
    encodedRegionName - The encoded regionname.
    
    Returns:
    
    hbase:meta if passed 1028785192 else returns encodedRegionName
  - setHashCode
```
private void setHashCode()
```
    Deprecated.
  - createRegionName
```
@Deprecated
 @InterfaceAudience.Private
public static byte[] createRegionName(TableName tableName,
                                                                              byte[] startKey,
                                                                              long regionid,
                                                                              boolean newFormat)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.createRegionName(TableName, byte[], long, boolean).
    
    Make a region name of passed parameters.
    
    Specified by:
    
    createRegionName in interface RegionInfo
    
    Parameters:
    
    tableName -
    
    startKey - Can be null
    
    regionid - Region id (Usually timestamp from when region was created).
    
    newFormat - should we create the region name in the new format (such that it contains its encoded name?).
    
    Returns:
    
    Region name made of passed tableName, startKey and id
  - createRegionName
```
@Deprecated
 @InterfaceAudience.Private
public static byte[] createRegionName(TableName tableName,
                                                                              byte[] startKey,
                                                                              String id,
                                                                              boolean newFormat)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.createRegionName(TableName, byte[], String, boolean).
    
    Make a region name of passed parameters.
    
    Specified by:
    
    createRegionName in interface RegionInfo
    
    Parameters:
    
    tableName -
    
    startKey - Can be null
    
    id - Region id (Usually timestamp from when region was created).
    
    newFormat - should we create the region name in the new format (such that it contains its encoded name?).
    
    Returns:
    
    Region name made of passed tableName, startKey and id
  - createRegionName
```
@Deprecated
 @InterfaceAudience.Private
public static byte[] createRegionName(TableName tableName,
                                                                              byte[] startKey,
                                                                              long regionid,
                                                                              int replicaId,
                                                                              boolean newFormat)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.createRegionName(TableName, byte[], long, int, boolean).
    
    Make a region name of passed parameters.
    
    Specified by:
    
    createRegionName in interface RegionInfo
    
    Parameters:
    
    tableName -
    
    startKey - Can be null
    
    regionid - Region id (Usually timestamp from when region was created).
    
    replicaId -
    
    newFormat - should we create the region name in the new format (such that it contains its encoded name?).
    
    Returns:
    
    Region name made of passed tableName, startKey, id and replicaId
  - createRegionName
```
@Deprecated
 @InterfaceAudience.Private
public static byte[] createRegionName(TableName tableName,
                                                                              byte[] startKey,
                                                                              byte[] id,
                                                                              boolean newFormat)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.createRegionName(TableName, byte[], byte[], boolean).
    
    Make a region name of passed parameters.
    
    Specified by:
    
    createRegionName in interface RegionInfo
    
    Parameters:
    
    tableName -
    
    startKey - Can be null
    
    id - Region id (Usually timestamp from when region was created).
    
    newFormat - should we create the region name in the new format (such that it contains its encoded name?).
    
    Returns:
    
    Region name made of passed tableName, startKey and id
  - createRegionName
```
@Deprecated
 @InterfaceAudience.Private
public static byte[] createRegionName(TableName tableName,
                                                                              byte[] startKey,
                                                                              byte[] id,
                                                                              int replicaId,
                                                                              boolean newFormat)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.createRegionName(TableName, byte[], byte[], int, boolean).
    
    Make a region name of passed parameters.
    
    Specified by:
    
    createRegionName in interface RegionInfo
    
    Parameters:
    
    tableName -
    
    startKey - Can be null
    
    id - Region id (Usually timestamp from when region was created).
    
    replicaId -
    
    newFormat - should we create the region name in the new format
    
    Returns:
    
    Region name made of passed tableName, startKey, id and replicaId
  - getTable
```
@Deprecated
public static TableName getTable(byte[] regionName)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.getTable(byte[]).
    
    Gets the table name from the specified region name.
    
    Specified by:
    
    getTable in interface RegionInfo
    
    Parameters:
    
    regionName - to extract the table name from
    
    Returns:
    
    Table name
  - getStartKey
```
@Deprecated
public static byte[] getStartKey(byte[] regionName)
                                      throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.getStartKey(byte[]).
    
    Gets the start key from the specified region name.
    
    Specified by:
    
    getStartKey in interface RegionInfo
    
    Parameters:
    
    regionName -
    
    Returns:
    
    Start key.
    
    Throws:
    
    IOException
  - parseRegionName
```
@Deprecated
 @InterfaceAudience.Private
public static byte[][] parseRegionName(byte[] regionName)
                                                                        throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.parseRegionName(byte[]).
    
    Separate elements of a regionName.
    
    Specified by:
    
    parseRegionName in interface RegionInfo
    
    Parameters:
    
    regionName -
    
    Returns:
    
    Array of byte[] containing tableName, startKey and id
    
    Throws:
    
    IOException
  - isEncodedRegionName
```
@Deprecated
public static boolean isEncodedRegionName(byte[] regionName)
                                               throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.isEncodedRegionName(byte[]).
    
    Description copied from interface: RegionInfo
    
    Figure if the passed bytes represent an encoded region name or not.
    
    Specified by:
    
    isEncodedRegionName in interface RegionInfo
    
    Parameters:
    
    regionName -
    
    Returns:
    
    if region name is encoded.
    
    Throws:
    
    IOException
  - getRegionId
```
public long getRegionId()
```
    Deprecated.
    
    Specified by:
    
    getRegionId in interface RegionInfo
    
    Returns:
    
    the regionId
  - getRegionName
```
public byte[] getRegionName()
```
    Deprecated.
    
    Specified by:
    
    getRegionName in interface RegionInfo
    
    Returns:
    
    the regionName as an array of bytes.
    
    See Also:
    
    getRegionNameAsString()
  - getRegionNameAsString
```
public String getRegionNameAsString()
```
    Deprecated.
    
    Specified by:
    
    getRegionNameAsString in interface RegionInfo
    
    Returns:
    
    Region name as a String for use in logging, etc.
  - getEncodedName
```
public String getEncodedName()
```
    Deprecated.
    
    Specified by:
    
    getEncodedName in interface RegionInfo
    
    Returns:
    
    the encoded region name
  - getEncodedNameAsBytes
```
public byte[] getEncodedNameAsBytes()
```
    Deprecated.
    
    Specified by:
    
    getEncodedNameAsBytes in interface RegionInfo
    
    Returns:
    
    the encoded region name as an array of bytes.
  - getStartKey
```
public byte[] getStartKey()
```
    Deprecated.
    
    Specified by:
    
    getStartKey in interface RegionInfo
    
    Returns:
    
    the startKey
  - getEndKey
```
public byte[] getEndKey()
```
    Deprecated.
    
    Specified by:
    
    getEndKey in interface RegionInfo
    
    Returns:
    
    the endKey
  - getTable
```
public TableName getTable()
```
    Deprecated.
    
    Get current table name of the region
    
    Specified by:
    
    getTable in interface RegionInfo
    
    Returns:
    
    TableName
  - containsRange
```
public boolean containsRange(byte[] rangeStartKey,
                             byte[] rangeEndKey)
```
    Deprecated.
    
    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.
    
    Specified by:
    
    containsRange in interface RegionInfo
    
    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.
    
    Throws:
    
    IllegalArgumentException - if the range passed is invalid (ie. end < start)
  - containsRow
```
public boolean containsRow(byte[] row)
```
    Deprecated.
    
    Specified by:
    
    containsRow in interface RegionInfo
    
    Returns:
    
    true if the given row falls in this region.
  - isMetaTable
```
public boolean isMetaTable()
```
    Deprecated.
    
    Returns:
    
    true if this region is from hbase:meta
  - isMetaRegion
```
public boolean isMetaRegion()
```
    Deprecated.
    
    Specified by:
    
    isMetaRegion in interface RegionInfo
    
    Returns:
    
    true if this region is a meta region
  - isSystemTable
```
public boolean isSystemTable()
```
    Deprecated.
    
    Returns:
    
    true if this region is from a system table
  - isSplit
```
public boolean isSplit()
```
    Deprecated.
    
    Specified by:
    
    isSplit in interface RegionInfo
    
    Returns:
    
    true if has been split and has daughters.
  - setSplit
```
public void setSplit(boolean split)
```
    Deprecated.
    
    Parameters:
    
    split - set split status
  - isOffline
```
public boolean isOffline()
```
    Deprecated.
    
    Specified by:
    
    isOffline in interface RegionInfo
    
    Returns:
    
    true if this region is offline.
  - setOffline
```
public void setOffline(boolean offLine)
```
    Deprecated.
    
    The parent of a region split is offline while split daughters hold references to the parent. Offlined regions are closed.
    
    Parameters:
    
    offLine - Set online/offline status.
  - isSplitParent
```
public boolean isSplitParent()
```
    Deprecated.
    
    Specified by:
    
    isSplitParent in interface RegionInfo
    
    Returns:
    
    true if this is a split parent region.
  - getReplicaId
```
public int getReplicaId()
```
    Deprecated.
    
    Returns the region replica id
    
    Specified by:
    
    getReplicaId in interface RegionInfo
    
    Returns:
    
    returns region replica id
  - toString
```
public String toString()
```
    Deprecated.
    
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object o)
```
    Deprecated.
    
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    Deprecated.
    
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Object.hashCode()
  - getComparator
```
@Deprecated
public KeyValue.KVComparator getComparator()
```
    Deprecated. Use Region#getCellComparator(). deprecated for hbase 2.0, remove for hbase 3.0
    
    Returns:
    
    Comparator to use comparing KeyValues.
  - convert
```
org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.RegionInfo convert()
```
    Deprecated.
    
    Convert a HRegionInfo to the protobuf RegionInfo
    
    Returns:
    
    the converted RegionInfo
  - convert
```
@Deprecated
 @InterfaceAudience.Private
public static org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.RegionInfo convert(HRegionInfo info)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use toRegionInfo(org.apache.hadoop.hbase.client.RegionInfo) in org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil.
    
    Convert a HRegionInfo to a RegionInfo
    
    Parameters:
    
    info - the HRegionInfo to convert
    
    Returns:
    
    the converted RegionInfo
  - convert
```
@Deprecated
 @InterfaceAudience.Private
public static HRegionInfo convert(org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.RegionInfo proto)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use toRegionInfo(HBaseProtos.RegionInfo) in org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil.
    
    Convert a RegionInfo to a HRegionInfo
    
    Parameters:
    
    proto - the RegionInfo to convert
    
    Returns:
    
    the converted HRegionInfo
  - toByteArray
```
@Deprecated
public byte[] toByteArray()
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.toByteArray(RegionInfo).
    
    Returns:
    
    This instance serialized as protobuf w/ a magic pb prefix.
    
    See Also:
    
    parseFrom(byte[])
  - parseFromOrNull
```
@Deprecated
public static HRegionInfo parseFromOrNull(byte[] bytes)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.parseFromOrNull(byte[]).
    
    Specified by:
    
    parseFromOrNull in interface RegionInfo
    
    Returns:
    
    A deserialized HRegionInfo or null if we failed deserialize or passed bytes null
    
    See Also:
    
    toByteArray()
  - parseFromOrNull
```
@Deprecated
public static HRegionInfo parseFromOrNull(byte[] bytes,
                                                      int offset,
                                                      int len)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.parseFromOrNull(byte[], int, int).
    
    Specified by:
    
    parseFromOrNull in interface RegionInfo
    
    Returns:
    
    A deserialized HRegionInfo or null if we failed deserialize or passed bytes null
    
    See Also:
    
    toByteArray()
  - parseFrom
```
public static HRegionInfo parseFrom(byte[] bytes)
                             throws DeserializationException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.parseFrom(byte[]).
    
    Specified by:
    
    parseFrom in interface RegionInfo
    
    Parameters:
    
    bytes - A pb RegionInfo serialized with a pb magic prefix.
    
    Returns:
    
    A deserialized HRegionInfo
    
    Throws:
    
    DeserializationException
    
    See Also:
    
    toByteArray()
  - parseFrom
```
@Deprecated
public static HRegionInfo parseFrom(byte[] bytes,
                                                int offset,
                                                int len)
                                         throws DeserializationException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.parseFrom(byte[], int, int).
    
    Specified by:
    
    parseFrom in interface RegionInfo
    
    Parameters:
    
    bytes - A pb RegionInfo serialized with a pb magic prefix.
    
    offset - starting point in the byte array
    
    len - length to read on the byte array
    
    Returns:
    
    A deserialized HRegionInfo
    
    Throws:
    
    DeserializationException
    
    See Also:
    
    toByteArray()
  - toDelimitedByteArray
```
@Deprecated
public byte[] toDelimitedByteArray()
                                        throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.toDelimitedByteArray(RegionInfo).
    
    Use this instead of toByteArray() 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).
    
    Returns:
    
    This instance serialized as a delimited protobuf w/ a magic pb prefix.
    
    Throws:
    
    IOException
    
    See Also:
    
    toByteArray()
  - getDescriptiveNameFromRegionStateForDisplay
```
@Deprecated
 @InterfaceAudience.Private
public static String getDescriptiveNameFromRegionStateForDisplay(RegionState state,
                                                                                                         org.apache.hadoop.conf.Configuration conf)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfoDisplay#getDescriptiveNameFromRegionStateForDisplay(RegionState, Configuration) over in hbase-server module.
    
    Get the descriptive name as RegionState does it but with hidden startkey optionally
    
    Parameters:
    
    state -
    
    conf -
    
    Returns:
    
    descriptive string
  - getEndKeyForDisplay
```
@Deprecated
 @InterfaceAudience.Private
public static byte[] getEndKeyForDisplay(HRegionInfo hri,
                                                                                 org.apache.hadoop.conf.Configuration conf)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfoDisplay#getEndKeyForDisplay(RegionInfo, Configuration) over in hbase-server module.
    
    Get the end key for display. Optionally hide the real end key.
    
    Parameters:
    
    hri -
    
    conf -
    
    Returns:
    
    the endkey
  - getStartKeyForDisplay
```
@Deprecated
 @InterfaceAudience.Private
public static byte[] getStartKeyForDisplay(HRegionInfo hri,
                                                                                   org.apache.hadoop.conf.Configuration conf)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfoDisplay#getStartKeyForDisplay(RegionInfo, Configuration) over in hbase-server module.
    
    Get the start key for display. Optionally hide the real start key.
    
    Parameters:
    
    hri -
    
    conf -
    
    Returns:
    
    the startkey
  - getRegionNameAsStringForDisplay
```
@Deprecated
 @InterfaceAudience.Private
public static String getRegionNameAsStringForDisplay(HRegionInfo hri,
                                                                                             org.apache.hadoop.conf.Configuration conf)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfoDisplay#getRegionNameAsStringForDisplay(RegionInfo, Configuration) over in hbase-server module.
    
    Get the region name for display. Optionally hide the start key.
    
    Parameters:
    
    hri -
    
    conf -
    
    Returns:
    
    region name as String
  - getRegionNameForDisplay
```
@Deprecated
 @InterfaceAudience.Private
public static byte[] getRegionNameForDisplay(HRegionInfo hri,
                                                                                     org.apache.hadoop.conf.Configuration conf)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfoDisplay#getRegionNameForDisplay(RegionInfo, Configuration) over in hbase-server module.
    
    Get the region name for display. Optionally hide the start key.
    
    Parameters:
    
    hri -
    
    conf -
    
    Returns:
    
    region name bytes
  - parseFrom
```
@Deprecated
 @InterfaceAudience.Private
public static HRegionInfo parseFrom(DataInputStream in)
                                                                     throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.parseFrom(DataInputStream).
    
    Parses an HRegionInfo instance from the passed in stream. Presumes the HRegionInfo was serialized to the stream with toDelimitedByteArray()
    
    Specified by:
    
    parseFrom in interface RegionInfo
    
    Parameters:
    
    in -
    
    Returns:
    
    An instance of HRegionInfo.
    
    Throws:
    
    IOException
  - toDelimitedByteArray
```
@Deprecated
 @InterfaceAudience.Private
public static byte[] toDelimitedByteArray(HRegionInfo... infos)
                                                                           throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.toDelimitedByteArray(RegionInfo...).
    
    Serializes given HRegionInfo's as a byte array. Use this instead of toByteArray() 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). parseDelimitedFrom(byte[], int, int) can be used to read back the instances.
    
    Parameters:
    
    infos - HRegionInfo objects to serialize
    
    Returns:
    
    This instance serialized as a delimited protobuf w/ a magic pb prefix.
    
    Throws:
    
    IOException
    
    See Also:
    
    toByteArray()
  - parseDelimitedFrom
```
@Deprecated
public static List<HRegionInfo> parseDelimitedFrom(byte[] bytes,
                                                               int offset,
                                                               int length)
                                                        throws IOException
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.parseDelimitedFrom(byte[], int, int).
    
    Parses all the HRegionInfo instances from the passed in stream until EOF. Presumes the HRegionInfo's were serialized to the stream with toDelimitedByteArray()
    
    Specified by:
    
    parseDelimitedFrom in interface RegionInfo
    
    Parameters:
    
    bytes - serialized bytes
    
    offset - the start offset into the byte[] buffer
    
    length - how far we should read into the byte[] buffer
    
    Returns:
    
    All the hregioninfos that are in the byte array. Keeps reading till we hit the end.
    
    Throws:
    
    IOException
  - areAdjacent
```
@Deprecated
public static boolean areAdjacent(HRegionInfo regionA,
                                              HRegionInfo regionB)
```
    Deprecated. As of release 2.0.0, this will be removed in HBase 3.0.0 Use RegionInfo.areAdjacent(RegionInfo, RegionInfo).
    
    Check whether two regions are adjacent
    
    Parameters:
    
    regionA -
    
    regionB -
    
    Returns:
    
    true if two regions are adjacent

Class HRegionInfo

Field Summary

Fields inherited from interface org.apache.hadoop.hbase.client.RegionInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.hadoop.hbase.client.RegionInfo

Field Detail

LOG

ENCODED_REGION_NAME_REGEX

MAX_REPLICA_ID

endKey

offLine

regionId

regionName

split

startKey

hashCode

NO_HASH

encodedName

encodedNameAsBytes

replicaId

tableName

DISPLAY_KEYS_KEY

HIDDEN_END_KEY

HIDDEN_START_KEY

FIRST_META_REGIONINFO

Constructor Detail

HRegionInfo

HRegionInfo

HRegionInfo

HRegionInfo

HRegionInfo

HRegionInfo

HRegionInfo

HRegionInfo

HRegionInfo

Method Detail

encodeRegionName

getShortNameToLog

getShortNameToLog

getShortNameToLog

prettyPrint

setHashCode

createRegionName

createRegionName

createRegionName

createRegionName

createRegionName

getTable

getStartKey

parseRegionName

isEncodedRegionName

getRegionId

getRegionName

getRegionNameAsString

getEncodedName

getEncodedNameAsBytes

getStartKey

getEndKey

getTable

containsRange

containsRow

isMetaTable

isMetaRegion

isSystemTable

isSplit

setSplit

isOffline

setOffline

isSplitParent

getReplicaId

toString

equals

hashCode

getComparator

convert

convert

convert

toByteArray