blob: ff1299e5db15a24409a4b651688d901dc8a9d385 [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: RowMutations">
<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.io.IOException;</span>
<span class="source-line-no">021</span><span id="line-21">import java.util.ArrayList;</span>
<span class="source-line-no">022</span><span id="line-22">import java.util.Collections;</span>
<span class="source-line-no">023</span><span id="line-23">import java.util.List;</span>
<span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.util.Bytes;</span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">026</span><span id="line-26"></span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hbase.thirdparty.org.apache.commons.collections4.CollectionUtils;</span>
<span class="source-line-no">028</span><span id="line-28"></span>
<span class="source-line-no">029</span><span id="line-29">/**</span>
<span class="source-line-no">030</span><span id="line-30"> * Performs multiple mutations atomically on a single row. The mutations are performed in the order</span>
<span class="source-line-no">031</span><span id="line-31"> * in which they were added.</span>
<span class="source-line-no">032</span><span id="line-32"> * &lt;p&gt;</span>
<span class="source-line-no">033</span><span id="line-33"> * We compare and equate mutations based off their row so be careful putting RowMutations into Sets</span>
<span class="source-line-no">034</span><span id="line-34"> * or using them as keys in Maps.</span>
<span class="source-line-no">035</span><span id="line-35"> */</span>
<span class="source-line-no">036</span><span id="line-36">@InterfaceAudience.Public</span>
<span class="source-line-no">037</span><span id="line-37">public class RowMutations implements Row {</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"> * Create a {@link RowMutations} with the specified mutations.</span>
<span class="source-line-no">041</span><span id="line-41"> * @param mutations the mutations to send</span>
<span class="source-line-no">042</span><span id="line-42"> * @throws IOException if any row in mutations is different to another</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 RowMutations of(List&lt;? extends Mutation&gt; mutations) throws IOException {</span>
<span class="source-line-no">045</span><span id="line-45"> if (CollectionUtils.isEmpty(mutations)) {</span>
<span class="source-line-no">046</span><span id="line-46"> throw new IllegalArgumentException("Cannot instantiate a RowMutations by empty list");</span>
<span class="source-line-no">047</span><span id="line-47"> }</span>
<span class="source-line-no">048</span><span id="line-48"> return new RowMutations(mutations.get(0).getRow(), mutations.size()).add(mutations);</span>
<span class="source-line-no">049</span><span id="line-49"> }</span>
<span class="source-line-no">050</span><span id="line-50"></span>
<span class="source-line-no">051</span><span id="line-51"> private final List&lt;Mutation&gt; mutations;</span>
<span class="source-line-no">052</span><span id="line-52"> private final byte[] row;</span>
<span class="source-line-no">053</span><span id="line-53"></span>
<span class="source-line-no">054</span><span id="line-54"> public RowMutations(byte[] row) {</span>
<span class="source-line-no">055</span><span id="line-55"> this(row, -1);</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"> /**</span>
<span class="source-line-no">059</span><span id="line-59"> * Create an atomic mutation for the specified row.</span>
<span class="source-line-no">060</span><span id="line-60"> * @param row row key</span>
<span class="source-line-no">061</span><span id="line-61"> * @param initialCapacity the initial capacity of the RowMutations</span>
<span class="source-line-no">062</span><span id="line-62"> */</span>
<span class="source-line-no">063</span><span id="line-63"> public RowMutations(byte[] row, int initialCapacity) {</span>
<span class="source-line-no">064</span><span id="line-64"> this.row = Bytes.copy(Mutation.checkRow(row));</span>
<span class="source-line-no">065</span><span id="line-65"> if (initialCapacity &lt;= 0) {</span>
<span class="source-line-no">066</span><span id="line-66"> this.mutations = new ArrayList&lt;&gt;();</span>
<span class="source-line-no">067</span><span id="line-67"> } else {</span>
<span class="source-line-no">068</span><span id="line-68"> this.mutations = new ArrayList&lt;&gt;(initialCapacity);</span>
<span class="source-line-no">069</span><span id="line-69"> }</span>
<span class="source-line-no">070</span><span id="line-70"> }</span>
<span class="source-line-no">071</span><span id="line-71"></span>
<span class="source-line-no">072</span><span id="line-72"> /**</span>
<span class="source-line-no">073</span><span id="line-73"> * Add a mutation</span>
<span class="source-line-no">074</span><span id="line-74"> * @param mutation The data to send.</span>
<span class="source-line-no">075</span><span id="line-75"> * @throws IOException if the row of added mutation doesn't match the original row</span>
<span class="source-line-no">076</span><span id="line-76"> */</span>
<span class="source-line-no">077</span><span id="line-77"> public RowMutations add(Mutation mutation) throws IOException {</span>
<span class="source-line-no">078</span><span id="line-78"> return add(Collections.singletonList(mutation));</span>
<span class="source-line-no">079</span><span id="line-79"> }</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"> * Add a list of mutations</span>
<span class="source-line-no">083</span><span id="line-83"> * @param mutations The data to send.</span>
<span class="source-line-no">084</span><span id="line-84"> * @throws IOException if the row of added mutation doesn't match the original row</span>
<span class="source-line-no">085</span><span id="line-85"> */</span>
<span class="source-line-no">086</span><span id="line-86"> public RowMutations add(List&lt;? extends Mutation&gt; mutations) throws IOException {</span>
<span class="source-line-no">087</span><span id="line-87"> for (Mutation mutation : mutations) {</span>
<span class="source-line-no">088</span><span id="line-88"> if (!Bytes.equals(row, mutation.getRow())) {</span>
<span class="source-line-no">089</span><span id="line-89"> throw new WrongRowIOException(</span>
<span class="source-line-no">090</span><span id="line-90"> "The row in the recently added Mutation &lt;" + Bytes.toStringBinary(mutation.getRow())</span>
<span class="source-line-no">091</span><span id="line-91"> + "&gt; doesn't match the original one &lt;" + Bytes.toStringBinary(this.row) + "&gt;");</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"> this.mutations.addAll(mutations);</span>
<span class="source-line-no">095</span><span id="line-95"> return this;</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"> @Override</span>
<span class="source-line-no">099</span><span id="line-99"> public byte[] getRow() {</span>
<span class="source-line-no">100</span><span id="line-100"> return row;</span>
<span class="source-line-no">101</span><span id="line-101"> }</span>
<span class="source-line-no">102</span><span id="line-102"></span>
<span class="source-line-no">103</span><span id="line-103"> /** Returns An unmodifiable list of the current mutations. */</span>
<span class="source-line-no">104</span><span id="line-104"> public List&lt;Mutation&gt; getMutations() {</span>
<span class="source-line-no">105</span><span id="line-105"> return Collections.unmodifiableList(mutations);</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"> public int getMaxPriority() {</span>
<span class="source-line-no">109</span><span id="line-109"> int maxPriority = Integer.MIN_VALUE;</span>
<span class="source-line-no">110</span><span id="line-110"> for (Mutation mutation : mutations) {</span>
<span class="source-line-no">111</span><span id="line-111"> maxPriority = Math.max(maxPriority, mutation.getPriority());</span>
<span class="source-line-no">112</span><span id="line-112"> }</span>
<span class="source-line-no">113</span><span id="line-113"> return maxPriority;</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>
</pre>
</div>
</main>
</body>
</html>