blob: c734dd04c68b3ac949f18864caf008658d0a1b18 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.client, class: RegionInfoBuilder">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.client;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import org.apache.hadoop.hbase.HConstants;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.TableName;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.util.EnvironmentEdgeManager;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">024</span><span id="line-24"></span>
<span class="source-line-no">025</span><span id="line-25">@InterfaceAudience.Private</span>
<span class="source-line-no">026</span><span id="line-26">public class RegionInfoBuilder {</span>
<span class="source-line-no">027</span><span id="line-27"></span>
<span class="source-line-no">028</span><span id="line-28"> /** A non-capture group so that this can be embedded. */</span>
<span class="source-line-no">029</span><span id="line-29"> public static final String ENCODED_REGION_NAME_REGEX = "(?:[a-f0-9]+)";</span>
<span class="source-line-no">030</span><span id="line-30"></span>
<span class="source-line-no">031</span><span id="line-31"> // TODO: Move NO_HASH to HStoreFile which is really the only place it is used.</span>
<span class="source-line-no">032</span><span id="line-32"> public static final String NO_HASH = null;</span>
<span class="source-line-no">033</span><span id="line-33"></span>
<span class="source-line-no">034</span><span id="line-34"> public static final RegionInfo UNDEFINED =</span>
<span class="source-line-no">035</span><span id="line-35"> RegionInfoBuilder.newBuilder(TableName.valueOf("__UNDEFINED__")).build();</span>
<span class="source-line-no">036</span><span id="line-36"></span>
<span class="source-line-no">037</span><span id="line-37"> /**</span>
<span class="source-line-no">038</span><span id="line-38"> * RegionInfo for first meta region You cannot use this builder to make an instance of the</span>
<span class="source-line-no">039</span><span id="line-39"> * {@link #FIRST_META_REGIONINFO}. Just refer to this instance. Also, while the instance is</span>
<span class="source-line-no">040</span><span id="line-40"> * actually a MutableRI, its type is just RI so the mutable methods are not available (unless you</span>
<span class="source-line-no">041</span><span id="line-41"> * go casting); it appears as immutable (I tried adding Immutable type but it just makes a mess).</span>
<span class="source-line-no">042</span><span id="line-42"> */</span>
<span class="source-line-no">043</span><span id="line-43"> // TODO: How come Meta regions still do not have encoded region names? Fix.</span>
<span class="source-line-no">044</span><span id="line-44"> // hbase:meta,,1.1588230740 should be the hbase:meta first region name.</span>
<span class="source-line-no">045</span><span id="line-45"> public static final RegionInfo FIRST_META_REGIONINFO =</span>
<span class="source-line-no">046</span><span id="line-46"> new MutableRegionInfo(1L, TableName.META_TABLE_NAME, RegionInfo.DEFAULT_REPLICA_ID);</span>
<span class="source-line-no">047</span><span id="line-47"></span>
<span class="source-line-no">048</span><span id="line-48"> private final TableName tableName;</span>
<span class="source-line-no">049</span><span id="line-49"> private byte[] startKey = HConstants.EMPTY_START_ROW;</span>
<span class="source-line-no">050</span><span id="line-50"> private byte[] endKey = HConstants.EMPTY_END_ROW;</span>
<span class="source-line-no">051</span><span id="line-51"> private long regionId = EnvironmentEdgeManager.currentTime();</span>
<span class="source-line-no">052</span><span id="line-52"> private int replicaId = RegionInfo.DEFAULT_REPLICA_ID;</span>
<span class="source-line-no">053</span><span id="line-53"> private boolean offLine = false;</span>
<span class="source-line-no">054</span><span id="line-54"> private boolean split = false;</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> public static RegionInfoBuilder newBuilder(TableName tableName) {</span>
<span class="source-line-no">057</span><span id="line-57"> return new RegionInfoBuilder(tableName);</span>
<span class="source-line-no">058</span><span id="line-58"> }</span>
<span class="source-line-no">059</span><span id="line-59"></span>
<span class="source-line-no">060</span><span id="line-60"> public static RegionInfoBuilder newBuilder(RegionInfo regionInfo) {</span>
<span class="source-line-no">061</span><span id="line-61"> return new RegionInfoBuilder(regionInfo);</span>
<span class="source-line-no">062</span><span id="line-62"> }</span>
<span class="source-line-no">063</span><span id="line-63"></span>
<span class="source-line-no">064</span><span id="line-64"> private RegionInfoBuilder(TableName tableName) {</span>
<span class="source-line-no">065</span><span id="line-65"> this.tableName = tableName;</span>
<span class="source-line-no">066</span><span id="line-66"> }</span>
<span class="source-line-no">067</span><span id="line-67"></span>
<span class="source-line-no">068</span><span id="line-68"> private RegionInfoBuilder(RegionInfo regionInfo) {</span>
<span class="source-line-no">069</span><span id="line-69"> this.tableName = regionInfo.getTable();</span>
<span class="source-line-no">070</span><span id="line-70"> this.startKey = regionInfo.getStartKey();</span>
<span class="source-line-no">071</span><span id="line-71"> this.endKey = regionInfo.getEndKey();</span>
<span class="source-line-no">072</span><span id="line-72"> this.offLine = regionInfo.isOffline();</span>
<span class="source-line-no">073</span><span id="line-73"> this.split = regionInfo.isSplit();</span>
<span class="source-line-no">074</span><span id="line-74"> this.regionId = regionInfo.getRegionId();</span>
<span class="source-line-no">075</span><span id="line-75"> this.replicaId = regionInfo.getReplicaId();</span>
<span class="source-line-no">076</span><span id="line-76"> }</span>
<span class="source-line-no">077</span><span id="line-77"></span>
<span class="source-line-no">078</span><span id="line-78"> public RegionInfoBuilder setStartKey(byte[] startKey) {</span>
<span class="source-line-no">079</span><span id="line-79"> this.startKey = startKey;</span>
<span class="source-line-no">080</span><span id="line-80"> return this;</span>
<span class="source-line-no">081</span><span id="line-81"> }</span>
<span class="source-line-no">082</span><span id="line-82"></span>
<span class="source-line-no">083</span><span id="line-83"> public RegionInfoBuilder setEndKey(byte[] endKey) {</span>
<span class="source-line-no">084</span><span id="line-84"> this.endKey = endKey;</span>
<span class="source-line-no">085</span><span id="line-85"> return this;</span>
<span class="source-line-no">086</span><span id="line-86"> }</span>
<span class="source-line-no">087</span><span id="line-87"></span>
<span class="source-line-no">088</span><span id="line-88"> public RegionInfoBuilder setRegionId(long regionId) {</span>
<span class="source-line-no">089</span><span id="line-89"> this.regionId = regionId;</span>
<span class="source-line-no">090</span><span id="line-90"> return this;</span>
<span class="source-line-no">091</span><span id="line-91"> }</span>
<span class="source-line-no">092</span><span id="line-92"></span>
<span class="source-line-no">093</span><span id="line-93"> public RegionInfoBuilder setReplicaId(int replicaId) {</span>
<span class="source-line-no">094</span><span id="line-94"> this.replicaId = replicaId;</span>
<span class="source-line-no">095</span><span id="line-95"> return this;</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"></span>
<span class="source-line-no">098</span><span id="line-98"> public RegionInfoBuilder setSplit(boolean split) {</span>
<span class="source-line-no">099</span><span id="line-99"> this.split = split;</span>
<span class="source-line-no">100</span><span id="line-100"> return this;</span>
<span class="source-line-no">101</span><span id="line-101"> }</span>
<span class="source-line-no">102</span><span id="line-102"></span>
<span class="source-line-no">103</span><span id="line-103"> @Deprecated</span>
<span class="source-line-no">104</span><span id="line-104"> public RegionInfoBuilder setOffline(boolean offLine) {</span>
<span class="source-line-no">105</span><span id="line-105"> this.offLine = offLine;</span>
<span class="source-line-no">106</span><span id="line-106"> return this;</span>
<span class="source-line-no">107</span><span id="line-107"> }</span>
<span class="source-line-no">108</span><span id="line-108"></span>
<span class="source-line-no">109</span><span id="line-109"> public RegionInfo build() {</span>
<span class="source-line-no">110</span><span id="line-110"> return new MutableRegionInfo(tableName, startKey, endKey, split, regionId, replicaId, offLine);</span>
<span class="source-line-no">111</span><span id="line-111"> }</span>
<span class="source-line-no">112</span><span id="line-112"></span>
<span class="source-line-no">113</span><span id="line-113">}</span>
</pre>
</div>
</main>
</body>
</html>