blob: f096f4c7851d7420e54c399ecc49a453c6ff0209 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.util, class: Writables">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.util;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import java.io.ByteArrayInputStream;</span>
<span class="source-line-no">021</span><span id="line-21">import java.io.ByteArrayOutputStream;</span>
<span class="source-line-no">022</span><span id="line-22">import java.io.DataInputStream;</span>
<span class="source-line-no">023</span><span id="line-23">import java.io.DataOutputStream;</span>
<span class="source-line-no">024</span><span id="line-24">import java.io.IOException;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.ArrayList;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.List;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.io.DataInputBuffer;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.hadoop.io.Writable;</span>
<span class="source-line-no">029</span><span id="line-29">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">030</span><span id="line-30"></span>
<span class="source-line-no">031</span><span id="line-31">/**</span>
<span class="source-line-no">032</span><span id="line-32"> * Utility class with methods for manipulating Writable objects</span>
<span class="source-line-no">033</span><span id="line-33"> */</span>
<span class="source-line-no">034</span><span id="line-34">@InterfaceAudience.Private</span>
<span class="source-line-no">035</span><span id="line-35">public class Writables {</span>
<span class="source-line-no">036</span><span id="line-36"> /**</span>
<span class="source-line-no">037</span><span id="line-37"> * Get the Writable's contents as a byte array</span>
<span class="source-line-no">038</span><span id="line-38"> * @param w writable</span>
<span class="source-line-no">039</span><span id="line-39"> * @return The bytes of &lt;code&gt;w&lt;/code&gt; gotten by running its</span>
<span class="source-line-no">040</span><span id="line-40"> * {@link Writable#write(java.io.DataOutput)} method.</span>
<span class="source-line-no">041</span><span id="line-41"> * @throws IOException e</span>
<span class="source-line-no">042</span><span id="line-42"> * @see #getWritable(byte[], Writable)</span>
<span class="source-line-no">043</span><span id="line-43"> */</span>
<span class="source-line-no">044</span><span id="line-44"> public static byte[] getBytes(final Writable w) throws IOException {</span>
<span class="source-line-no">045</span><span id="line-45"> if (w == null) {</span>
<span class="source-line-no">046</span><span id="line-46"> throw new IllegalArgumentException("Writable cannot be null");</span>
<span class="source-line-no">047</span><span id="line-47"> }</span>
<span class="source-line-no">048</span><span id="line-48"> ByteArrayOutputStream byteStream = new ByteArrayOutputStream();</span>
<span class="source-line-no">049</span><span id="line-49"> DataOutputStream out = new DataOutputStream(byteStream);</span>
<span class="source-line-no">050</span><span id="line-50"> try {</span>
<span class="source-line-no">051</span><span id="line-51"> w.write(out);</span>
<span class="source-line-no">052</span><span id="line-52"> out.close();</span>
<span class="source-line-no">053</span><span id="line-53"> out = null;</span>
<span class="source-line-no">054</span><span id="line-54"> return byteStream.toByteArray();</span>
<span class="source-line-no">055</span><span id="line-55"> } finally {</span>
<span class="source-line-no">056</span><span id="line-56"> if (out != null) {</span>
<span class="source-line-no">057</span><span id="line-57"> out.close();</span>
<span class="source-line-no">058</span><span id="line-58"> }</span>
<span class="source-line-no">059</span><span id="line-59"> }</span>
<span class="source-line-no">060</span><span id="line-60"> }</span>
<span class="source-line-no">061</span><span id="line-61"></span>
<span class="source-line-no">062</span><span id="line-62"> /**</span>
<span class="source-line-no">063</span><span id="line-63"> * Put a bunch of Writables as bytes all into the one byte array.</span>
<span class="source-line-no">064</span><span id="line-64"> * @param ws writable</span>
<span class="source-line-no">065</span><span id="line-65"> * @return The bytes of &lt;code&gt;w&lt;/code&gt; gotten by running its</span>
<span class="source-line-no">066</span><span id="line-66"> * {@link Writable#write(java.io.DataOutput)} method.</span>
<span class="source-line-no">067</span><span id="line-67"> * @throws IOException e</span>
<span class="source-line-no">068</span><span id="line-68"> */</span>
<span class="source-line-no">069</span><span id="line-69"> public static byte[] getBytes(final Writable... ws) throws IOException {</span>
<span class="source-line-no">070</span><span id="line-70"> List&lt;byte[]&gt; bytes = new ArrayList&lt;&gt;(ws.length);</span>
<span class="source-line-no">071</span><span id="line-71"> int size = 0;</span>
<span class="source-line-no">072</span><span id="line-72"> for (Writable w : ws) {</span>
<span class="source-line-no">073</span><span id="line-73"> byte[] b = getBytes(w);</span>
<span class="source-line-no">074</span><span id="line-74"> size += b.length;</span>
<span class="source-line-no">075</span><span id="line-75"> bytes.add(b);</span>
<span class="source-line-no">076</span><span id="line-76"> }</span>
<span class="source-line-no">077</span><span id="line-77"> byte[] result = new byte[size];</span>
<span class="source-line-no">078</span><span id="line-78"> int offset = 0;</span>
<span class="source-line-no">079</span><span id="line-79"> for (byte[] b : bytes) {</span>
<span class="source-line-no">080</span><span id="line-80"> System.arraycopy(b, 0, result, offset, b.length);</span>
<span class="source-line-no">081</span><span id="line-81"> offset += b.length;</span>
<span class="source-line-no">082</span><span id="line-82"> }</span>
<span class="source-line-no">083</span><span id="line-83"> return result;</span>
<span class="source-line-no">084</span><span id="line-84"> }</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"> * Set bytes into the passed Writable by calling its</span>
<span class="source-line-no">088</span><span id="line-88"> * {@link Writable#readFields(java.io.DataInput)}.</span>
<span class="source-line-no">089</span><span id="line-89"> * @param bytes serialized bytes</span>
<span class="source-line-no">090</span><span id="line-90"> * @param w An empty Writable (usually made by calling the null-arg constructor).</span>
<span class="source-line-no">091</span><span id="line-91"> * @return The passed Writable after its readFields has been called fed by the passed</span>
<span class="source-line-no">092</span><span id="line-92"> * &lt;code&gt;bytes&lt;/code&gt; array or IllegalArgumentException if passed null or an empty</span>
<span class="source-line-no">093</span><span id="line-93"> * &lt;code&gt;bytes&lt;/code&gt; array.</span>
<span class="source-line-no">094</span><span id="line-94"> * @throws IOException e</span>
<span class="source-line-no">095</span><span id="line-95"> */</span>
<span class="source-line-no">096</span><span id="line-96"> public static Writable getWritable(final byte[] bytes, final Writable w) throws IOException {</span>
<span class="source-line-no">097</span><span id="line-97"> return getWritable(bytes, 0, bytes.length, w);</span>
<span class="source-line-no">098</span><span id="line-98"> }</span>
<span class="source-line-no">099</span><span id="line-99"></span>
<span class="source-line-no">100</span><span id="line-100"> /**</span>
<span class="source-line-no">101</span><span id="line-101"> * Set bytes into the passed Writable by calling its</span>
<span class="source-line-no">102</span><span id="line-102"> * {@link Writable#readFields(java.io.DataInput)}.</span>
<span class="source-line-no">103</span><span id="line-103"> * @param bytes serialized bytes</span>
<span class="source-line-no">104</span><span id="line-104"> * @param offset offset into array</span>
<span class="source-line-no">105</span><span id="line-105"> * @param length length of data</span>
<span class="source-line-no">106</span><span id="line-106"> * @param w An empty Writable (usually made by calling the null-arg constructor).</span>
<span class="source-line-no">107</span><span id="line-107"> * @return The passed Writable after its readFields has been called fed by the passed</span>
<span class="source-line-no">108</span><span id="line-108"> * &lt;code&gt;bytes&lt;/code&gt; array or IllegalArgumentException if passed null or an empty</span>
<span class="source-line-no">109</span><span id="line-109"> * &lt;code&gt;bytes&lt;/code&gt; array.</span>
<span class="source-line-no">110</span><span id="line-110"> * @throws IOException e</span>
<span class="source-line-no">111</span><span id="line-111"> */</span>
<span class="source-line-no">112</span><span id="line-112"> public static Writable getWritable(final byte[] bytes, final int offset, final int length,</span>
<span class="source-line-no">113</span><span id="line-113"> final Writable w) throws IOException {</span>
<span class="source-line-no">114</span><span id="line-114"> if (bytes == null || length &lt;= 0) {</span>
<span class="source-line-no">115</span><span id="line-115"> throw new IllegalArgumentException("Can't build a writable with empty " + "bytes array");</span>
<span class="source-line-no">116</span><span id="line-116"> }</span>
<span class="source-line-no">117</span><span id="line-117"> if (w == null) {</span>
<span class="source-line-no">118</span><span id="line-118"> throw new IllegalArgumentException("Writable cannot be null");</span>
<span class="source-line-no">119</span><span id="line-119"> }</span>
<span class="source-line-no">120</span><span id="line-120"> DataInputBuffer in = new DataInputBuffer();</span>
<span class="source-line-no">121</span><span id="line-121"> try {</span>
<span class="source-line-no">122</span><span id="line-122"> in.reset(bytes, offset, length);</span>
<span class="source-line-no">123</span><span id="line-123"> w.readFields(in);</span>
<span class="source-line-no">124</span><span id="line-124"> return w;</span>
<span class="source-line-no">125</span><span id="line-125"> } finally {</span>
<span class="source-line-no">126</span><span id="line-126"> in.close();</span>
<span class="source-line-no">127</span><span id="line-127"> }</span>
<span class="source-line-no">128</span><span id="line-128"> }</span>
<span class="source-line-no">129</span><span id="line-129"></span>
<span class="source-line-no">130</span><span id="line-130"> /**</span>
<span class="source-line-no">131</span><span id="line-131"> * Copy one Writable to another. Copies bytes using data streams.</span>
<span class="source-line-no">132</span><span id="line-132"> * @param src Source Writable</span>
<span class="source-line-no">133</span><span id="line-133"> * @param tgt Target Writable</span>
<span class="source-line-no">134</span><span id="line-134"> * @return The target Writable.</span>
<span class="source-line-no">135</span><span id="line-135"> * @throws IOException e</span>
<span class="source-line-no">136</span><span id="line-136"> */</span>
<span class="source-line-no">137</span><span id="line-137"> public static Writable copyWritable(final Writable src, final Writable tgt) throws IOException {</span>
<span class="source-line-no">138</span><span id="line-138"> return copyWritable(getBytes(src), tgt);</span>
<span class="source-line-no">139</span><span id="line-139"> }</span>
<span class="source-line-no">140</span><span id="line-140"></span>
<span class="source-line-no">141</span><span id="line-141"> /**</span>
<span class="source-line-no">142</span><span id="line-142"> * Copy one Writable to another. Copies bytes using data streams.</span>
<span class="source-line-no">143</span><span id="line-143"> * @param bytes Source Writable</span>
<span class="source-line-no">144</span><span id="line-144"> * @param tgt Target Writable</span>
<span class="source-line-no">145</span><span id="line-145"> * @return The target Writable.</span>
<span class="source-line-no">146</span><span id="line-146"> * @throws IOException e</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 Writable copyWritable(final byte[] bytes, final Writable tgt) throws IOException {</span>
<span class="source-line-no">149</span><span id="line-149"> DataInputStream dis = new DataInputStream(new ByteArrayInputStream(bytes));</span>
<span class="source-line-no">150</span><span id="line-150"> try {</span>
<span class="source-line-no">151</span><span id="line-151"> tgt.readFields(dis);</span>
<span class="source-line-no">152</span><span id="line-152"> } finally {</span>
<span class="source-line-no">153</span><span id="line-153"> dis.close();</span>
<span class="source-line-no">154</span><span id="line-154"> }</span>
<span class="source-line-no">155</span><span id="line-155"> return tgt;</span>
<span class="source-line-no">156</span><span id="line-156"> }</span>
<span class="source-line-no">157</span><span id="line-157">}</span>
</pre>
</div>
</main>
</body>
</html>