Package org.apache.hadoop.hbase.client

Class MutableRegionInfo

java.lang.Object

org.apache.hadoop.hbase.client.MutableRegionInfo

All Implemented Interfaces:

Comparable<RegionInfo>, RegionInfo

@Private
class MutableRegionInfo
extends Object
implements RegionInfo

An implementation of RegionInfo that adds mutable methods so can build a RegionInfo instance. Package private. Use RegionInfoBuilder creating instances of RegionInfos.

Field Summary

Fields

Modifier and Type	Field	Description
private final String	encodedName
private final byte[]	encodedNameAsBytes
private final byte[]	endKey
private final int	hashCode
private static final org.slf4j.Logger	LOG
private static final int	MAX_REPLICA_ID
private String	nameAsString
private boolean	offLine	The new format for a region name contains its encodedName at the end.
private final long	regionId
private final byte[]	regionName
private final int	replicaId
private boolean	split
private final byte[]	startKey
private final TableName	tableName

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

Constructor Summary

Constructors

Constructor	Description
MutableRegionInfo(long regionId, TableName tableName, int replicaId)	Package private constructor used constructing MutableRegionInfo for the first meta regions
MutableRegionInfo(TableName tableName, byte[] startKey, byte[] endKey, boolean split, long regionId, int replicaId, boolean offLine)

Method Summary

Modifier and Type	Method	Description
private static byte[]	checkEndKey(byte[] endKey)
private static int	checkReplicaId(int regionId)
private static byte[]	checkStartKey(byte[] startKey)
private static TableName	checkTableName(TableName tableName)
boolean	containsRange(byte[] rangeStartKey, byte[] rangeEndKey)	Returns true if the given inclusive range of rows is fully contained by this region.
boolean	containsRow(byte[] row)	Return true if the given row falls in this region.
boolean	equals(Object o)
private static int	generateHashCode(TableName tableName, byte[] startKey, byte[] endKey, long regionId, int replicaId, boolean offLine, byte[] regionName)
String	getEncodedName()	Returns the encoded region name
byte[]	getEncodedNameAsBytes()	Returns the encoded region name as an array of bytes.
byte[]	getEndKey()	Returns the endKey
long	getRegionId()	Returns the regionId
byte[]	getRegionName()	Returns the regionName as an array of bytes.
String	getRegionNameAsString()	Returns region name as a String for use in logging, tracing, etc.
int	getReplicaId()	Returns the region replica id
String	getShortNameToLog()	Returns Return a short, printable name for this region (usually encoded name) for us logging.
byte[]	getStartKey()	Returns the startKey
TableName	getTable()	Get current table name of the region
int	hashCode()
boolean	isMetaRegion()	Returns true if this region is a meta region
boolean	isOffline()	Deprecated. since 3.0.0 and will be removed in 4.0.0
boolean	isSplit()	Returns True if has been split and has daughters.
boolean	isSplitParent()	Deprecated. since 3.0.0 and will be removed in 4.0.0, Use isSplit() instead.
MutableRegionInfo	setOffline(boolean offLine)	The parent of a region split is offline while split daughters hold references to the parent.
MutableRegionInfo	setSplit(boolean split)	Change the split status flag.
String	toString()

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

compareTo, isAdjacent, isDegenerate, isFirst, isLast, isNext, isOverlap

Field Details

LOG

private static final org.slf4j.Logger LOG

MAX_REPLICA_ID

private static final int MAX_REPLICA_ID

See Also:

• Constant Field Values

offLine

private boolean offLine

The new format for a region name contains its encodedName at the end. The encoded name also serves as the directory name for the region in the filesystem. New region name format: <tablename>,,<startkey>,<regionIdTimestamp>.<encodedName>. where, <encodedName> is a hex version of the MD5 hash of <tablename>,<startkey>,<regionIdTimestamp> The old region name format: <tablename>,<startkey>,<regionIdTimestamp> For region names in the old format, the encoded name is a 32-bit JenkinsHash integer value (in its decimal notation, string form).

**NOTE** The first hbase:meta region, and regions created by an older version of HBase (0.20 or prior) will continue to use the old region name format.

split

private boolean split

regionId

private final long regionId

replicaId

private final int replicaId

regionName

private final byte[] regionName

startKey

private final byte[] startKey

endKey

private final byte[] endKey

hashCode

private final int hashCode

encodedName

private final String encodedName

encodedNameAsBytes

private final byte[] encodedNameAsBytes

nameAsString

private String nameAsString

tableName

private final TableName tableName

Constructor Details

MutableRegionInfo

MutableRegionInfo(long regionId,
 TableName tableName,
 int replicaId)

Package private constructor used constructing MutableRegionInfo for the first meta regions

MutableRegionInfo

MutableRegionInfo(TableName tableName,
 byte[] startKey,
 byte[] endKey,
 boolean split,
 long regionId,
 int replicaId,
 boolean offLine)

Method Details

generateHashCode

private static int generateHashCode(TableName tableName,
 byte[] startKey,
 byte[] endKey,
 long regionId,
 int replicaId,
 boolean offLine,
 byte[] regionName)

checkStartKey

private static byte[] checkStartKey(byte[] startKey)

checkEndKey

private static byte[] checkEndKey(byte[] endKey)

checkTableName

private static TableName checkTableName(TableName tableName)

checkReplicaId

private static int checkReplicaId(int regionId)

getShortNameToLog

public String getShortNameToLog()

Returns Return a short, printable name for this region (usually encoded name) for us logging.

Specified by:

getShortNameToLog in interface RegionInfo

getRegionId

public long getRegionId()

Returns the regionId

Specified by:

getRegionId in interface RegionInfo

getRegionName

public byte[] getRegionName()

Description copied from interface: RegionInfo

Returns the regionName as an array of bytes.

Specified by:

getRegionName in interface RegionInfo

Returns:

the regionName as an array of bytes.

See Also:

• getRegionNameAsString()

getRegionNameAsString

public String getRegionNameAsString()

Returns region name as a String for use in logging, tracing, etc. Expensive enough to compute that we do it on first request and save it. Used often because it's included in trace of every RPC.

Specified by:

getRegionNameAsString in interface RegionInfo

getEncodedName

public String getEncodedName()

Returns the encoded region name

Specified by:

getEncodedName in interface RegionInfo

getEncodedNameAsBytes

public byte[] getEncodedNameAsBytes()

Description copied from interface: RegionInfo

Returns the encoded region name as an array of bytes.

Specified by:

getEncodedNameAsBytes in interface RegionInfo

getStartKey

public byte[] getStartKey()

Returns the startKey

Specified by:

getStartKey in interface RegionInfo

getEndKey

public byte[] getEndKey()

Returns the endKey

Specified by:

getEndKey in interface RegionInfo

getTable

public TableName getTable()

Get current table name of the region

Specified by:

getTable in interface RegionInfo

containsRange

public boolean containsRange(byte[] rangeStartKey,
 byte[] rangeEndKey)

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

Throws:

IllegalArgumentException - if the range passed is invalid (ie. end < start)

containsRow

public boolean containsRow(byte[] row)

Return true if the given row falls in this region.

Specified by:

containsRow in interface RegionInfo

isMetaRegion

public boolean isMetaRegion()

Returns true if this region is a meta region

Specified by:

isMetaRegion in interface RegionInfo

isSplit

public boolean isSplit()

Returns True if has been split and has daughters.

Specified by:

isSplit in interface RegionInfo

setSplit

public MutableRegionInfo setSplit(boolean split)

Change the split status flag.

Parameters:

split - set split status

isOffline

@Deprecated
public boolean isOffline()

Deprecated.

since 3.0.0 and will be removed in 4.0.0

Description copied from interface: RegionInfo

Returns True if this region is offline.

Specified by:

isOffline in interface RegionInfo

Returns:

True if this region is offline.

See Also:

• HBASE-25210

setOffline

public MutableRegionInfo setOffline(boolean offLine)

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

@Deprecated
public boolean isSplitParent()

Deprecated.

since 3.0.0 and will be removed in 4.0.0, Use isSplit() instead.

Description copied from interface: RegionInfo

Returns True if this is a split parent region.

Specified by:

isSplitParent in interface RegionInfo

Returns:

True if this is a split parent region.

See Also:

• HBASE-25210

getReplicaId

public int getReplicaId()

Returns the region replica id

Specified by:

getReplicaId in interface RegionInfo

Returns:

returns region replica id

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

See Also:

• Object.equals(Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()