blob: bca7f1eac6dd60b2e7b73c1619b2f23dc700ada1 [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, class: HRegionLocation">
<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;</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.client.RegionInfo;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.util.Addressing;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">023</span><span id="line-23"></span>
<span class="source-line-no">024</span><span id="line-24">/**</span>
<span class="source-line-no">025</span><span id="line-25"> * Data structure to hold RegionInfo and the address for the hosting HRegionServer. Immutable.</span>
<span class="source-line-no">026</span><span id="line-26"> * Comparable, but we compare the 'location' only: i.e. the hostname and port, and *not* the</span>
<span class="source-line-no">027</span><span id="line-27"> * regioninfo. This means two instances are the same if they refer to the same 'location' (the same</span>
<span class="source-line-no">028</span><span id="line-28"> * hostname and port), though they may be carrying different regions. On a big cluster, each client</span>
<span class="source-line-no">029</span><span id="line-29"> * will have thousands of instances of this object, often 100 000 of them if not million. It's</span>
<span class="source-line-no">030</span><span id="line-30"> * important to keep the object size as small as possible. &lt;br&gt;</span>
<span class="source-line-no">031</span><span id="line-31"> * This interface has been marked InterfaceAudience.Public in 0.96 and 0.98.</span>
<span class="source-line-no">032</span><span id="line-32"> */</span>
<span class="source-line-no">033</span><span id="line-33">@InterfaceAudience.Public</span>
<span class="source-line-no">034</span><span id="line-34">public class HRegionLocation implements Comparable&lt;HRegionLocation&gt; {</span>
<span class="source-line-no">035</span><span id="line-35"> private final RegionInfo regionInfo;</span>
<span class="source-line-no">036</span><span id="line-36"> private final ServerName serverName;</span>
<span class="source-line-no">037</span><span id="line-37"> private final long seqNum;</span>
<span class="source-line-no">038</span><span id="line-38"></span>
<span class="source-line-no">039</span><span id="line-39"> public HRegionLocation(RegionInfo regionInfo, ServerName serverName) {</span>
<span class="source-line-no">040</span><span id="line-40"> this(regionInfo, serverName, HConstants.NO_SEQNUM);</span>
<span class="source-line-no">041</span><span id="line-41"> }</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43"> public HRegionLocation(RegionInfo regionInfo, ServerName serverName, long seqNum) {</span>
<span class="source-line-no">044</span><span id="line-44"> this.regionInfo = regionInfo;</span>
<span class="source-line-no">045</span><span id="line-45"> this.serverName = serverName;</span>
<span class="source-line-no">046</span><span id="line-46"> this.seqNum = seqNum;</span>
<span class="source-line-no">047</span><span id="line-47"> }</span>
<span class="source-line-no">048</span><span id="line-48"></span>
<span class="source-line-no">049</span><span id="line-49"> /**</span>
<span class="source-line-no">050</span><span id="line-50"> * @see java.lang.Object#toString()</span>
<span class="source-line-no">051</span><span id="line-51"> */</span>
<span class="source-line-no">052</span><span id="line-52"> @Override</span>
<span class="source-line-no">053</span><span id="line-53"> public String toString() {</span>
<span class="source-line-no">054</span><span id="line-54"> return "region=" + (this.regionInfo == null ? "null" : this.regionInfo.getRegionNameAsString())</span>
<span class="source-line-no">055</span><span id="line-55"> + ", hostname=" + this.serverName + ", seqNum=" + seqNum;</span>
<span class="source-line-no">056</span><span id="line-56"> }</span>
<span class="source-line-no">057</span><span id="line-57"></span>
<span class="source-line-no">058</span><span id="line-58"> /**</span>
<span class="source-line-no">059</span><span id="line-59"> * @see java.lang.Object#equals(java.lang.Object)</span>
<span class="source-line-no">060</span><span id="line-60"> */</span>
<span class="source-line-no">061</span><span id="line-61"> @Override</span>
<span class="source-line-no">062</span><span id="line-62"> public boolean equals(Object o) {</span>
<span class="source-line-no">063</span><span id="line-63"> if (this == o) {</span>
<span class="source-line-no">064</span><span id="line-64"> return true;</span>
<span class="source-line-no">065</span><span id="line-65"> }</span>
<span class="source-line-no">066</span><span id="line-66"> if (o == null) {</span>
<span class="source-line-no">067</span><span id="line-67"> return false;</span>
<span class="source-line-no">068</span><span id="line-68"> }</span>
<span class="source-line-no">069</span><span id="line-69"> if (!(o instanceof HRegionLocation)) {</span>
<span class="source-line-no">070</span><span id="line-70"> return false;</span>
<span class="source-line-no">071</span><span id="line-71"> }</span>
<span class="source-line-no">072</span><span id="line-72"> return this.compareTo((HRegionLocation) o) == 0;</span>
<span class="source-line-no">073</span><span id="line-73"> }</span>
<span class="source-line-no">074</span><span id="line-74"></span>
<span class="source-line-no">075</span><span id="line-75"> /**</span>
<span class="source-line-no">076</span><span id="line-76"> * @see java.lang.Object#hashCode()</span>
<span class="source-line-no">077</span><span id="line-77"> */</span>
<span class="source-line-no">078</span><span id="line-78"> @Override</span>
<span class="source-line-no">079</span><span id="line-79"> public int hashCode() {</span>
<span class="source-line-no">080</span><span id="line-80"> return this.serverName.hashCode();</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"> /** Returns regionInfo */</span>
<span class="source-line-no">084</span><span id="line-84"> public RegionInfo getRegion() {</span>
<span class="source-line-no">085</span><span id="line-85"> return regionInfo;</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 String getHostname() {</span>
<span class="source-line-no">089</span><span id="line-89"> return this.serverName.getHostname();</span>
<span class="source-line-no">090</span><span id="line-90"> }</span>
<span class="source-line-no">091</span><span id="line-91"></span>
<span class="source-line-no">092</span><span id="line-92"> public int getPort() {</span>
<span class="source-line-no">093</span><span id="line-93"> return this.serverName.getPort();</span>
<span class="source-line-no">094</span><span id="line-94"> }</span>
<span class="source-line-no">095</span><span id="line-95"></span>
<span class="source-line-no">096</span><span id="line-96"> public long getSeqNum() {</span>
<span class="source-line-no">097</span><span id="line-97"> return seqNum;</span>
<span class="source-line-no">098</span><span id="line-98"> }</span>
<span class="source-line-no">099</span><span id="line-99"></span>
<span class="source-line-no">100</span><span id="line-100"> /**</span>
<span class="source-line-no">101</span><span id="line-101"> * Returns String made of hostname and port formatted as per</span>
<span class="source-line-no">102</span><span id="line-102"> * {@link Addressing#createHostAndPortStr(String, int)}</span>
<span class="source-line-no">103</span><span id="line-103"> */</span>
<span class="source-line-no">104</span><span id="line-104"> public String getHostnamePort() {</span>
<span class="source-line-no">105</span><span id="line-105"> return Addressing.createHostAndPortStr(this.getHostname(), this.getPort());</span>
<span class="source-line-no">106</span><span id="line-106"> }</span>
<span class="source-line-no">107</span><span id="line-107"></span>
<span class="source-line-no">108</span><span id="line-108"> public ServerName getServerName() {</span>
<span class="source-line-no">109</span><span id="line-109"> return serverName;</span>
<span class="source-line-no">110</span><span id="line-110"> }</span>
<span class="source-line-no">111</span><span id="line-111"></span>
<span class="source-line-no">112</span><span id="line-112"> @Override</span>
<span class="source-line-no">113</span><span id="line-113"> public int compareTo(HRegionLocation o) {</span>
<span class="source-line-no">114</span><span id="line-114"> return serverName.compareTo(o.getServerName());</span>
<span class="source-line-no">115</span><span id="line-115"> }</span>
<span class="source-line-no">116</span><span id="line-116">}</span>
</pre>
</div>
</main>
</body>
</html>