| <!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.io, class: ImmutableBytesWritable, class: Comparator"> |
| <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.io;</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.DataInput;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.io.DataOutput;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.io.IOException;</span> |
| <span class="source-line-no">023</span><span id="line-23">import java.util.Arrays;</span> |
| <span class="source-line-no">024</span><span id="line-24">import java.util.List;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.io.BytesWritable;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.io.WritableComparable;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.io.WritableComparator;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">029</span><span id="line-29"></span> |
| <span class="source-line-no">030</span><span id="line-30">/**</span> |
| <span class="source-line-no">031</span><span id="line-31"> * A byte sequence that is usable as a key or value. Based on</span> |
| <span class="source-line-no">032</span><span id="line-32"> * {@link org.apache.hadoop.io.BytesWritable} only this class is NOT resizable and DOES NOT</span> |
| <span class="source-line-no">033</span><span id="line-33"> * distinguish between the size of the sequence and the current capacity as</span> |
| <span class="source-line-no">034</span><span id="line-34"> * {@link org.apache.hadoop.io.BytesWritable} does. Hence its comparatively 'immutable'. When</span> |
| <span class="source-line-no">035</span><span id="line-35"> * creating a new instance of this class, the underlying byte [] is not copied, just referenced. The</span> |
| <span class="source-line-no">036</span><span id="line-36"> * backing buffer is accessed when we go to serialize.</span> |
| <span class="source-line-no">037</span><span id="line-37"> */</span> |
| <span class="source-line-no">038</span><span id="line-38">@InterfaceAudience.Public</span> |
| <span class="source-line-no">039</span><span id="line-39">@edu.umd.cs.findbugs.annotations.SuppressWarnings(</span> |
| <span class="source-line-no">040</span><span id="line-40"> value = "EQ_CHECK_FOR_OPERAND_NOT_COMPATIBLE_WITH_THIS",</span> |
| <span class="source-line-no">041</span><span id="line-41"> justification = "It has been like this forever")</span> |
| <span class="source-line-no">042</span><span id="line-42">public class ImmutableBytesWritable implements WritableComparable<ImmutableBytesWritable> {</span> |
| <span class="source-line-no">043</span><span id="line-43"> private byte[] bytes;</span> |
| <span class="source-line-no">044</span><span id="line-44"> private int offset;</span> |
| <span class="source-line-no">045</span><span id="line-45"> private int length;</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"> * Create a zero-size sequence.</span> |
| <span class="source-line-no">049</span><span id="line-49"> */</span> |
| <span class="source-line-no">050</span><span id="line-50"> public ImmutableBytesWritable() {</span> |
| <span class="source-line-no">051</span><span id="line-51"> super();</span> |
| <span class="source-line-no">052</span><span id="line-52"> }</span> |
| <span class="source-line-no">053</span><span id="line-53"></span> |
| <span class="source-line-no">054</span><span id="line-54"> /**</span> |
| <span class="source-line-no">055</span><span id="line-55"> * Create a ImmutableBytesWritable using the byte array as the initial value.</span> |
| <span class="source-line-no">056</span><span id="line-56"> * @param bytes This array becomes the backing storage for the object.</span> |
| <span class="source-line-no">057</span><span id="line-57"> */</span> |
| <span class="source-line-no">058</span><span id="line-58"> public ImmutableBytesWritable(byte[] bytes) {</span> |
| <span class="source-line-no">059</span><span id="line-59"> this(bytes, 0, bytes.length);</span> |
| <span class="source-line-no">060</span><span id="line-60"> }</span> |
| <span class="source-line-no">061</span><span id="line-61"></span> |
| <span class="source-line-no">062</span><span id="line-62"> /**</span> |
| <span class="source-line-no">063</span><span id="line-63"> * Set the new ImmutableBytesWritable to the contents of the passed <code>ibw</code>.</span> |
| <span class="source-line-no">064</span><span id="line-64"> * @param ibw the value to set this ImmutableBytesWritable to.</span> |
| <span class="source-line-no">065</span><span id="line-65"> */</span> |
| <span class="source-line-no">066</span><span id="line-66"> public ImmutableBytesWritable(final ImmutableBytesWritable ibw) {</span> |
| <span class="source-line-no">067</span><span id="line-67"> this(ibw.get(), ibw.getOffset(), ibw.getLength());</span> |
| <span class="source-line-no">068</span><span id="line-68"> }</span> |
| <span class="source-line-no">069</span><span id="line-69"></span> |
| <span class="source-line-no">070</span><span id="line-70"> /**</span> |
| <span class="source-line-no">071</span><span id="line-71"> * Set the value to a given byte range</span> |
| <span class="source-line-no">072</span><span id="line-72"> * @param bytes the new byte range to set to</span> |
| <span class="source-line-no">073</span><span id="line-73"> * @param offset the offset in newData to start at</span> |
| <span class="source-line-no">074</span><span id="line-74"> * @param length the number of bytes in the range</span> |
| <span class="source-line-no">075</span><span id="line-75"> */</span> |
| <span class="source-line-no">076</span><span id="line-76"> public ImmutableBytesWritable(final byte[] bytes, final int offset, final int length) {</span> |
| <span class="source-line-no">077</span><span id="line-77"> this.bytes = bytes;</span> |
| <span class="source-line-no">078</span><span id="line-78"> this.offset = offset;</span> |
| <span class="source-line-no">079</span><span id="line-79"> this.length = length;</span> |
| <span class="source-line-no">080</span><span id="line-80"> }</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"> * Get the data from the BytesWritable.</span> |
| <span class="source-line-no">084</span><span id="line-84"> * @return The data is only valid between offset and offset+length.</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 byte[] get() {</span> |
| <span class="source-line-no">087</span><span id="line-87"> if (this.bytes == null) {</span> |
| <span class="source-line-no">088</span><span id="line-88"> throw new IllegalStateException(</span> |
| <span class="source-line-no">089</span><span id="line-89"> "Uninitialiized. Null constructor " + "called w/o accompaying readFields invocation");</span> |
| <span class="source-line-no">090</span><span id="line-90"> }</span> |
| <span class="source-line-no">091</span><span id="line-91"> return this.bytes;</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"> /** Use passed bytes as backing array for this instance. */</span> |
| <span class="source-line-no">095</span><span id="line-95"> public void set(final byte[] b) {</span> |
| <span class="source-line-no">096</span><span id="line-96"> set(b, 0, b.length);</span> |
| <span class="source-line-no">097</span><span id="line-97"> }</span> |
| <span class="source-line-no">098</span><span id="line-98"></span> |
| <span class="source-line-no">099</span><span id="line-99"> /** Use passed bytes as backing array for this instance. */</span> |
| <span class="source-line-no">100</span><span id="line-100"> public void set(final byte[] b, final int offset, final int length) {</span> |
| <span class="source-line-no">101</span><span id="line-101"> this.bytes = b;</span> |
| <span class="source-line-no">102</span><span id="line-102"> this.offset = offset;</span> |
| <span class="source-line-no">103</span><span id="line-103"> this.length = length;</span> |
| <span class="source-line-no">104</span><span id="line-104"> }</span> |
| <span class="source-line-no">105</span><span id="line-105"></span> |
| <span class="source-line-no">106</span><span id="line-106"> /** Returns the number of valid bytes in the buffer */</span> |
| <span class="source-line-no">107</span><span id="line-107"> public int getLength() {</span> |
| <span class="source-line-no">108</span><span id="line-108"> if (this.bytes == null) {</span> |
| <span class="source-line-no">109</span><span id="line-109"> throw new IllegalStateException(</span> |
| <span class="source-line-no">110</span><span id="line-110"> "Uninitialiized. Null constructor " + "called w/o accompaying readFields invocation");</span> |
| <span class="source-line-no">111</span><span id="line-111"> }</span> |
| <span class="source-line-no">112</span><span id="line-112"> return this.length;</span> |
| <span class="source-line-no">113</span><span id="line-113"> }</span> |
| <span class="source-line-no">114</span><span id="line-114"></span> |
| <span class="source-line-no">115</span><span id="line-115"> /** Return the offset into the buffer. */</span> |
| <span class="source-line-no">116</span><span id="line-116"> public int getOffset() {</span> |
| <span class="source-line-no">117</span><span id="line-117"> return this.offset;</span> |
| <span class="source-line-no">118</span><span id="line-118"> }</span> |
| <span class="source-line-no">119</span><span id="line-119"></span> |
| <span class="source-line-no">120</span><span id="line-120"> @Override</span> |
| <span class="source-line-no">121</span><span id="line-121"> public void readFields(final DataInput in) throws IOException {</span> |
| <span class="source-line-no">122</span><span id="line-122"> this.length = in.readInt();</span> |
| <span class="source-line-no">123</span><span id="line-123"> this.bytes = new byte[this.length];</span> |
| <span class="source-line-no">124</span><span id="line-124"> in.readFully(this.bytes, 0, this.length);</span> |
| <span class="source-line-no">125</span><span id="line-125"> this.offset = 0;</span> |
| <span class="source-line-no">126</span><span id="line-126"> }</span> |
| <span class="source-line-no">127</span><span id="line-127"></span> |
| <span class="source-line-no">128</span><span id="line-128"> @Override</span> |
| <span class="source-line-no">129</span><span id="line-129"> public void write(final DataOutput out) throws IOException {</span> |
| <span class="source-line-no">130</span><span id="line-130"> out.writeInt(this.length);</span> |
| <span class="source-line-no">131</span><span id="line-131"> out.write(this.bytes, this.offset, this.length);</span> |
| <span class="source-line-no">132</span><span id="line-132"> }</span> |
| <span class="source-line-no">133</span><span id="line-133"></span> |
| <span class="source-line-no">134</span><span id="line-134"> // Below methods copied from BytesWritable</span> |
| <span class="source-line-no">135</span><span id="line-135"></span> |
| <span class="source-line-no">136</span><span id="line-136"> @Override</span> |
| <span class="source-line-no">137</span><span id="line-137"> public int hashCode() {</span> |
| <span class="source-line-no">138</span><span id="line-138"> int hash = 1;</span> |
| <span class="source-line-no">139</span><span id="line-139"> for (int i = offset; i < offset + length; i++)</span> |
| <span class="source-line-no">140</span><span id="line-140"> hash = (31 * hash) + (int) bytes[i];</span> |
| <span class="source-line-no">141</span><span id="line-141"> return hash;</span> |
| <span class="source-line-no">142</span><span id="line-142"> }</span> |
| <span class="source-line-no">143</span><span id="line-143"></span> |
| <span class="source-line-no">144</span><span id="line-144"> /**</span> |
| <span class="source-line-no">145</span><span id="line-145"> * Define the sort order of the BytesWritable.</span> |
| <span class="source-line-no">146</span><span id="line-146"> * @param that The other bytes writable</span> |
| <span class="source-line-no">147</span><span id="line-147"> * @return Positive if left is bigger than right, 0 if they are equal, and negative if left is</span> |
| <span class="source-line-no">148</span><span id="line-148"> * smaller than right.</span> |
| <span class="source-line-no">149</span><span id="line-149"> */</span> |
| <span class="source-line-no">150</span><span id="line-150"> @Override</span> |
| <span class="source-line-no">151</span><span id="line-151"> public int compareTo(ImmutableBytesWritable that) {</span> |
| <span class="source-line-no">152</span><span id="line-152"> return WritableComparator.compareBytes(this.bytes, this.offset, this.length, that.bytes,</span> |
| <span class="source-line-no">153</span><span id="line-153"> that.offset, that.length);</span> |
| <span class="source-line-no">154</span><span id="line-154"> }</span> |
| <span class="source-line-no">155</span><span id="line-155"></span> |
| <span class="source-line-no">156</span><span id="line-156"> /**</span> |
| <span class="source-line-no">157</span><span id="line-157"> * Compares the bytes in this object to the specified byte array</span> |
| <span class="source-line-no">158</span><span id="line-158"> * @return Positive if left is bigger than right, 0 if they are equal, and negative if left is</span> |
| <span class="source-line-no">159</span><span id="line-159"> * smaller than right.</span> |
| <span class="source-line-no">160</span><span id="line-160"> */</span> |
| <span class="source-line-no">161</span><span id="line-161"> public int compareTo(final byte[] that) {</span> |
| <span class="source-line-no">162</span><span id="line-162"> return WritableComparator.compareBytes(this.bytes, this.offset, this.length, that, 0,</span> |
| <span class="source-line-no">163</span><span id="line-163"> that.length);</span> |
| <span class="source-line-no">164</span><span id="line-164"> }</span> |
| <span class="source-line-no">165</span><span id="line-165"></span> |
| <span class="source-line-no">166</span><span id="line-166"> @Override</span> |
| <span class="source-line-no">167</span><span id="line-167"> public boolean equals(Object right_obj) {</span> |
| <span class="source-line-no">168</span><span id="line-168"> if (right_obj instanceof byte[]) {</span> |
| <span class="source-line-no">169</span><span id="line-169"> return compareTo((byte[]) right_obj) == 0;</span> |
| <span class="source-line-no">170</span><span id="line-170"> }</span> |
| <span class="source-line-no">171</span><span id="line-171"> if (right_obj instanceof ImmutableBytesWritable) {</span> |
| <span class="source-line-no">172</span><span id="line-172"> return compareTo((ImmutableBytesWritable) right_obj) == 0;</span> |
| <span class="source-line-no">173</span><span id="line-173"> }</span> |
| <span class="source-line-no">174</span><span id="line-174"> return false;</span> |
| <span class="source-line-no">175</span><span id="line-175"> }</span> |
| <span class="source-line-no">176</span><span id="line-176"></span> |
| <span class="source-line-no">177</span><span id="line-177"> @Override</span> |
| <span class="source-line-no">178</span><span id="line-178"> public String toString() {</span> |
| <span class="source-line-no">179</span><span id="line-179"> StringBuilder sb = new StringBuilder(3 * this.length);</span> |
| <span class="source-line-no">180</span><span id="line-180"> final int endIdx = this.offset + this.length;</span> |
| <span class="source-line-no">181</span><span id="line-181"> for (int idx = this.offset; idx < endIdx; idx++) {</span> |
| <span class="source-line-no">182</span><span id="line-182"> sb.append(' ');</span> |
| <span class="source-line-no">183</span><span id="line-183"> String num = Integer.toHexString(0xff & this.bytes[idx]);</span> |
| <span class="source-line-no">184</span><span id="line-184"> // if it is only one digit, add a leading 0.</span> |
| <span class="source-line-no">185</span><span id="line-185"> if (num.length() < 2) {</span> |
| <span class="source-line-no">186</span><span id="line-186"> sb.append('0');</span> |
| <span class="source-line-no">187</span><span id="line-187"> }</span> |
| <span class="source-line-no">188</span><span id="line-188"> sb.append(num);</span> |
| <span class="source-line-no">189</span><span id="line-189"> }</span> |
| <span class="source-line-no">190</span><span id="line-190"> return sb.length() > 0 ? sb.substring(1) : "";</span> |
| <span class="source-line-no">191</span><span id="line-191"> }</span> |
| <span class="source-line-no">192</span><span id="line-192"></span> |
| <span class="source-line-no">193</span><span id="line-193"> /** A Comparator optimized for ImmutableBytesWritable. */</span> |
| <span class="source-line-no">194</span><span id="line-194"> @InterfaceAudience.Public</span> |
| <span class="source-line-no">195</span><span id="line-195"> public static class Comparator extends WritableComparator {</span> |
| <span class="source-line-no">196</span><span id="line-196"> private BytesWritable.Comparator comparator = new BytesWritable.Comparator();</span> |
| <span class="source-line-no">197</span><span id="line-197"></span> |
| <span class="source-line-no">198</span><span id="line-198"> public Comparator() {</span> |
| <span class="source-line-no">199</span><span id="line-199"> super(ImmutableBytesWritable.class);</span> |
| <span class="source-line-no">200</span><span id="line-200"> }</span> |
| <span class="source-line-no">201</span><span id="line-201"></span> |
| <span class="source-line-no">202</span><span id="line-202"> @Override</span> |
| <span class="source-line-no">203</span><span id="line-203"> public int compare(byte[] b1, int s1, int l1, byte[] b2, int s2, int l2) {</span> |
| <span class="source-line-no">204</span><span id="line-204"> return comparator.compare(b1, s1, l1, b2, s2, l2);</span> |
| <span class="source-line-no">205</span><span id="line-205"> }</span> |
| <span class="source-line-no">206</span><span id="line-206"> }</span> |
| <span class="source-line-no">207</span><span id="line-207"></span> |
| <span class="source-line-no">208</span><span id="line-208"> static { // register this comparator</span> |
| <span class="source-line-no">209</span><span id="line-209"> WritableComparator.define(ImmutableBytesWritable.class, new Comparator());</span> |
| <span class="source-line-no">210</span><span id="line-210"> }</span> |
| <span class="source-line-no">211</span><span id="line-211"></span> |
| <span class="source-line-no">212</span><span id="line-212"> /**</span> |
| <span class="source-line-no">213</span><span id="line-213"> * Convert a list of byte arrays into an array of byte arrays</span> |
| <span class="source-line-no">214</span><span id="line-214"> * @param array List of byte [].</span> |
| <span class="source-line-no">215</span><span id="line-215"> * @return Array of byte [].</span> |
| <span class="source-line-no">216</span><span id="line-216"> */</span> |
| <span class="source-line-no">217</span><span id="line-217"> public static byte[][] toArray(final List<byte[]> array) {</span> |
| <span class="source-line-no">218</span><span id="line-218"> // List#toArray doesn't work on lists of byte [].</span> |
| <span class="source-line-no">219</span><span id="line-219"> byte[][] results = new byte[array.size()][];</span> |
| <span class="source-line-no">220</span><span id="line-220"> for (int i = 0; i < array.size(); i++) {</span> |
| <span class="source-line-no">221</span><span id="line-221"> results[i] = array.get(i);</span> |
| <span class="source-line-no">222</span><span id="line-222"> }</span> |
| <span class="source-line-no">223</span><span id="line-223"> return results;</span> |
| <span class="source-line-no">224</span><span id="line-224"> }</span> |
| <span class="source-line-no">225</span><span id="line-225"></span> |
| <span class="source-line-no">226</span><span id="line-226"> /** Returns a copy of the bytes referred to by this writable */</span> |
| <span class="source-line-no">227</span><span id="line-227"> public byte[] copyBytes() {</span> |
| <span class="source-line-no">228</span><span id="line-228"> return Arrays.copyOfRange(bytes, offset, offset + length);</span> |
| <span class="source-line-no">229</span><span id="line-229"> }</span> |
| <span class="source-line-no">230</span><span id="line-230">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
