blob: 4553e58c0c9367b3c29ed0c97f5245d08626e147 [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: KeyValueUtil">
<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 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.EOFException;</span>
<span class="source-line-no">023</span><span id="line-23">import java.io.IOException;</span>
<span class="source-line-no">024</span><span id="line-24">import java.io.InputStream;</span>
<span class="source-line-no">025</span><span id="line-25">import java.nio.ByteBuffer;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.ArrayList;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.List;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.hbase.util.ByteBufferUtils;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">030</span><span id="line-30">import org.apache.hadoop.io.IOUtils;</span>
<span class="source-line-no">031</span><span id="line-31">import org.apache.hadoop.io.WritableUtils;</span>
<span class="source-line-no">032</span><span id="line-32">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">033</span><span id="line-33">import org.slf4j.Logger;</span>
<span class="source-line-no">034</span><span id="line-34">import org.slf4j.LoggerFactory;</span>
<span class="source-line-no">035</span><span id="line-35"></span>
<span class="source-line-no">036</span><span id="line-36">import org.apache.hbase.thirdparty.com.google.common.base.Function;</span>
<span class="source-line-no">037</span><span id="line-37">import org.apache.hbase.thirdparty.com.google.common.collect.Lists;</span>
<span class="source-line-no">038</span><span id="line-38">import org.apache.hbase.thirdparty.org.apache.commons.collections4.IterableUtils;</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40">/**</span>
<span class="source-line-no">041</span><span id="line-41"> * static convenience methods for dealing with KeyValues and collections of KeyValues</span>
<span class="source-line-no">042</span><span id="line-42"> */</span>
<span class="source-line-no">043</span><span id="line-43">@InterfaceAudience.Private</span>
<span class="source-line-no">044</span><span id="line-44">public class KeyValueUtil {</span>
<span class="source-line-no">045</span><span id="line-45"></span>
<span class="source-line-no">046</span><span id="line-46"> private static final Logger LOG = LoggerFactory.getLogger(KeyValueUtil.class);</span>
<span class="source-line-no">047</span><span id="line-47"></span>
<span class="source-line-no">048</span><span id="line-48"> /**************** length *********************/</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 static int length(short rlen, byte flen, int qlen, int vlen, int tlen, boolean withTags) {</span>
<span class="source-line-no">051</span><span id="line-51"> if (withTags) {</span>
<span class="source-line-no">052</span><span id="line-52"> return (int) KeyValue.getKeyValueDataStructureSize(rlen, flen, qlen, vlen, tlen);</span>
<span class="source-line-no">053</span><span id="line-53"> }</span>
<span class="source-line-no">054</span><span id="line-54"> return (int) KeyValue.getKeyValueDataStructureSize(rlen, flen, qlen, vlen);</span>
<span class="source-line-no">055</span><span id="line-55"> }</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"> * Returns number of bytes this cell's key part would have been used if serialized as in</span>
<span class="source-line-no">059</span><span id="line-59"> * {@link KeyValue}. Key includes rowkey, family, qualifier, timestamp and type.</span>
<span class="source-line-no">060</span><span id="line-60"> * @return the key length</span>
<span class="source-line-no">061</span><span id="line-61"> */</span>
<span class="source-line-no">062</span><span id="line-62"> public static int keyLength(final Cell cell) {</span>
<span class="source-line-no">063</span><span id="line-63"> return keyLength(cell.getRowLength(), cell.getFamilyLength(), cell.getQualifierLength());</span>
<span class="source-line-no">064</span><span id="line-64"> }</span>
<span class="source-line-no">065</span><span id="line-65"></span>
<span class="source-line-no">066</span><span id="line-66"> private static int keyLength(short rlen, byte flen, int qlen) {</span>
<span class="source-line-no">067</span><span id="line-67"> return (int) KeyValue.getKeyDataStructureSize(rlen, flen, qlen);</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"> public static int lengthWithMvccVersion(final KeyValue kv, final boolean includeMvccVersion) {</span>
<span class="source-line-no">071</span><span id="line-71"> int length = kv.getLength();</span>
<span class="source-line-no">072</span><span id="line-72"> if (includeMvccVersion) {</span>
<span class="source-line-no">073</span><span id="line-73"> length += WritableUtils.getVIntSize(kv.getSequenceId());</span>
<span class="source-line-no">074</span><span id="line-74"> }</span>
<span class="source-line-no">075</span><span id="line-75"> return length;</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 static int totalLengthWithMvccVersion(final Iterable&lt;? extends KeyValue&gt; kvs,</span>
<span class="source-line-no">079</span><span id="line-79"> final boolean includeMvccVersion) {</span>
<span class="source-line-no">080</span><span id="line-80"> int length = 0;</span>
<span class="source-line-no">081</span><span id="line-81"> for (KeyValue kv : IterableUtils.emptyIfNull(kvs)) {</span>
<span class="source-line-no">082</span><span id="line-82"> length += lengthWithMvccVersion(kv, includeMvccVersion);</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 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"></span>
<span class="source-line-no">087</span><span id="line-87"> /**************** copy the cell to create a new keyvalue *********************/</span>
<span class="source-line-no">088</span><span id="line-88"></span>
<span class="source-line-no">089</span><span id="line-89"> public static KeyValue copyToNewKeyValue(final ExtendedCell cell) {</span>
<span class="source-line-no">090</span><span id="line-90"> byte[] bytes = copyToNewByteArray(cell);</span>
<span class="source-line-no">091</span><span id="line-91"> KeyValue kvCell = new KeyValue(bytes, 0, bytes.length);</span>
<span class="source-line-no">092</span><span id="line-92"> kvCell.setSequenceId(cell.getSequenceId());</span>
<span class="source-line-no">093</span><span id="line-93"> return kvCell;</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"> /**</span>
<span class="source-line-no">097</span><span id="line-97"> * The position will be set to the beginning of the new ByteBuffer</span>
<span class="source-line-no">098</span><span id="line-98"> * @return the Bytebuffer containing the key part of the cell</span>
<span class="source-line-no">099</span><span id="line-99"> */</span>
<span class="source-line-no">100</span><span id="line-100"> public static ByteBuffer copyKeyToNewByteBuffer(final ExtendedCell cell) {</span>
<span class="source-line-no">101</span><span id="line-101"> byte[] bytes = new byte[keyLength(cell)];</span>
<span class="source-line-no">102</span><span id="line-102"> appendKeyTo(cell, bytes, 0);</span>
<span class="source-line-no">103</span><span id="line-103"> ByteBuffer buffer = ByteBuffer.wrap(bytes);</span>
<span class="source-line-no">104</span><span id="line-104"> return buffer;</span>
<span class="source-line-no">105</span><span id="line-105"> }</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"> * Copies the key to a new KeyValue</span>
<span class="source-line-no">109</span><span id="line-109"> * @return the KeyValue that consists only the key part of the incoming cell</span>
<span class="source-line-no">110</span><span id="line-110"> */</span>
<span class="source-line-no">111</span><span id="line-111"> public static KeyValue toNewKeyCell(final ExtendedCell cell) {</span>
<span class="source-line-no">112</span><span id="line-112"> byte[] bytes = new byte[keyLength(cell)];</span>
<span class="source-line-no">113</span><span id="line-113"> appendKeyTo(cell, bytes, 0);</span>
<span class="source-line-no">114</span><span id="line-114"> KeyValue kv = new KeyValue.KeyOnlyKeyValue(bytes, 0, bytes.length);</span>
<span class="source-line-no">115</span><span id="line-115"> // Set the seq id. The new key cell could be used in comparisons so it</span>
<span class="source-line-no">116</span><span id="line-116"> // is important that it uses the seqid also. If not the comparsion would fail</span>
<span class="source-line-no">117</span><span id="line-117"> kv.setSequenceId(cell.getSequenceId());</span>
<span class="source-line-no">118</span><span id="line-118"> return kv;</span>
<span class="source-line-no">119</span><span id="line-119"> }</span>
<span class="source-line-no">120</span><span id="line-120"></span>
<span class="source-line-no">121</span><span id="line-121"> public static byte[] copyToNewByteArray(final ExtendedCell cell) {</span>
<span class="source-line-no">122</span><span id="line-122"> // Cell#getSerializedSize returns the serialized size of the Source cell, which may</span>
<span class="source-line-no">123</span><span id="line-123"> // not serialize all fields. We are constructing a KeyValue backing array here,</span>
<span class="source-line-no">124</span><span id="line-124"> // which does include all fields, and must allocate accordingly.</span>
<span class="source-line-no">125</span><span id="line-125"> // TODO we could probably use Cell#getSerializedSize safely, the errors were</span>
<span class="source-line-no">126</span><span id="line-126"> // caused by cells corrupted by use-after-free bugs</span>
<span class="source-line-no">127</span><span id="line-127"> int v1Length = length(cell.getRowLength(), cell.getFamilyLength(), cell.getQualifierLength(),</span>
<span class="source-line-no">128</span><span id="line-128"> cell.getValueLength(), cell.getTagsLength(), true);</span>
<span class="source-line-no">129</span><span id="line-129"> byte[] backingBytes = new byte[v1Length];</span>
<span class="source-line-no">130</span><span id="line-130"> appendToByteArray(cell, backingBytes, 0, true);</span>
<span class="source-line-no">131</span><span id="line-131"> return backingBytes;</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"> public static int appendKeyTo(final ExtendedCell cell, final byte[] output, final int offset) {</span>
<span class="source-line-no">135</span><span id="line-135"> int nextOffset = offset;</span>
<span class="source-line-no">136</span><span id="line-136"> nextOffset = Bytes.putShort(output, nextOffset, cell.getRowLength());</span>
<span class="source-line-no">137</span><span id="line-137"> nextOffset = CellUtil.copyRowTo(cell, output, nextOffset);</span>
<span class="source-line-no">138</span><span id="line-138"> nextOffset = Bytes.putByte(output, nextOffset, cell.getFamilyLength());</span>
<span class="source-line-no">139</span><span id="line-139"> nextOffset = CellUtil.copyFamilyTo(cell, output, nextOffset);</span>
<span class="source-line-no">140</span><span id="line-140"> nextOffset = CellUtil.copyQualifierTo(cell, output, nextOffset);</span>
<span class="source-line-no">141</span><span id="line-141"> nextOffset = Bytes.putLong(output, nextOffset, cell.getTimestamp());</span>
<span class="source-line-no">142</span><span id="line-142"> nextOffset = Bytes.putByte(output, nextOffset, cell.getTypeByte());</span>
<span class="source-line-no">143</span><span id="line-143"> return nextOffset;</span>
<span class="source-line-no">144</span><span id="line-144"> }</span>
<span class="source-line-no">145</span><span id="line-145"></span>
<span class="source-line-no">146</span><span id="line-146"> /**************** copy key and value *********************/</span>
<span class="source-line-no">147</span><span id="line-147"></span>
<span class="source-line-no">148</span><span id="line-148"> public static int appendToByteArray(ExtendedCell cell, byte[] output, int offset,</span>
<span class="source-line-no">149</span><span id="line-149"> boolean withTags) {</span>
<span class="source-line-no">150</span><span id="line-150"> int pos = offset;</span>
<span class="source-line-no">151</span><span id="line-151"> pos = Bytes.putInt(output, pos, keyLength(cell));</span>
<span class="source-line-no">152</span><span id="line-152"> pos = Bytes.putInt(output, pos, cell.getValueLength());</span>
<span class="source-line-no">153</span><span id="line-153"> pos = appendKeyTo(cell, output, pos);</span>
<span class="source-line-no">154</span><span id="line-154"> pos = CellUtil.copyValueTo(cell, output, pos);</span>
<span class="source-line-no">155</span><span id="line-155"> if (withTags &amp;&amp; (cell.getTagsLength() &gt; 0)) {</span>
<span class="source-line-no">156</span><span id="line-156"> pos = Bytes.putAsShort(output, pos, cell.getTagsLength());</span>
<span class="source-line-no">157</span><span id="line-157"> pos = PrivateCellUtil.copyTagsTo(cell, output, pos);</span>
<span class="source-line-no">158</span><span id="line-158"> }</span>
<span class="source-line-no">159</span><span id="line-159"> return pos;</span>
<span class="source-line-no">160</span><span id="line-160"> }</span>
<span class="source-line-no">161</span><span id="line-161"></span>
<span class="source-line-no">162</span><span id="line-162"> /**</span>
<span class="source-line-no">163</span><span id="line-163"> * Copy the Cell content into the passed buf in KeyValue serialization format.</span>
<span class="source-line-no">164</span><span id="line-164"> */</span>
<span class="source-line-no">165</span><span id="line-165"> public static int appendTo(ExtendedCell cell, ByteBuffer buf, int offset, boolean withTags) {</span>
<span class="source-line-no">166</span><span id="line-166"> offset = ByteBufferUtils.putInt(buf, offset, keyLength(cell));// Key length</span>
<span class="source-line-no">167</span><span id="line-167"> offset = ByteBufferUtils.putInt(buf, offset, cell.getValueLength());// Value length</span>
<span class="source-line-no">168</span><span id="line-168"> offset = appendKeyTo(cell, buf, offset);</span>
<span class="source-line-no">169</span><span id="line-169"> offset = CellUtil.copyValueTo(cell, buf, offset);// Value bytes</span>
<span class="source-line-no">170</span><span id="line-170"> int tagsLength = cell.getTagsLength();</span>
<span class="source-line-no">171</span><span id="line-171"> if (withTags &amp;&amp; (tagsLength &gt; 0)) {</span>
<span class="source-line-no">172</span><span id="line-172"> offset = ByteBufferUtils.putAsShort(buf, offset, tagsLength);// Tags length</span>
<span class="source-line-no">173</span><span id="line-173"> offset = PrivateCellUtil.copyTagsTo(cell, buf, offset);// Tags bytes</span>
<span class="source-line-no">174</span><span id="line-174"> }</span>
<span class="source-line-no">175</span><span id="line-175"> return offset;</span>
<span class="source-line-no">176</span><span id="line-176"> }</span>
<span class="source-line-no">177</span><span id="line-177"></span>
<span class="source-line-no">178</span><span id="line-178"> public static int appendKeyTo(ExtendedCell cell, ByteBuffer buf, int offset) {</span>
<span class="source-line-no">179</span><span id="line-179"> offset = ByteBufferUtils.putShort(buf, offset, cell.getRowLength());// RK length</span>
<span class="source-line-no">180</span><span id="line-180"> offset = CellUtil.copyRowTo(cell, buf, offset);// Row bytes</span>
<span class="source-line-no">181</span><span id="line-181"> offset = ByteBufferUtils.putByte(buf, offset, cell.getFamilyLength());// CF length</span>
<span class="source-line-no">182</span><span id="line-182"> offset = CellUtil.copyFamilyTo(cell, buf, offset);// CF bytes</span>
<span class="source-line-no">183</span><span id="line-183"> offset = CellUtil.copyQualifierTo(cell, buf, offset);// Qualifier bytes</span>
<span class="source-line-no">184</span><span id="line-184"> offset = ByteBufferUtils.putLong(buf, offset, cell.getTimestamp());// TS</span>
<span class="source-line-no">185</span><span id="line-185"> offset = ByteBufferUtils.putByte(buf, offset, cell.getTypeByte());// Type</span>
<span class="source-line-no">186</span><span id="line-186"> return offset;</span>
<span class="source-line-no">187</span><span id="line-187"> }</span>
<span class="source-line-no">188</span><span id="line-188"></span>
<span class="source-line-no">189</span><span id="line-189"> public static void appendToByteBuffer(final ByteBuffer bb, final KeyValue kv,</span>
<span class="source-line-no">190</span><span id="line-190"> final boolean includeMvccVersion) {</span>
<span class="source-line-no">191</span><span id="line-191"> // keep pushing the limit out. assume enough capacity</span>
<span class="source-line-no">192</span><span id="line-192"> bb.limit(bb.position() + kv.getLength());</span>
<span class="source-line-no">193</span><span id="line-193"> bb.put(kv.getBuffer(), kv.getOffset(), kv.getLength());</span>
<span class="source-line-no">194</span><span id="line-194"> if (includeMvccVersion) {</span>
<span class="source-line-no">195</span><span id="line-195"> int numMvccVersionBytes = WritableUtils.getVIntSize(kv.getSequenceId());</span>
<span class="source-line-no">196</span><span id="line-196"> ByteBufferUtils.extendLimit(bb, numMvccVersionBytes);</span>
<span class="source-line-no">197</span><span id="line-197"> ByteBufferUtils.writeVLong(bb, kv.getSequenceId());</span>
<span class="source-line-no">198</span><span id="line-198"> }</span>
<span class="source-line-no">199</span><span id="line-199"> }</span>
<span class="source-line-no">200</span><span id="line-200"></span>
<span class="source-line-no">201</span><span id="line-201"> /**************** iterating *******************************/</span>
<span class="source-line-no">202</span><span id="line-202"></span>
<span class="source-line-no">203</span><span id="line-203"> /**</span>
<span class="source-line-no">204</span><span id="line-204"> * Creates a new KeyValue object positioned in the supplied ByteBuffer and sets the ByteBuffer's</span>
<span class="source-line-no">205</span><span id="line-205"> * position to the start of the next KeyValue. Does not allocate a new array or copy data.</span>
<span class="source-line-no">206</span><span id="line-206"> */</span>
<span class="source-line-no">207</span><span id="line-207"> public static KeyValue nextShallowCopy(final ByteBuffer bb, final boolean includesMvccVersion,</span>
<span class="source-line-no">208</span><span id="line-208"> boolean includesTags) {</span>
<span class="source-line-no">209</span><span id="line-209"> if (bb.isDirect()) {</span>
<span class="source-line-no">210</span><span id="line-210"> throw new IllegalArgumentException("only supports heap buffers");</span>
<span class="source-line-no">211</span><span id="line-211"> }</span>
<span class="source-line-no">212</span><span id="line-212"> if (bb.remaining() &lt; 1) {</span>
<span class="source-line-no">213</span><span id="line-213"> return null;</span>
<span class="source-line-no">214</span><span id="line-214"> }</span>
<span class="source-line-no">215</span><span id="line-215"> int underlyingArrayOffset = bb.arrayOffset() + bb.position();</span>
<span class="source-line-no">216</span><span id="line-216"> int keyLength = bb.getInt();</span>
<span class="source-line-no">217</span><span id="line-217"> int valueLength = bb.getInt();</span>
<span class="source-line-no">218</span><span id="line-218"> ByteBufferUtils.skip(bb, keyLength + valueLength);</span>
<span class="source-line-no">219</span><span id="line-219"> int tagsLength = 0;</span>
<span class="source-line-no">220</span><span id="line-220"> if (includesTags) {</span>
<span class="source-line-no">221</span><span id="line-221"> // Read short as unsigned, high byte first</span>
<span class="source-line-no">222</span><span id="line-222"> tagsLength = ((bb.get() &amp; 0xff) &lt;&lt; 8) ^ (bb.get() &amp; 0xff);</span>
<span class="source-line-no">223</span><span id="line-223"> ByteBufferUtils.skip(bb, tagsLength);</span>
<span class="source-line-no">224</span><span id="line-224"> }</span>
<span class="source-line-no">225</span><span id="line-225"> int kvLength = (int) KeyValue.getKeyValueDataStructureSize(keyLength, valueLength, tagsLength);</span>
<span class="source-line-no">226</span><span id="line-226"> KeyValue keyValue = new KeyValue(bb.array(), underlyingArrayOffset, kvLength);</span>
<span class="source-line-no">227</span><span id="line-227"> if (includesMvccVersion) {</span>
<span class="source-line-no">228</span><span id="line-228"> long mvccVersion = ByteBufferUtils.readVLong(bb);</span>
<span class="source-line-no">229</span><span id="line-229"> keyValue.setSequenceId(mvccVersion);</span>
<span class="source-line-no">230</span><span id="line-230"> }</span>
<span class="source-line-no">231</span><span id="line-231"> return keyValue;</span>
<span class="source-line-no">232</span><span id="line-232"> }</span>
<span class="source-line-no">233</span><span id="line-233"></span>
<span class="source-line-no">234</span><span id="line-234"> /*************** next/previous **********************************/</span>
<span class="source-line-no">235</span><span id="line-235"></span>
<span class="source-line-no">236</span><span id="line-236"> /**</span>
<span class="source-line-no">237</span><span id="line-237"> * Decrement the timestamp. For tests (currently wasteful) Remember timestamps are sorted reverse</span>
<span class="source-line-no">238</span><span id="line-238"> * chronologically.</span>
<span class="source-line-no">239</span><span id="line-239"> * @return previous key</span>
<span class="source-line-no">240</span><span id="line-240"> */</span>
<span class="source-line-no">241</span><span id="line-241"> public static KeyValue previousKey(final KeyValue in) {</span>
<span class="source-line-no">242</span><span id="line-242"> return createFirstOnRow(CellUtil.cloneRow(in), CellUtil.cloneFamily(in),</span>
<span class="source-line-no">243</span><span id="line-243"> CellUtil.cloneQualifier(in), in.getTimestamp() - 1);</span>
<span class="source-line-no">244</span><span id="line-244"> }</span>
<span class="source-line-no">245</span><span id="line-245"></span>
<span class="source-line-no">246</span><span id="line-246"> /**</span>
<span class="source-line-no">247</span><span id="line-247"> * Create a KeyValue for the specified row, family and qualifier that would be larger than or</span>
<span class="source-line-no">248</span><span id="line-248"> * equal to all other possible KeyValues that have the same row, family, qualifier. Used for</span>
<span class="source-line-no">249</span><span id="line-249"> * reseeking. Should NEVER be returned to a client. row key row offset row length family name</span>
<span class="source-line-no">250</span><span id="line-250"> * family offset family length column qualifier qualifier offset qualifier length</span>
<span class="source-line-no">251</span><span id="line-251"> * @return Last possible key on passed row, family, qualifier.</span>
<span class="source-line-no">252</span><span id="line-252"> */</span>
<span class="source-line-no">253</span><span id="line-253"> public static KeyValue createLastOnRow(final byte[] row, final int roffset, final int rlength,</span>
<span class="source-line-no">254</span><span id="line-254"> final byte[] family, final int foffset, final int flength, final byte[] qualifier,</span>
<span class="source-line-no">255</span><span id="line-255"> final int qoffset, final int qlength) {</span>
<span class="source-line-no">256</span><span id="line-256"> return new KeyValue(row, roffset, rlength, family, foffset, flength, qualifier, qoffset,</span>
<span class="source-line-no">257</span><span id="line-257"> qlength, PrivateConstants.OLDEST_TIMESTAMP, KeyValue.Type.Minimum, null, 0, 0);</span>
<span class="source-line-no">258</span><span id="line-258"> }</span>
<span class="source-line-no">259</span><span id="line-259"></span>
<span class="source-line-no">260</span><span id="line-260"> /**</span>
<span class="source-line-no">261</span><span id="line-261"> * Create a KeyValue that is smaller than all other possible KeyValues for the given row. That is</span>
<span class="source-line-no">262</span><span id="line-262"> * any (valid) KeyValue on 'row' would sort _after_ the result.</span>
<span class="source-line-no">263</span><span id="line-263"> * @param row - row key (arbitrary byte array)</span>
<span class="source-line-no">264</span><span id="line-264"> * @return First possible KeyValue on passed &lt;code&gt;row&lt;/code&gt;</span>
<span class="source-line-no">265</span><span id="line-265"> */</span>
<span class="source-line-no">266</span><span id="line-266"> public static KeyValue createFirstOnRow(final byte[] row, int roffset, short rlength) {</span>
<span class="source-line-no">267</span><span id="line-267"> return new KeyValue(row, roffset, rlength, null, 0, 0, null, 0, 0, HConstants.LATEST_TIMESTAMP,</span>
<span class="source-line-no">268</span><span id="line-268"> KeyValue.Type.Maximum, null, 0, 0);</span>
<span class="source-line-no">269</span><span id="line-269"> }</span>
<span class="source-line-no">270</span><span id="line-270"></span>
<span class="source-line-no">271</span><span id="line-271"> /**</span>
<span class="source-line-no">272</span><span id="line-272"> * Creates a KeyValue that is last on the specified row id. That is, every other possible KeyValue</span>
<span class="source-line-no">273</span><span id="line-273"> * for the given row would compareTo() less than the result of this call.</span>
<span class="source-line-no">274</span><span id="line-274"> * @param row row key</span>
<span class="source-line-no">275</span><span id="line-275"> * @return Last possible KeyValue on passed &lt;code&gt;row&lt;/code&gt;</span>
<span class="source-line-no">276</span><span id="line-276"> */</span>
<span class="source-line-no">277</span><span id="line-277"> public static KeyValue createLastOnRow(final byte[] row) {</span>
<span class="source-line-no">278</span><span id="line-278"> return new KeyValue(row, null, null, HConstants.LATEST_TIMESTAMP, KeyValue.Type.Minimum);</span>
<span class="source-line-no">279</span><span id="line-279"> }</span>
<span class="source-line-no">280</span><span id="line-280"></span>
<span class="source-line-no">281</span><span id="line-281"> /**</span>
<span class="source-line-no">282</span><span id="line-282"> * Create a KeyValue that is smaller than all other possible KeyValues for the given row. That is</span>
<span class="source-line-no">283</span><span id="line-283"> * any (valid) KeyValue on 'row' would sort _after_ the result.</span>
<span class="source-line-no">284</span><span id="line-284"> * @param row - row key (arbitrary byte array)</span>
<span class="source-line-no">285</span><span id="line-285"> * @return First possible KeyValue on passed &lt;code&gt;row&lt;/code&gt;</span>
<span class="source-line-no">286</span><span id="line-286"> */</span>
<span class="source-line-no">287</span><span id="line-287"> public static KeyValue createFirstOnRow(final byte[] row) {</span>
<span class="source-line-no">288</span><span id="line-288"> return createFirstOnRow(row, HConstants.LATEST_TIMESTAMP);</span>
<span class="source-line-no">289</span><span id="line-289"> }</span>
<span class="source-line-no">290</span><span id="line-290"></span>
<span class="source-line-no">291</span><span id="line-291"> /**</span>
<span class="source-line-no">292</span><span id="line-292"> * Creates a KeyValue that is smaller than all other KeyValues that are older than the passed</span>
<span class="source-line-no">293</span><span id="line-293"> * timestamp.</span>
<span class="source-line-no">294</span><span id="line-294"> * @param row - row key (arbitrary byte array)</span>
<span class="source-line-no">295</span><span id="line-295"> * @param ts - timestamp</span>
<span class="source-line-no">296</span><span id="line-296"> * @return First possible key on passed &lt;code&gt;row&lt;/code&gt; and timestamp.</span>
<span class="source-line-no">297</span><span id="line-297"> */</span>
<span class="source-line-no">298</span><span id="line-298"> public static KeyValue createFirstOnRow(final byte[] row, final long ts) {</span>
<span class="source-line-no">299</span><span id="line-299"> return new KeyValue(row, null, null, ts, KeyValue.Type.Maximum);</span>
<span class="source-line-no">300</span><span id="line-300"> }</span>
<span class="source-line-no">301</span><span id="line-301"></span>
<span class="source-line-no">302</span><span id="line-302"> /**</span>
<span class="source-line-no">303</span><span id="line-303"> * Create a KeyValue for the specified row, family and qualifier that would be smaller than all</span>
<span class="source-line-no">304</span><span id="line-304"> * other possible KeyValues that have the same row,family,qualifier. Used for seeking.</span>
<span class="source-line-no">305</span><span id="line-305"> * @param row - row key (arbitrary byte array)</span>
<span class="source-line-no">306</span><span id="line-306"> * @param family - family name</span>
<span class="source-line-no">307</span><span id="line-307"> * @param qualifier - column qualifier</span>
<span class="source-line-no">308</span><span id="line-308"> * @return First possible key on passed &lt;code&gt;row&lt;/code&gt;, and column.</span>
<span class="source-line-no">309</span><span id="line-309"> */</span>
<span class="source-line-no">310</span><span id="line-310"> public static KeyValue createFirstOnRow(final byte[] row, final byte[] family,</span>
<span class="source-line-no">311</span><span id="line-311"> final byte[] qualifier) {</span>
<span class="source-line-no">312</span><span id="line-312"> return new KeyValue(row, family, qualifier, HConstants.LATEST_TIMESTAMP, KeyValue.Type.Maximum);</span>
<span class="source-line-no">313</span><span id="line-313"> }</span>
<span class="source-line-no">314</span><span id="line-314"></span>
<span class="source-line-no">315</span><span id="line-315"> /**</span>
<span class="source-line-no">316</span><span id="line-316"> * Create a KeyValue for the specified row, family and qualifier that would be smaller than all</span>
<span class="source-line-no">317</span><span id="line-317"> * other possible KeyValues that have the same row, family, qualifier. Used for seeking.</span>
<span class="source-line-no">318</span><span id="line-318"> * @param row - row key (arbitrary byte array)</span>
<span class="source-line-no">319</span><span id="line-319"> * @param f - family name</span>
<span class="source-line-no">320</span><span id="line-320"> * @param q - column qualifier</span>
<span class="source-line-no">321</span><span id="line-321"> * @param ts - timestamp</span>
<span class="source-line-no">322</span><span id="line-322"> * @return First possible key on passed &lt;code&gt;row&lt;/code&gt;, column and timestamp</span>
<span class="source-line-no">323</span><span id="line-323"> */</span>
<span class="source-line-no">324</span><span id="line-324"> public static KeyValue createFirstOnRow(final byte[] row, final byte[] f, final byte[] q,</span>
<span class="source-line-no">325</span><span id="line-325"> final long ts) {</span>
<span class="source-line-no">326</span><span id="line-326"> return new KeyValue(row, f, q, ts, KeyValue.Type.Maximum);</span>
<span class="source-line-no">327</span><span id="line-327"> }</span>
<span class="source-line-no">328</span><span id="line-328"></span>
<span class="source-line-no">329</span><span id="line-329"> /**</span>
<span class="source-line-no">330</span><span id="line-330"> * Create a KeyValue for the specified row, family and qualifier that would be smaller than all</span>
<span class="source-line-no">331</span><span id="line-331"> * other possible KeyValues that have the same row, family, qualifier. Used for seeking.</span>
<span class="source-line-no">332</span><span id="line-332"> * @param row row key</span>
<span class="source-line-no">333</span><span id="line-333"> * @param roffset row offset</span>
<span class="source-line-no">334</span><span id="line-334"> * @param rlength row length</span>
<span class="source-line-no">335</span><span id="line-335"> * @param family family name</span>
<span class="source-line-no">336</span><span id="line-336"> * @param foffset family offset</span>
<span class="source-line-no">337</span><span id="line-337"> * @param flength family length</span>
<span class="source-line-no">338</span><span id="line-338"> * @param qualifier column qualifier</span>
<span class="source-line-no">339</span><span id="line-339"> * @param qoffset qualifier offset</span>
<span class="source-line-no">340</span><span id="line-340"> * @param qlength qualifier length</span>
<span class="source-line-no">341</span><span id="line-341"> * @return First possible key on passed Row, Family, Qualifier.</span>
<span class="source-line-no">342</span><span id="line-342"> */</span>
<span class="source-line-no">343</span><span id="line-343"> public static KeyValue createFirstOnRow(final byte[] row, final int roffset, final int rlength,</span>
<span class="source-line-no">344</span><span id="line-344"> final byte[] family, final int foffset, final int flength, final byte[] qualifier,</span>
<span class="source-line-no">345</span><span id="line-345"> final int qoffset, final int qlength) {</span>
<span class="source-line-no">346</span><span id="line-346"> return new KeyValue(row, roffset, rlength, family, foffset, flength, qualifier, qoffset,</span>
<span class="source-line-no">347</span><span id="line-347"> qlength, HConstants.LATEST_TIMESTAMP, KeyValue.Type.Maximum, null, 0, 0);</span>
<span class="source-line-no">348</span><span id="line-348"> }</span>
<span class="source-line-no">349</span><span id="line-349"></span>
<span class="source-line-no">350</span><span id="line-350"> /**</span>
<span class="source-line-no">351</span><span id="line-351"> * Create a KeyValue for the specified row, family and qualifier that would be smaller than all</span>
<span class="source-line-no">352</span><span id="line-352"> * other possible KeyValues that have the same row, family, qualifier. Used for seeking.</span>
<span class="source-line-no">353</span><span id="line-353"> * @param buffer the buffer to use for the new &lt;code&gt;KeyValue&lt;/code&gt; object</span>
<span class="source-line-no">354</span><span id="line-354"> * @param row the value key</span>
<span class="source-line-no">355</span><span id="line-355"> * @param family family name</span>
<span class="source-line-no">356</span><span id="line-356"> * @param qualifier column qualifier</span>
<span class="source-line-no">357</span><span id="line-357"> * @return First possible key on passed Row, Family, Qualifier.</span>
<span class="source-line-no">358</span><span id="line-358"> * @throws IllegalArgumentException The resulting &lt;code&gt;KeyValue&lt;/code&gt; object would be larger</span>
<span class="source-line-no">359</span><span id="line-359"> * than the provided buffer or than</span>
<span class="source-line-no">360</span><span id="line-360"> * &lt;code&gt;Integer.MAX_VALUE&lt;/code&gt;</span>
<span class="source-line-no">361</span><span id="line-361"> */</span>
<span class="source-line-no">362</span><span id="line-362"> public static KeyValue createFirstOnRow(byte[] buffer, final byte[] row, final byte[] family,</span>
<span class="source-line-no">363</span><span id="line-363"> final byte[] qualifier) throws IllegalArgumentException {</span>
<span class="source-line-no">364</span><span id="line-364"> return createFirstOnRow(buffer, 0, row, 0, row.length, family, 0, family.length, qualifier, 0,</span>
<span class="source-line-no">365</span><span id="line-365"> qualifier.length);</span>
<span class="source-line-no">366</span><span id="line-366"> }</span>
<span class="source-line-no">367</span><span id="line-367"></span>
<span class="source-line-no">368</span><span id="line-368"> /**</span>
<span class="source-line-no">369</span><span id="line-369"> * Create a KeyValue for the specified row, family and qualifier that would be smaller than all</span>
<span class="source-line-no">370</span><span id="line-370"> * other possible KeyValues that have the same row, family, qualifier. Used for seeking.</span>
<span class="source-line-no">371</span><span id="line-371"> * @param buffer the buffer to use for the new &lt;code&gt;KeyValue&lt;/code&gt; object</span>
<span class="source-line-no">372</span><span id="line-372"> * @param boffset buffer offset</span>
<span class="source-line-no">373</span><span id="line-373"> * @param row the value key</span>
<span class="source-line-no">374</span><span id="line-374"> * @param roffset row offset</span>
<span class="source-line-no">375</span><span id="line-375"> * @param rlength row length</span>
<span class="source-line-no">376</span><span id="line-376"> * @param family family name</span>
<span class="source-line-no">377</span><span id="line-377"> * @param foffset family offset</span>
<span class="source-line-no">378</span><span id="line-378"> * @param flength family length</span>
<span class="source-line-no">379</span><span id="line-379"> * @param qualifier column qualifier</span>
<span class="source-line-no">380</span><span id="line-380"> * @param qoffset qualifier offset</span>
<span class="source-line-no">381</span><span id="line-381"> * @param qlength qualifier length</span>
<span class="source-line-no">382</span><span id="line-382"> * @return First possible key on passed Row, Family, Qualifier.</span>
<span class="source-line-no">383</span><span id="line-383"> * @throws IllegalArgumentException The resulting &lt;code&gt;KeyValue&lt;/code&gt; object would be larger</span>
<span class="source-line-no">384</span><span id="line-384"> * than the provided buffer or than</span>
<span class="source-line-no">385</span><span id="line-385"> * &lt;code&gt;Integer.MAX_VALUE&lt;/code&gt;</span>
<span class="source-line-no">386</span><span id="line-386"> */</span>
<span class="source-line-no">387</span><span id="line-387"> public static KeyValue createFirstOnRow(byte[] buffer, final int boffset, final byte[] row,</span>
<span class="source-line-no">388</span><span id="line-388"> final int roffset, final int rlength, final byte[] family, final int foffset, final int flength,</span>
<span class="source-line-no">389</span><span id="line-389"> final byte[] qualifier, final int qoffset, final int qlength) throws IllegalArgumentException {</span>
<span class="source-line-no">390</span><span id="line-390"></span>
<span class="source-line-no">391</span><span id="line-391"> long lLength = KeyValue.getKeyValueDataStructureSize(rlength, flength, qlength, 0);</span>
<span class="source-line-no">392</span><span id="line-392"></span>
<span class="source-line-no">393</span><span id="line-393"> if (lLength &gt; Integer.MAX_VALUE) {</span>
<span class="source-line-no">394</span><span id="line-394"> throw new IllegalArgumentException("KeyValue length " + lLength + " &gt; " + Integer.MAX_VALUE);</span>
<span class="source-line-no">395</span><span id="line-395"> }</span>
<span class="source-line-no">396</span><span id="line-396"> int iLength = (int) lLength;</span>
<span class="source-line-no">397</span><span id="line-397"> if (buffer.length - boffset &lt; iLength) {</span>
<span class="source-line-no">398</span><span id="line-398"> throw new IllegalArgumentException(</span>
<span class="source-line-no">399</span><span id="line-399"> "Buffer size " + (buffer.length - boffset) + " &lt; " + iLength);</span>
<span class="source-line-no">400</span><span id="line-400"> }</span>
<span class="source-line-no">401</span><span id="line-401"></span>
<span class="source-line-no">402</span><span id="line-402"> int len = KeyValue.writeByteArray(buffer, boffset, row, roffset, rlength, family, foffset,</span>
<span class="source-line-no">403</span><span id="line-403"> flength, qualifier, qoffset, qlength, HConstants.LATEST_TIMESTAMP, KeyValue.Type.Maximum,</span>
<span class="source-line-no">404</span><span id="line-404"> null, 0, 0, null);</span>
<span class="source-line-no">405</span><span id="line-405"> return new KeyValue(buffer, boffset, len);</span>
<span class="source-line-no">406</span><span id="line-406"> }</span>
<span class="source-line-no">407</span><span id="line-407"></span>
<span class="source-line-no">408</span><span id="line-408"> /*************** misc **********************************/</span>
<span class="source-line-no">409</span><span id="line-409"> /**</span>
<span class="source-line-no">410</span><span id="line-410"> * @return &lt;code&gt;cell&lt;/code&gt; if it is an object of class {@link KeyValue} else we will return a</span>
<span class="source-line-no">411</span><span id="line-411"> * new {@link KeyValue} instance made from &lt;code&gt;cell&lt;/code&gt; Note: Even if the cell is an</span>
<span class="source-line-no">412</span><span id="line-412"> * object of any of the subclass of {@link KeyValue}, we will create a new</span>
<span class="source-line-no">413</span><span id="line-413"> * {@link KeyValue} object wrapping same buffer. This API is used only with MR based tools</span>
<span class="source-line-no">414</span><span id="line-414"> * which expect the type to be exactly KeyValue. That is the reason for doing this way.</span>
<span class="source-line-no">415</span><span id="line-415"> * @deprecated without any replacement.</span>
<span class="source-line-no">416</span><span id="line-416"> */</span>
<span class="source-line-no">417</span><span id="line-417"> @Deprecated</span>
<span class="source-line-no">418</span><span id="line-418"> public static KeyValue ensureKeyValue(final ExtendedCell cell) {</span>
<span class="source-line-no">419</span><span id="line-419"> if (cell == null) return null;</span>
<span class="source-line-no">420</span><span id="line-420"> if (cell instanceof KeyValue) {</span>
<span class="source-line-no">421</span><span id="line-421"> if (cell.getClass().getName().equals(KeyValue.class.getName())) {</span>
<span class="source-line-no">422</span><span id="line-422"> return (KeyValue) cell;</span>
<span class="source-line-no">423</span><span id="line-423"> }</span>
<span class="source-line-no">424</span><span id="line-424"> // Cell is an Object of any of the sub classes of KeyValue. Make a new KeyValue wrapping the</span>
<span class="source-line-no">425</span><span id="line-425"> // same byte[]</span>
<span class="source-line-no">426</span><span id="line-426"> KeyValue kv = (KeyValue) cell;</span>
<span class="source-line-no">427</span><span id="line-427"> KeyValue newKv = new KeyValue(kv.bytes, kv.offset, kv.length);</span>
<span class="source-line-no">428</span><span id="line-428"> newKv.setSequenceId(kv.getSequenceId());</span>
<span class="source-line-no">429</span><span id="line-429"> return newKv;</span>
<span class="source-line-no">430</span><span id="line-430"> }</span>
<span class="source-line-no">431</span><span id="line-431"> return copyToNewKeyValue(cell);</span>
<span class="source-line-no">432</span><span id="line-432"> }</span>
<span class="source-line-no">433</span><span id="line-433"></span>
<span class="source-line-no">434</span><span id="line-434"> @Deprecated</span>
<span class="source-line-no">435</span><span id="line-435"> public static List&lt;KeyValue&gt; ensureKeyValues(List&lt;ExtendedCell&gt; cells) {</span>
<span class="source-line-no">436</span><span id="line-436"> List&lt;KeyValue&gt; lazyList = Lists.transform(cells, new Function&lt;ExtendedCell, KeyValue&gt;() {</span>
<span class="source-line-no">437</span><span id="line-437"> @Override</span>
<span class="source-line-no">438</span><span id="line-438"> public KeyValue apply(ExtendedCell arg0) {</span>
<span class="source-line-no">439</span><span id="line-439"> return KeyValueUtil.ensureKeyValue(arg0);</span>
<span class="source-line-no">440</span><span id="line-440"> }</span>
<span class="source-line-no">441</span><span id="line-441"> });</span>
<span class="source-line-no">442</span><span id="line-442"> return new ArrayList&lt;&gt;(lazyList);</span>
<span class="source-line-no">443</span><span id="line-443"> }</span>
<span class="source-line-no">444</span><span id="line-444"></span>
<span class="source-line-no">445</span><span id="line-445"> /**</span>
<span class="source-line-no">446</span><span id="line-446"> * Write out a KeyValue in the manner in which we used to when KeyValue was a Writable.</span>
<span class="source-line-no">447</span><span id="line-447"> * @return Length written on stream</span>
<span class="source-line-no">448</span><span id="line-448"> * @see #create(DataInput) for the inverse function</span>
<span class="source-line-no">449</span><span id="line-449"> */</span>
<span class="source-line-no">450</span><span id="line-450"> public static long write(final KeyValue kv, final DataOutput out) throws IOException {</span>
<span class="source-line-no">451</span><span id="line-451"> // This is how the old Writables write used to serialize KVs. Need to figure</span>
<span class="source-line-no">452</span><span id="line-452"> // way to make it</span>
<span class="source-line-no">453</span><span id="line-453"> // work for all implementations.</span>
<span class="source-line-no">454</span><span id="line-454"> int length = kv.getLength();</span>
<span class="source-line-no">455</span><span id="line-455"> out.writeInt(length);</span>
<span class="source-line-no">456</span><span id="line-456"> out.write(kv.getBuffer(), kv.getOffset(), length);</span>
<span class="source-line-no">457</span><span id="line-457"> return (long) length + Bytes.SIZEOF_INT;</span>
<span class="source-line-no">458</span><span id="line-458"> }</span>
<span class="source-line-no">459</span><span id="line-459"></span>
<span class="source-line-no">460</span><span id="line-460"> static String bytesToHex(byte[] buf, int offset, int length) {</span>
<span class="source-line-no">461</span><span id="line-461"> String bufferContents = buf != null ? Bytes.toStringBinary(buf, offset, length) : "&lt;null&gt;";</span>
<span class="source-line-no">462</span><span id="line-462"> return ", KeyValueBytesHex=" + bufferContents + ", offset=" + offset + ", length=" + length;</span>
<span class="source-line-no">463</span><span id="line-463"> }</span>
<span class="source-line-no">464</span><span id="line-464"></span>
<span class="source-line-no">465</span><span id="line-465"> static void checkKeyValueBytes(byte[] buf, int offset, int length, boolean withTags) {</span>
<span class="source-line-no">466</span><span id="line-466"> if (buf == null) {</span>
<span class="source-line-no">467</span><span id="line-467"> String msg = "Invalid to have null byte array in KeyValue.";</span>
<span class="source-line-no">468</span><span id="line-468"> LOG.warn(msg);</span>
<span class="source-line-no">469</span><span id="line-469"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">470</span><span id="line-470"> }</span>
<span class="source-line-no">471</span><span id="line-471"></span>
<span class="source-line-no">472</span><span id="line-472"> int pos = offset, endOffset = offset + length;</span>
<span class="source-line-no">473</span><span id="line-473"> // check the key</span>
<span class="source-line-no">474</span><span id="line-474"> if (pos + Bytes.SIZEOF_INT &gt; endOffset) {</span>
<span class="source-line-no">475</span><span id="line-475"> String msg =</span>
<span class="source-line-no">476</span><span id="line-476"> "Overflow when reading key length at position=" + pos + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">477</span><span id="line-477"> LOG.warn(msg);</span>
<span class="source-line-no">478</span><span id="line-478"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">479</span><span id="line-479"> }</span>
<span class="source-line-no">480</span><span id="line-480"> int keyLen = Bytes.toInt(buf, pos, Bytes.SIZEOF_INT);</span>
<span class="source-line-no">481</span><span id="line-481"> pos += Bytes.SIZEOF_INT;</span>
<span class="source-line-no">482</span><span id="line-482"> if (keyLen &lt;= 0 || pos + keyLen &gt; endOffset) {</span>
<span class="source-line-no">483</span><span id="line-483"> String msg =</span>
<span class="source-line-no">484</span><span id="line-484"> "Invalid key length in KeyValue. keyLength=" + keyLen + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">485</span><span id="line-485"> LOG.warn(msg);</span>
<span class="source-line-no">486</span><span id="line-486"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">487</span><span id="line-487"> }</span>
<span class="source-line-no">488</span><span id="line-488"> // check the value</span>
<span class="source-line-no">489</span><span id="line-489"> if (pos + Bytes.SIZEOF_INT &gt; endOffset) {</span>
<span class="source-line-no">490</span><span id="line-490"> String msg =</span>
<span class="source-line-no">491</span><span id="line-491"> "Overflow when reading value length at position=" + pos + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">492</span><span id="line-492"> LOG.warn(msg);</span>
<span class="source-line-no">493</span><span id="line-493"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">494</span><span id="line-494"> }</span>
<span class="source-line-no">495</span><span id="line-495"> int valLen = Bytes.toInt(buf, pos, Bytes.SIZEOF_INT);</span>
<span class="source-line-no">496</span><span id="line-496"> pos += Bytes.SIZEOF_INT;</span>
<span class="source-line-no">497</span><span id="line-497"> if (valLen &lt; 0 || pos + valLen &gt; endOffset) {</span>
<span class="source-line-no">498</span><span id="line-498"> String msg =</span>
<span class="source-line-no">499</span><span id="line-499"> "Invalid value length in KeyValue, valueLength=" + valLen + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">500</span><span id="line-500"> LOG.warn(msg);</span>
<span class="source-line-no">501</span><span id="line-501"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">502</span><span id="line-502"> }</span>
<span class="source-line-no">503</span><span id="line-503"> // check the row</span>
<span class="source-line-no">504</span><span id="line-504"> if (pos + Bytes.SIZEOF_SHORT &gt; endOffset) {</span>
<span class="source-line-no">505</span><span id="line-505"> String msg =</span>
<span class="source-line-no">506</span><span id="line-506"> "Overflow when reading row length at position=" + pos + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">507</span><span id="line-507"> LOG.warn(msg);</span>
<span class="source-line-no">508</span><span id="line-508"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">509</span><span id="line-509"> }</span>
<span class="source-line-no">510</span><span id="line-510"> short rowLen = Bytes.toShort(buf, pos, Bytes.SIZEOF_SHORT);</span>
<span class="source-line-no">511</span><span id="line-511"> pos += Bytes.SIZEOF_SHORT;</span>
<span class="source-line-no">512</span><span id="line-512"> if (rowLen &lt; 0 || pos + rowLen &gt; endOffset) {</span>
<span class="source-line-no">513</span><span id="line-513"> String msg =</span>
<span class="source-line-no">514</span><span id="line-514"> "Invalid row length in KeyValue, rowLength=" + rowLen + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">515</span><span id="line-515"> LOG.warn(msg);</span>
<span class="source-line-no">516</span><span id="line-516"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">517</span><span id="line-517"> }</span>
<span class="source-line-no">518</span><span id="line-518"> pos += rowLen;</span>
<span class="source-line-no">519</span><span id="line-519"> // check the family</span>
<span class="source-line-no">520</span><span id="line-520"> if (pos + Bytes.SIZEOF_BYTE &gt; endOffset) {</span>
<span class="source-line-no">521</span><span id="line-521"> String msg =</span>
<span class="source-line-no">522</span><span id="line-522"> "Overflow when reading family length at position=" + pos + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">523</span><span id="line-523"> LOG.warn(msg);</span>
<span class="source-line-no">524</span><span id="line-524"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">525</span><span id="line-525"> }</span>
<span class="source-line-no">526</span><span id="line-526"> int familyLen = buf[pos];</span>
<span class="source-line-no">527</span><span id="line-527"> pos += Bytes.SIZEOF_BYTE;</span>
<span class="source-line-no">528</span><span id="line-528"> if (familyLen &lt; 0 || pos + familyLen &gt; endOffset) {</span>
<span class="source-line-no">529</span><span id="line-529"> String msg = "Invalid family length in KeyValue, familyLength=" + familyLen</span>
<span class="source-line-no">530</span><span id="line-530"> + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">531</span><span id="line-531"> LOG.warn(msg);</span>
<span class="source-line-no">532</span><span id="line-532"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">533</span><span id="line-533"> }</span>
<span class="source-line-no">534</span><span id="line-534"> pos += familyLen;</span>
<span class="source-line-no">535</span><span id="line-535"> // check the qualifier</span>
<span class="source-line-no">536</span><span id="line-536"> int qualifierLen = keyLen - Bytes.SIZEOF_SHORT - rowLen - Bytes.SIZEOF_BYTE - familyLen</span>
<span class="source-line-no">537</span><span id="line-537"> - Bytes.SIZEOF_LONG - Bytes.SIZEOF_BYTE;</span>
<span class="source-line-no">538</span><span id="line-538"> if (qualifierLen &lt; 0 || pos + qualifierLen &gt; endOffset) {</span>
<span class="source-line-no">539</span><span id="line-539"> String msg = "Invalid qualifier length in KeyValue, qualifierLen=" + qualifierLen</span>
<span class="source-line-no">540</span><span id="line-540"> + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">541</span><span id="line-541"> LOG.warn(msg);</span>
<span class="source-line-no">542</span><span id="line-542"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">543</span><span id="line-543"> }</span>
<span class="source-line-no">544</span><span id="line-544"> pos += qualifierLen;</span>
<span class="source-line-no">545</span><span id="line-545"> // check the timestamp</span>
<span class="source-line-no">546</span><span id="line-546"> if (pos + Bytes.SIZEOF_LONG &gt; endOffset) {</span>
<span class="source-line-no">547</span><span id="line-547"> String msg =</span>
<span class="source-line-no">548</span><span id="line-548"> "Overflow when reading timestamp at position=" + pos + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">549</span><span id="line-549"> LOG.warn(msg);</span>
<span class="source-line-no">550</span><span id="line-550"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">551</span><span id="line-551"> }</span>
<span class="source-line-no">552</span><span id="line-552"> long timestamp = Bytes.toLong(buf, pos, Bytes.SIZEOF_LONG);</span>
<span class="source-line-no">553</span><span id="line-553"> if (timestamp &lt; 0) {</span>
<span class="source-line-no">554</span><span id="line-554"> String msg =</span>
<span class="source-line-no">555</span><span id="line-555"> "Timestamp cannot be negative, ts=" + timestamp + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">556</span><span id="line-556"> LOG.warn(msg);</span>
<span class="source-line-no">557</span><span id="line-557"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">558</span><span id="line-558"> }</span>
<span class="source-line-no">559</span><span id="line-559"> pos += Bytes.SIZEOF_LONG;</span>
<span class="source-line-no">560</span><span id="line-560"> // check the type</span>
<span class="source-line-no">561</span><span id="line-561"> if (pos + Bytes.SIZEOF_BYTE &gt; endOffset) {</span>
<span class="source-line-no">562</span><span id="line-562"> String msg =</span>
<span class="source-line-no">563</span><span id="line-563"> "Overflow when reading type at position=" + pos + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">564</span><span id="line-564"> LOG.warn(msg);</span>
<span class="source-line-no">565</span><span id="line-565"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">566</span><span id="line-566"> }</span>
<span class="source-line-no">567</span><span id="line-567"> byte type = buf[pos];</span>
<span class="source-line-no">568</span><span id="line-568"> if (!KeyValue.Type.isValidType(type)) {</span>
<span class="source-line-no">569</span><span id="line-569"> String msg = "Invalid type in KeyValue, type=" + type + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">570</span><span id="line-570"> LOG.warn(msg);</span>
<span class="source-line-no">571</span><span id="line-571"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">572</span><span id="line-572"> }</span>
<span class="source-line-no">573</span><span id="line-573"> pos += Bytes.SIZEOF_BYTE;</span>
<span class="source-line-no">574</span><span id="line-574"> // check the value</span>
<span class="source-line-no">575</span><span id="line-575"> if (pos + valLen &gt; endOffset) {</span>
<span class="source-line-no">576</span><span id="line-576"> String msg =</span>
<span class="source-line-no">577</span><span id="line-577"> "Overflow when reading value part at position=" + pos + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">578</span><span id="line-578"> LOG.warn(msg);</span>
<span class="source-line-no">579</span><span id="line-579"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">580</span><span id="line-580"> }</span>
<span class="source-line-no">581</span><span id="line-581"> pos += valLen;</span>
<span class="source-line-no">582</span><span id="line-582"> // check the tags</span>
<span class="source-line-no">583</span><span id="line-583"> if (withTags) {</span>
<span class="source-line-no">584</span><span id="line-584"> if (pos == endOffset) {</span>
<span class="source-line-no">585</span><span id="line-585"> // withTags is true but no tag in the cell.</span>
<span class="source-line-no">586</span><span id="line-586"> return;</span>
<span class="source-line-no">587</span><span id="line-587"> }</span>
<span class="source-line-no">588</span><span id="line-588"> pos = checkKeyValueTagBytes(buf, offset, length, pos, endOffset);</span>
<span class="source-line-no">589</span><span id="line-589"> }</span>
<span class="source-line-no">590</span><span id="line-590"> if (pos != endOffset) {</span>
<span class="source-line-no">591</span><span id="line-591"> String msg = "Some redundant bytes in KeyValue's buffer, startOffset=" + pos + ", endOffset="</span>
<span class="source-line-no">592</span><span id="line-592"> + endOffset + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">593</span><span id="line-593"> LOG.warn(msg);</span>
<span class="source-line-no">594</span><span id="line-594"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">595</span><span id="line-595"> }</span>
<span class="source-line-no">596</span><span id="line-596"> }</span>
<span class="source-line-no">597</span><span id="line-597"></span>
<span class="source-line-no">598</span><span id="line-598"> private static int checkKeyValueTagBytes(byte[] buf, int offset, int length, int pos,</span>
<span class="source-line-no">599</span><span id="line-599"> int endOffset) {</span>
<span class="source-line-no">600</span><span id="line-600"> if (pos + Bytes.SIZEOF_SHORT &gt; endOffset) {</span>
<span class="source-line-no">601</span><span id="line-601"> String msg =</span>
<span class="source-line-no">602</span><span id="line-602"> "Overflow when reading tags length at position=" + pos + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">603</span><span id="line-603"> LOG.warn(msg);</span>
<span class="source-line-no">604</span><span id="line-604"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">605</span><span id="line-605"> }</span>
<span class="source-line-no">606</span><span id="line-606"> short tagsLen = Bytes.toShort(buf, pos);</span>
<span class="source-line-no">607</span><span id="line-607"> pos += Bytes.SIZEOF_SHORT;</span>
<span class="source-line-no">608</span><span id="line-608"> if (tagsLen &lt; 0 || pos + tagsLen &gt; endOffset) {</span>
<span class="source-line-no">609</span><span id="line-609"> String msg = "Invalid tags length in KeyValue at position=" + (pos - Bytes.SIZEOF_SHORT)</span>
<span class="source-line-no">610</span><span id="line-610"> + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">611</span><span id="line-611"> LOG.warn(msg);</span>
<span class="source-line-no">612</span><span id="line-612"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">613</span><span id="line-613"> }</span>
<span class="source-line-no">614</span><span id="line-614"> int tagsEndOffset = pos + tagsLen;</span>
<span class="source-line-no">615</span><span id="line-615"> for (; pos &lt; tagsEndOffset;) {</span>
<span class="source-line-no">616</span><span id="line-616"> if (pos + Tag.TAG_LENGTH_SIZE &gt; endOffset) {</span>
<span class="source-line-no">617</span><span id="line-617"> String msg =</span>
<span class="source-line-no">618</span><span id="line-618"> "Overflow when reading tag length at position=" + pos + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">619</span><span id="line-619"> LOG.warn(msg);</span>
<span class="source-line-no">620</span><span id="line-620"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">621</span><span id="line-621"> }</span>
<span class="source-line-no">622</span><span id="line-622"> short tagLen = Bytes.toShort(buf, pos);</span>
<span class="source-line-no">623</span><span id="line-623"> pos += Tag.TAG_LENGTH_SIZE;</span>
<span class="source-line-no">624</span><span id="line-624"> // tagLen contains one byte tag type, so must be not less than 1.</span>
<span class="source-line-no">625</span><span id="line-625"> if (tagLen &lt; 1 || pos + tagLen &gt; endOffset) {</span>
<span class="source-line-no">626</span><span id="line-626"> String msg = "Invalid tag length at position=" + (pos - Tag.TAG_LENGTH_SIZE)</span>
<span class="source-line-no">627</span><span id="line-627"> + ", tagLength=" + tagLen + bytesToHex(buf, offset, length);</span>
<span class="source-line-no">628</span><span id="line-628"> LOG.warn(msg);</span>
<span class="source-line-no">629</span><span id="line-629"> throw new IllegalArgumentException(msg);</span>
<span class="source-line-no">630</span><span id="line-630"> }</span>
<span class="source-line-no">631</span><span id="line-631"> pos += tagLen;</span>
<span class="source-line-no">632</span><span id="line-632"> }</span>
<span class="source-line-no">633</span><span id="line-633"> return pos;</span>
<span class="source-line-no">634</span><span id="line-634"> }</span>
<span class="source-line-no">635</span><span id="line-635"></span>
<span class="source-line-no">636</span><span id="line-636"> /**</span>
<span class="source-line-no">637</span><span id="line-637"> * Create a KeyValue reading from the raw InputStream. Named</span>
<span class="source-line-no">638</span><span id="line-638"> * &lt;code&gt;createKeyValueFromInputStream&lt;/code&gt; so doesn't clash with {@link #create(DataInput)}</span>
<span class="source-line-no">639</span><span id="line-639"> * @param in inputStream to read.</span>
<span class="source-line-no">640</span><span id="line-640"> * @param withTags whether the keyvalue should include tags are not</span>
<span class="source-line-no">641</span><span id="line-641"> * @return Created KeyValue OR if we find a length of zero, we will return null which can be</span>
<span class="source-line-no">642</span><span id="line-642"> * useful marking a stream as done.</span>
<span class="source-line-no">643</span><span id="line-643"> */</span>
<span class="source-line-no">644</span><span id="line-644"> public static KeyValue createKeyValueFromInputStream(InputStream in, boolean withTags)</span>
<span class="source-line-no">645</span><span id="line-645"> throws IOException {</span>
<span class="source-line-no">646</span><span id="line-646"> byte[] intBytes = new byte[Bytes.SIZEOF_INT];</span>
<span class="source-line-no">647</span><span id="line-647"> int bytesRead = 0;</span>
<span class="source-line-no">648</span><span id="line-648"> while (bytesRead &lt; intBytes.length) {</span>
<span class="source-line-no">649</span><span id="line-649"> int n = in.read(intBytes, bytesRead, intBytes.length - bytesRead);</span>
<span class="source-line-no">650</span><span id="line-650"> if (n &lt; 0) {</span>
<span class="source-line-no">651</span><span id="line-651"> if (bytesRead == 0) {</span>
<span class="source-line-no">652</span><span id="line-652"> throw new EOFException();</span>
<span class="source-line-no">653</span><span id="line-653"> }</span>
<span class="source-line-no">654</span><span id="line-654"> throw new IOException("Failed read of int, read " + bytesRead + " bytes");</span>
<span class="source-line-no">655</span><span id="line-655"> }</span>
<span class="source-line-no">656</span><span id="line-656"> bytesRead += n;</span>
<span class="source-line-no">657</span><span id="line-657"> }</span>
<span class="source-line-no">658</span><span id="line-658"> byte[] bytes = new byte[Bytes.toInt(intBytes)];</span>
<span class="source-line-no">659</span><span id="line-659"> IOUtils.readFully(in, bytes, 0, bytes.length);</span>
<span class="source-line-no">660</span><span id="line-660"> return withTags</span>
<span class="source-line-no">661</span><span id="line-661"> ? new KeyValue(bytes, 0, bytes.length)</span>
<span class="source-line-no">662</span><span id="line-662"> : new NoTagsKeyValue(bytes, 0, bytes.length);</span>
<span class="source-line-no">663</span><span id="line-663"> }</span>
<span class="source-line-no">664</span><span id="line-664"></span>
<span class="source-line-no">665</span><span id="line-665"> /**</span>
<span class="source-line-no">666</span><span id="line-666"> * Returns a KeyValue made of a byte array that holds the key-only part. Needed to convert hfile</span>
<span class="source-line-no">667</span><span id="line-667"> * index members to KeyValues.</span>
<span class="source-line-no">668</span><span id="line-668"> */</span>
<span class="source-line-no">669</span><span id="line-669"> public static KeyValue createKeyValueFromKey(final byte[] b) {</span>
<span class="source-line-no">670</span><span id="line-670"> return createKeyValueFromKey(b, 0, b.length);</span>
<span class="source-line-no">671</span><span id="line-671"> }</span>
<span class="source-line-no">672</span><span id="line-672"></span>
<span class="source-line-no">673</span><span id="line-673"> /**</span>
<span class="source-line-no">674</span><span id="line-674"> * Return a KeyValue made of a byte buffer that holds the key-only part. Needed to convert hfile</span>
<span class="source-line-no">675</span><span id="line-675"> * index members to KeyValues.</span>
<span class="source-line-no">676</span><span id="line-676"> */</span>
<span class="source-line-no">677</span><span id="line-677"> public static KeyValue createKeyValueFromKey(final ByteBuffer bb) {</span>
<span class="source-line-no">678</span><span id="line-678"> return createKeyValueFromKey(bb.array(), bb.arrayOffset(), bb.limit());</span>
<span class="source-line-no">679</span><span id="line-679"> }</span>
<span class="source-line-no">680</span><span id="line-680"></span>
<span class="source-line-no">681</span><span id="line-681"> /**</span>
<span class="source-line-no">682</span><span id="line-682"> * Return a KeyValue made of a byte array that holds the key-only part. Needed to convert hfile</span>
<span class="source-line-no">683</span><span id="line-683"> * index members to KeyValues.</span>
<span class="source-line-no">684</span><span id="line-684"> */</span>
<span class="source-line-no">685</span><span id="line-685"> public static KeyValue createKeyValueFromKey(final byte[] b, final int o, final int l) {</span>
<span class="source-line-no">686</span><span id="line-686"> byte[] newb = new byte[l + KeyValue.ROW_OFFSET];</span>
<span class="source-line-no">687</span><span id="line-687"> System.arraycopy(b, o, newb, KeyValue.ROW_OFFSET, l);</span>
<span class="source-line-no">688</span><span id="line-688"> Bytes.putInt(newb, 0, l);</span>
<span class="source-line-no">689</span><span id="line-689"> Bytes.putInt(newb, Bytes.SIZEOF_INT, 0);</span>
<span class="source-line-no">690</span><span id="line-690"> return new KeyValue(newb);</span>
<span class="source-line-no">691</span><span id="line-691"> }</span>
<span class="source-line-no">692</span><span id="line-692"></span>
<span class="source-line-no">693</span><span id="line-693"> /**</span>
<span class="source-line-no">694</span><span id="line-694"> * Where to read bytes from. Creates a byte array to hold the KeyValue backing bytes copied from</span>
<span class="source-line-no">695</span><span id="line-695"> * the steam.</span>
<span class="source-line-no">696</span><span id="line-696"> * @return KeyValue created by deserializing from &lt;code&gt;in&lt;/code&gt; OR if we find a length of zero,</span>
<span class="source-line-no">697</span><span id="line-697"> * we will return null which can be useful marking a stream as done.</span>
<span class="source-line-no">698</span><span id="line-698"> */</span>
<span class="source-line-no">699</span><span id="line-699"> public static KeyValue create(final DataInput in) throws IOException {</span>
<span class="source-line-no">700</span><span id="line-700"> return create(in.readInt(), in);</span>
<span class="source-line-no">701</span><span id="line-701"> }</span>
<span class="source-line-no">702</span><span id="line-702"></span>
<span class="source-line-no">703</span><span id="line-703"> /**</span>
<span class="source-line-no">704</span><span id="line-704"> * Create a KeyValue reading &lt;code&gt;length&lt;/code&gt; from &lt;code&gt;in&lt;/code&gt;</span>
<span class="source-line-no">705</span><span id="line-705"> * @return Created KeyValue OR if we find a length of zero, we will return null which can be</span>
<span class="source-line-no">706</span><span id="line-706"> * useful marking a stream as done.</span>
<span class="source-line-no">707</span><span id="line-707"> */</span>
<span class="source-line-no">708</span><span id="line-708"> public static KeyValue create(int length, final DataInput in) throws IOException {</span>
<span class="source-line-no">709</span><span id="line-709"> if (length &lt;= 0) {</span>
<span class="source-line-no">710</span><span id="line-710"> if (length == 0) return null;</span>
<span class="source-line-no">711</span><span id="line-711"> throw new IOException("Failed read " + length + " bytes, stream corrupt?");</span>
<span class="source-line-no">712</span><span id="line-712"> }</span>
<span class="source-line-no">713</span><span id="line-713"></span>
<span class="source-line-no">714</span><span id="line-714"> // This is how the old Writables.readFrom used to deserialize. Didn't even</span>
<span class="source-line-no">715</span><span id="line-715"> // vint.</span>
<span class="source-line-no">716</span><span id="line-716"> byte[] bytes = new byte[length];</span>
<span class="source-line-no">717</span><span id="line-717"> in.readFully(bytes);</span>
<span class="source-line-no">718</span><span id="line-718"> return new KeyValue(bytes, 0, length);</span>
<span class="source-line-no">719</span><span id="line-719"> }</span>
<span class="source-line-no">720</span><span id="line-720">}</span>
</pre>
</div>
</main>
</body>
</html>