blob: c6a528a679243e9b8bf27a5d7861953804791bc1 [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.util, class: Pair">
<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.util;</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 java.io.Serializable;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">022</span><span id="line-22"></span>
<span class="source-line-no">023</span><span id="line-23">/**</span>
<span class="source-line-no">024</span><span id="line-24"> * A generic class for pairs.</span>
<span class="source-line-no">025</span><span id="line-25"> */</span>
<span class="source-line-no">026</span><span id="line-26">@InterfaceAudience.Public</span>
<span class="source-line-no">027</span><span id="line-27">public class Pair&lt;T1, T2&gt; implements Serializable {</span>
<span class="source-line-no">028</span><span id="line-28"> private static final long serialVersionUID = -3986244606585552569L;</span>
<span class="source-line-no">029</span><span id="line-29"> protected T1 first = null;</span>
<span class="source-line-no">030</span><span id="line-30"> protected T2 second = null;</span>
<span class="source-line-no">031</span><span id="line-31"></span>
<span class="source-line-no">032</span><span id="line-32"> /**</span>
<span class="source-line-no">033</span><span id="line-33"> * Default constructor.</span>
<span class="source-line-no">034</span><span id="line-34"> */</span>
<span class="source-line-no">035</span><span id="line-35"> public Pair() {</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"> /**</span>
<span class="source-line-no">039</span><span id="line-39"> * Constructor</span>
<span class="source-line-no">040</span><span id="line-40"> * @param a operand</span>
<span class="source-line-no">041</span><span id="line-41"> * @param b operand</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 Pair(T1 a, T2 b) {</span>
<span class="source-line-no">044</span><span id="line-44"> this.first = a;</span>
<span class="source-line-no">045</span><span id="line-45"> this.second = b;</span>
<span class="source-line-no">046</span><span id="line-46"> }</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"> * Constructs a new pair, inferring the type via the passed arguments</span>
<span class="source-line-no">050</span><span id="line-50"> * @param &lt;T1&gt; type for first</span>
<span class="source-line-no">051</span><span id="line-51"> * @param &lt;T2&gt; type for second</span>
<span class="source-line-no">052</span><span id="line-52"> * @param a first element</span>
<span class="source-line-no">053</span><span id="line-53"> * @param b second element</span>
<span class="source-line-no">054</span><span id="line-54"> * @return a new pair containing the passed arguments</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 &lt;T1, T2&gt; Pair&lt;T1, T2&gt; newPair(T1 a, T2 b) {</span>
<span class="source-line-no">057</span><span id="line-57"> return new Pair&lt;&gt;(a, b);</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"> /**</span>
<span class="source-line-no">061</span><span id="line-61"> * Replace the first element of the pair.</span>
<span class="source-line-no">062</span><span id="line-62"> * @param a operand</span>
<span class="source-line-no">063</span><span id="line-63"> */</span>
<span class="source-line-no">064</span><span id="line-64"> public void setFirst(T1 a) {</span>
<span class="source-line-no">065</span><span id="line-65"> this.first = a;</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"> /**</span>
<span class="source-line-no">069</span><span id="line-69"> * Replace the second element of the pair.</span>
<span class="source-line-no">070</span><span id="line-70"> * @param b operand</span>
<span class="source-line-no">071</span><span id="line-71"> */</span>
<span class="source-line-no">072</span><span id="line-72"> public void setSecond(T2 b) {</span>
<span class="source-line-no">073</span><span id="line-73"> this.second = b;</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"> /**</span>
<span class="source-line-no">077</span><span id="line-77"> * Return the first element stored in the pair.</span>
<span class="source-line-no">078</span><span id="line-78"> */</span>
<span class="source-line-no">079</span><span id="line-79"> public T1 getFirst() {</span>
<span class="source-line-no">080</span><span id="line-80"> return first;</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"> /**</span>
<span class="source-line-no">084</span><span id="line-84"> * Return the second element stored in the pair.</span>
<span class="source-line-no">085</span><span id="line-85"> */</span>
<span class="source-line-no">086</span><span id="line-86"> public T2 getSecond() {</span>
<span class="source-line-no">087</span><span id="line-87"> return second;</span>
<span class="source-line-no">088</span><span id="line-88"> }</span>
<span class="source-line-no">089</span><span id="line-89"></span>
<span class="source-line-no">090</span><span id="line-90"> private static boolean equals(Object x, Object y) {</span>
<span class="source-line-no">091</span><span id="line-91"> return (x == null &amp;&amp; y == null) || (x != null &amp;&amp; x.equals(y));</span>
<span class="source-line-no">092</span><span id="line-92"> }</span>
<span class="source-line-no">093</span><span id="line-93"></span>
<span class="source-line-no">094</span><span id="line-94"> @Override</span>
<span class="source-line-no">095</span><span id="line-95"> @SuppressWarnings("unchecked")</span>
<span class="source-line-no">096</span><span id="line-96"> public boolean equals(Object other) {</span>
<span class="source-line-no">097</span><span id="line-97"> return other instanceof Pair &amp;&amp; equals(first, ((Pair) other).first)</span>
<span class="source-line-no">098</span><span id="line-98"> &amp;&amp; equals(second, ((Pair) other).second);</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"> @Override</span>
<span class="source-line-no">102</span><span id="line-102"> public int hashCode() {</span>
<span class="source-line-no">103</span><span id="line-103"> if (first == null) {</span>
<span class="source-line-no">104</span><span id="line-104"> return (second == null) ? 0 : second.hashCode() + 1;</span>
<span class="source-line-no">105</span><span id="line-105"> } else if (second == null) {</span>
<span class="source-line-no">106</span><span id="line-106"> return first.hashCode() + 2;</span>
<span class="source-line-no">107</span><span id="line-107"> } else {</span>
<span class="source-line-no">108</span><span id="line-108"> return first.hashCode() * 17 + second.hashCode();</span>
<span class="source-line-no">109</span><span id="line-109"> }</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 String toString() {</span>
<span class="source-line-no">114</span><span id="line-114"> return "{" + getFirst() + "," + getSecond() + "}";</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>