blob: fd676adb2e65ef1a59560194a7d3ffcded19b349 [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: JRubyFormat">
<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.util.List;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.Map;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.Map.Entry;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">024</span><span id="line-24"></span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hbase.thirdparty.com.google.common.escape.Escaper;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hbase.thirdparty.com.google.common.escape.Escapers;</span>
<span class="source-line-no">027</span><span id="line-27"></span>
<span class="source-line-no">028</span><span id="line-28">/**</span>
<span class="source-line-no">029</span><span id="line-29"> * Utility class for converting objects to JRuby. It handles null, Boolean, Number, String, byte[],</span>
<span class="source-line-no">030</span><span id="line-30"> * List&amp;lt;Object&amp;gt;, Map&amp;lt;String, Object&amp;gt; structures.</span>
<span class="source-line-no">031</span><span id="line-31"> * &lt;p&gt;</span>
<span class="source-line-no">032</span><span id="line-32"> * E.g.</span>
<span class="source-line-no">033</span><span id="line-33"> *</span>
<span class="source-line-no">034</span><span id="line-34"> * &lt;pre&gt;</span>
<span class="source-line-no">035</span><span id="line-35"> * Map&amp;lt;String, Object&amp;gt; map = new LinkedHashMap&amp;lt;&amp;gt;();</span>
<span class="source-line-no">036</span><span id="line-36"> * map.put("null", null);</span>
<span class="source-line-no">037</span><span id="line-37"> * map.put("boolean", true);</span>
<span class="source-line-no">038</span><span id="line-38"> * map.put("number", 1);</span>
<span class="source-line-no">039</span><span id="line-39"> * map.put("string", "str");</span>
<span class="source-line-no">040</span><span id="line-40"> * map.put("binary", new byte[] { 1, 2, 3 });</span>
<span class="source-line-no">041</span><span id="line-41"> * map.put("list", Lists.newArrayList(1, "2", true));</span>
<span class="source-line-no">042</span><span id="line-42"> * &lt;/pre&gt;</span>
<span class="source-line-no">043</span><span id="line-43"> * &lt;/p&gt;</span>
<span class="source-line-no">044</span><span id="line-44"> * &lt;p&gt;</span>
<span class="source-line-no">045</span><span id="line-45"> * Calling {@link #print(Object)} method will result:</span>
<span class="source-line-no">046</span><span id="line-46"> *</span>
<span class="source-line-no">047</span><span id="line-47"> * &lt;pre&gt;</span>
<span class="source-line-no">048</span><span id="line-48"> * { null =&amp;gt; '', boolean =&amp;gt; 'true', number =&amp;gt; '1', string =&amp;gt; 'str',</span>
<span class="source-line-no">049</span><span id="line-49"> * binary =&amp;gt; '010203', list =&amp;gt; [ '1', '2', 'true' ] }</span>
<span class="source-line-no">050</span><span id="line-50"> * &lt;/pre&gt;</span>
<span class="source-line-no">051</span><span id="line-51"> * &lt;/p&gt;</span>
<span class="source-line-no">052</span><span id="line-52"> */</span>
<span class="source-line-no">053</span><span id="line-53">@InterfaceAudience.Private</span>
<span class="source-line-no">054</span><span id="line-54">public final class JRubyFormat {</span>
<span class="source-line-no">055</span><span id="line-55"> private static final Escaper escaper;</span>
<span class="source-line-no">056</span><span id="line-56"></span>
<span class="source-line-no">057</span><span id="line-57"> static {</span>
<span class="source-line-no">058</span><span id="line-58"> escaper =</span>
<span class="source-line-no">059</span><span id="line-59"> Escapers.builder().addEscape('\\', "\\\\").addEscape('\'', "\\'").addEscape('\n', "\\n")</span>
<span class="source-line-no">060</span><span id="line-60"> .addEscape('\r', "\\r").addEscape('\t', "\\t").addEscape('\f', "\\f").build();</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"> private JRubyFormat() {</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 String escape(Object object) {</span>
<span class="source-line-no">067</span><span id="line-67"> if (object == null) {</span>
<span class="source-line-no">068</span><span id="line-68"> return "";</span>
<span class="source-line-no">069</span><span id="line-69"> } else {</span>
<span class="source-line-no">070</span><span id="line-70"> return escaper.escape(object.toString());</span>
<span class="source-line-no">071</span><span id="line-71"> }</span>
<span class="source-line-no">072</span><span id="line-72"> }</span>
<span class="source-line-no">073</span><span id="line-73"></span>
<span class="source-line-no">074</span><span id="line-74"> @SuppressWarnings({ "unchecked" })</span>
<span class="source-line-no">075</span><span id="line-75"> private static void appendJRuby(StringBuilder builder, Object object) {</span>
<span class="source-line-no">076</span><span id="line-76"> if (object == null) {</span>
<span class="source-line-no">077</span><span id="line-77"> builder.append("''");</span>
<span class="source-line-no">078</span><span id="line-78"> } else if (object instanceof List) {</span>
<span class="source-line-no">079</span><span id="line-79"> builder.append("[");</span>
<span class="source-line-no">080</span><span id="line-80"></span>
<span class="source-line-no">081</span><span id="line-81"> boolean first = true;</span>
<span class="source-line-no">082</span><span id="line-82"></span>
<span class="source-line-no">083</span><span id="line-83"> for (Object element : (List&lt;Object&gt;) object) {</span>
<span class="source-line-no">084</span><span id="line-84"> if (first) {</span>
<span class="source-line-no">085</span><span id="line-85"> first = false;</span>
<span class="source-line-no">086</span><span id="line-86"> builder.append(" ");</span>
<span class="source-line-no">087</span><span id="line-87"> } else {</span>
<span class="source-line-no">088</span><span id="line-88"> builder.append(", ");</span>
<span class="source-line-no">089</span><span id="line-89"> }</span>
<span class="source-line-no">090</span><span id="line-90"></span>
<span class="source-line-no">091</span><span id="line-91"> appendJRuby(builder, element);</span>
<span class="source-line-no">092</span><span id="line-92"> }</span>
<span class="source-line-no">093</span><span id="line-93"></span>
<span class="source-line-no">094</span><span id="line-94"> if (!first) {</span>
<span class="source-line-no">095</span><span id="line-95"> builder.append(" ");</span>
<span class="source-line-no">096</span><span id="line-96"> }</span>
<span class="source-line-no">097</span><span id="line-97"></span>
<span class="source-line-no">098</span><span id="line-98"> builder.append("]");</span>
<span class="source-line-no">099</span><span id="line-99"> } else if (object instanceof Map) {</span>
<span class="source-line-no">100</span><span id="line-100"> builder.append("{");</span>
<span class="source-line-no">101</span><span id="line-101"></span>
<span class="source-line-no">102</span><span id="line-102"> boolean first = true;</span>
<span class="source-line-no">103</span><span id="line-103"></span>
<span class="source-line-no">104</span><span id="line-104"> for (Entry&lt;String, Object&gt; entry : ((Map&lt;String, Object&gt;) object).entrySet()) {</span>
<span class="source-line-no">105</span><span id="line-105"> if (first) {</span>
<span class="source-line-no">106</span><span id="line-106"> first = false;</span>
<span class="source-line-no">107</span><span id="line-107"> builder.append(" ");</span>
<span class="source-line-no">108</span><span id="line-108"> } else {</span>
<span class="source-line-no">109</span><span id="line-109"> builder.append(", ");</span>
<span class="source-line-no">110</span><span id="line-110"> }</span>
<span class="source-line-no">111</span><span id="line-111"></span>
<span class="source-line-no">112</span><span id="line-112"> String key = entry.getKey();</span>
<span class="source-line-no">113</span><span id="line-113"> String escapedKey = escape(key);</span>
<span class="source-line-no">114</span><span id="line-114"></span>
<span class="source-line-no">115</span><span id="line-115"> if (key.equals(escapedKey)) {</span>
<span class="source-line-no">116</span><span id="line-116"> builder.append(key);</span>
<span class="source-line-no">117</span><span id="line-117"> } else {</span>
<span class="source-line-no">118</span><span id="line-118"> builder.append("'").append(escapedKey).append("'");</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"> builder.append(" =&gt; ");</span>
<span class="source-line-no">122</span><span id="line-122"> appendJRuby(builder, entry.getValue());</span>
<span class="source-line-no">123</span><span id="line-123"> }</span>
<span class="source-line-no">124</span><span id="line-124"></span>
<span class="source-line-no">125</span><span id="line-125"> if (!first) {</span>
<span class="source-line-no">126</span><span id="line-126"> builder.append(" ");</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"> builder.append("}");</span>
<span class="source-line-no">130</span><span id="line-130"> } else if (object instanceof byte[]) {</span>
<span class="source-line-no">131</span><span id="line-131"> String byteString = Bytes.toHex((byte[]) object);</span>
<span class="source-line-no">132</span><span id="line-132"> builder.append("'").append(escape(byteString)).append("'");</span>
<span class="source-line-no">133</span><span id="line-133"> } else {</span>
<span class="source-line-no">134</span><span id="line-134"> builder.append("'").append(escape(object)).append("'");</span>
<span class="source-line-no">135</span><span id="line-135"> }</span>
<span class="source-line-no">136</span><span id="line-136"> }</span>
<span class="source-line-no">137</span><span id="line-137"></span>
<span class="source-line-no">138</span><span id="line-138"> public static String print(Object object) {</span>
<span class="source-line-no">139</span><span id="line-139"> StringBuilder builder = new StringBuilder();</span>
<span class="source-line-no">140</span><span id="line-140"></span>
<span class="source-line-no">141</span><span id="line-141"> appendJRuby(builder, object);</span>
<span class="source-line-no">142</span><span id="line-142"></span>
<span class="source-line-no">143</span><span id="line-143"> return builder.toString();</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>
</pre>
</div>
</main>
</body>
</html>