blob: 4d102462bdbaaf3ec9495ea617415c2bf0bd64bc [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.client, class: OperationWithAttributes">
<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.client;</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.Collections;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.HashMap;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.Map;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.TreeMap;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.stream.Collectors;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.HConstants;</span>
<span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.util.ClassSize;</span>
<span class="source-line-no">028</span><span id="line-28">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">029</span><span id="line-29"></span>
<span class="source-line-no">030</span><span id="line-30">@InterfaceAudience.Public</span>
<span class="source-line-no">031</span><span id="line-31">public abstract class OperationWithAttributes extends Operation implements Attributes {</span>
<span class="source-line-no">032</span><span id="line-32"> // An opaque blob of attributes</span>
<span class="source-line-no">033</span><span id="line-33"> private Map&lt;String, byte[]&gt; attributes;</span>
<span class="source-line-no">034</span><span id="line-34"></span>
<span class="source-line-no">035</span><span id="line-35"> // used for uniquely identifying an operation</span>
<span class="source-line-no">036</span><span id="line-36"> public static final String ID_ATRIBUTE = "_operation.attributes.id";</span>
<span class="source-line-no">037</span><span id="line-37"> private int priority = HConstants.PRIORITY_UNSET;</span>
<span class="source-line-no">038</span><span id="line-38"></span>
<span class="source-line-no">039</span><span id="line-39"> /**</span>
<span class="source-line-no">040</span><span id="line-40"> * empty construction. We need this empty construction to keep binary compatibility.</span>
<span class="source-line-no">041</span><span id="line-41"> */</span>
<span class="source-line-no">042</span><span id="line-42"> protected OperationWithAttributes() {</span>
<span class="source-line-no">043</span><span id="line-43"> }</span>
<span class="source-line-no">044</span><span id="line-44"></span>
<span class="source-line-no">045</span><span id="line-45"> protected OperationWithAttributes(OperationWithAttributes clone) {</span>
<span class="source-line-no">046</span><span id="line-46"> this.attributes = clone.getAttributesMap() == null</span>
<span class="source-line-no">047</span><span id="line-47"> ? null</span>
<span class="source-line-no">048</span><span id="line-48"> : clone.getAttributesMap().entrySet().stream()</span>
<span class="source-line-no">049</span><span id="line-49"> .collect(Collectors.toMap(e -&gt; e.getKey(), e -&gt; e.getValue(), (k, v) -&gt; {</span>
<span class="source-line-no">050</span><span id="line-50"> throw new RuntimeException("collisions!!!");</span>
<span class="source-line-no">051</span><span id="line-51"> }, () -&gt; new TreeMap&lt;&gt;()));</span>
<span class="source-line-no">052</span><span id="line-52"> this.priority = clone.getPriority();</span>
<span class="source-line-no">053</span><span id="line-53"> }</span>
<span class="source-line-no">054</span><span id="line-54"></span>
<span class="source-line-no">055</span><span id="line-55"> @Override</span>
<span class="source-line-no">056</span><span id="line-56"> public OperationWithAttributes setAttribute(String name, byte[] value) {</span>
<span class="source-line-no">057</span><span id="line-57"> if (attributes == null &amp;&amp; value == null) {</span>
<span class="source-line-no">058</span><span id="line-58"> return this;</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"> if (attributes == null) {</span>
<span class="source-line-no">062</span><span id="line-62"> attributes = new HashMap&lt;&gt;();</span>
<span class="source-line-no">063</span><span id="line-63"> }</span>
<span class="source-line-no">064</span><span id="line-64"></span>
<span class="source-line-no">065</span><span id="line-65"> if (value == null) {</span>
<span class="source-line-no">066</span><span id="line-66"> attributes.remove(name);</span>
<span class="source-line-no">067</span><span id="line-67"> if (attributes.isEmpty()) {</span>
<span class="source-line-no">068</span><span id="line-68"> this.attributes = null;</span>
<span class="source-line-no">069</span><span id="line-69"> }</span>
<span class="source-line-no">070</span><span id="line-70"> } else {</span>
<span class="source-line-no">071</span><span id="line-71"> attributes.put(name, value);</span>
<span class="source-line-no">072</span><span id="line-72"> }</span>
<span class="source-line-no">073</span><span id="line-73"> return this;</span>
<span class="source-line-no">074</span><span id="line-74"> }</span>
<span class="source-line-no">075</span><span id="line-75"></span>
<span class="source-line-no">076</span><span id="line-76"> @Override</span>
<span class="source-line-no">077</span><span id="line-77"> public byte[] getAttribute(String name) {</span>
<span class="source-line-no">078</span><span id="line-78"> if (attributes == null) {</span>
<span class="source-line-no">079</span><span id="line-79"> return null;</span>
<span class="source-line-no">080</span><span id="line-80"> }</span>
<span class="source-line-no">081</span><span id="line-81"></span>
<span class="source-line-no">082</span><span id="line-82"> return attributes.get(name);</span>
<span class="source-line-no">083</span><span id="line-83"> }</span>
<span class="source-line-no">084</span><span id="line-84"></span>
<span class="source-line-no">085</span><span id="line-85"> @Override</span>
<span class="source-line-no">086</span><span id="line-86"> public Map&lt;String, byte[]&gt; getAttributesMap() {</span>
<span class="source-line-no">087</span><span id="line-87"> if (attributes == null) {</span>
<span class="source-line-no">088</span><span id="line-88"> return Collections.emptyMap();</span>
<span class="source-line-no">089</span><span id="line-89"> }</span>
<span class="source-line-no">090</span><span id="line-90"> return Collections.unmodifiableMap(attributes);</span>
<span class="source-line-no">091</span><span id="line-91"> }</span>
<span class="source-line-no">092</span><span id="line-92"></span>
<span class="source-line-no">093</span><span id="line-93"> protected long getAttributeSize() {</span>
<span class="source-line-no">094</span><span id="line-94"> long size = 0;</span>
<span class="source-line-no">095</span><span id="line-95"> if (attributes != null) {</span>
<span class="source-line-no">096</span><span id="line-96"> size += ClassSize.align(this.attributes.size() * ClassSize.MAP_ENTRY);</span>
<span class="source-line-no">097</span><span id="line-97"> for (Map.Entry&lt;String, byte[]&gt; entry : this.attributes.entrySet()) {</span>
<span class="source-line-no">098</span><span id="line-98"> size += ClassSize.align(ClassSize.STRING + entry.getKey().length());</span>
<span class="source-line-no">099</span><span id="line-99"> size += ClassSize.align(ClassSize.ARRAY + entry.getValue().length);</span>
<span class="source-line-no">100</span><span id="line-100"> }</span>
<span class="source-line-no">101</span><span id="line-101"> }</span>
<span class="source-line-no">102</span><span id="line-102"> return size;</span>
<span class="source-line-no">103</span><span id="line-103"> }</span>
<span class="source-line-no">104</span><span id="line-104"></span>
<span class="source-line-no">105</span><span id="line-105"> /**</span>
<span class="source-line-no">106</span><span id="line-106"> * This method allows you to set an identifier on an operation. The original motivation for this</span>
<span class="source-line-no">107</span><span id="line-107"> * was to allow the identifier to be used in slow query logging, but this could obviously be</span>
<span class="source-line-no">108</span><span id="line-108"> * useful in other places. One use of this could be to put a class.method identifier in here to</span>
<span class="source-line-no">109</span><span id="line-109"> * see where the slow query is coming from. id to set for the scan</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 OperationWithAttributes setId(String id) {</span>
<span class="source-line-no">112</span><span id="line-112"> setAttribute(ID_ATRIBUTE, Bytes.toBytes(id));</span>
<span class="source-line-no">113</span><span id="line-113"> return this;</span>
<span class="source-line-no">114</span><span id="line-114"> }</span>
<span class="source-line-no">115</span><span id="line-115"></span>
<span class="source-line-no">116</span><span id="line-116"> /**</span>
<span class="source-line-no">117</span><span id="line-117"> * This method allows you to retrieve the identifier for the operation if one was set.</span>
<span class="source-line-no">118</span><span id="line-118"> * @return the id or null if not set</span>
<span class="source-line-no">119</span><span id="line-119"> */</span>
<span class="source-line-no">120</span><span id="line-120"> public String getId() {</span>
<span class="source-line-no">121</span><span id="line-121"> byte[] attr = getAttribute(ID_ATRIBUTE);</span>
<span class="source-line-no">122</span><span id="line-122"> return attr == null ? null : Bytes.toString(attr);</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"> public OperationWithAttributes setPriority(int priority) {</span>
<span class="source-line-no">126</span><span id="line-126"> this.priority = priority;</span>
<span class="source-line-no">127</span><span id="line-127"> return this;</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"> public int getPriority() {</span>
<span class="source-line-no">131</span><span id="line-131"> return priority;</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">}</span>
</pre>
</div>
</main>
</body>
</html>