| <!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, interface: RawCell"> |
| <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.util.Iterator;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.List;</span> |
| <span class="source-line-no">022</span><span id="line-22">import java.util.Optional;</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">/**</span> |
| <span class="source-line-no">026</span><span id="line-26"> * An extended version of Cell that allows CPs manipulate Tags.</span> |
| <span class="source-line-no">027</span><span id="line-27"> */</span> |
| <span class="source-line-no">028</span><span id="line-28">// Added by HBASE-19092 to expose Tags to CPs (history server) w/o exposing ExtendedCell.</span> |
| <span class="source-line-no">029</span><span id="line-29">// Why is this in hbase-common and not in hbase-server where it is used?</span> |
| <span class="source-line-no">030</span><span id="line-30">// RawCell is an odd name for a class that is only for CPs that want to manipulate Tags on</span> |
| <span class="source-line-no">031</span><span id="line-31">// server-side only w/o exposing ExtendedCell -- super rare, super exotic.</span> |
| <span class="source-line-no">032</span><span id="line-32">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)</span> |
| <span class="source-line-no">033</span><span id="line-33">public interface RawCell extends Cell {</span> |
| <span class="source-line-no">034</span><span id="line-34"> static final int MAX_TAGS_LENGTH = (2 * Short.MAX_VALUE) + 1;</span> |
| <span class="source-line-no">035</span><span id="line-35"></span> |
| <span class="source-line-no">036</span><span id="line-36"> /**</span> |
| <span class="source-line-no">037</span><span id="line-37"> * Contiguous raw bytes representing tags that may start at any index in the containing array.</span> |
| <span class="source-line-no">038</span><span id="line-38"> * @return the tags byte array</span> |
| <span class="source-line-no">039</span><span id="line-39"> */</span> |
| <span class="source-line-no">040</span><span id="line-40"> byte[] getTagsArray();</span> |
| <span class="source-line-no">041</span><span id="line-41"></span> |
| <span class="source-line-no">042</span><span id="line-42"> /**</span> |
| <span class="source-line-no">043</span><span id="line-43"> * Return the first offset where the tags start in the Cell</span> |
| <span class="source-line-no">044</span><span id="line-44"> */</span> |
| <span class="source-line-no">045</span><span id="line-45"> int getTagsOffset();</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> /**</span> |
| <span class="source-line-no">048</span><span id="line-48"> * HBase internally uses 2 bytes to store tags length in Cell. As the tags length is always a</span> |
| <span class="source-line-no">049</span><span id="line-49"> * non-negative number, to make good use of the sign bit, the max of tags length is defined 2 *</span> |
| <span class="source-line-no">050</span><span id="line-50"> * Short.MAX_VALUE + 1 = 65535. As a result, the return type is int, because a short is not</span> |
| <span class="source-line-no">051</span><span id="line-51"> * capable of handling that. Please note that even if the return type is int, the max tags length</span> |
| <span class="source-line-no">052</span><span id="line-52"> * is far less than Integer.MAX_VALUE.</span> |
| <span class="source-line-no">053</span><span id="line-53"> * @return the total length of the tags in the Cell.</span> |
| <span class="source-line-no">054</span><span id="line-54"> */</span> |
| <span class="source-line-no">055</span><span id="line-55"> int getTagsLength();</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"> * Allows cloning the tags in the cell to a new byte[]</span> |
| <span class="source-line-no">059</span><span id="line-59"> * @return the byte[] having the tags</span> |
| <span class="source-line-no">060</span><span id="line-60"> */</span> |
| <span class="source-line-no">061</span><span id="line-61"> default byte[] cloneTags() {</span> |
| <span class="source-line-no">062</span><span id="line-62"> return PrivateCellUtil.cloneTags((ExtendedCell) this);</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"> /**</span> |
| <span class="source-line-no">066</span><span id="line-66"> * Creates a list of tags in the current cell</span> |
| <span class="source-line-no">067</span><span id="line-67"> * @return a list of tags</span> |
| <span class="source-line-no">068</span><span id="line-68"> */</span> |
| <span class="source-line-no">069</span><span id="line-69"> default Iterator<Tag> getTags() {</span> |
| <span class="source-line-no">070</span><span id="line-70"> return PrivateCellUtil.tagsIterator((ExtendedCell) this);</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"> * Returns the specific tag of the given type</span> |
| <span class="source-line-no">075</span><span id="line-75"> * @param type the type of the tag</span> |
| <span class="source-line-no">076</span><span id="line-76"> * @return the specific tag if available or null</span> |
| <span class="source-line-no">077</span><span id="line-77"> */</span> |
| <span class="source-line-no">078</span><span id="line-78"> default Optional<Tag> getTag(byte type) {</span> |
| <span class="source-line-no">079</span><span id="line-79"> return PrivateCellUtil.getTag((ExtendedCell) this, type);</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"> /**</span> |
| <span class="source-line-no">083</span><span id="line-83"> * Check the length of tags. If it is invalid, throw IllegalArgumentException</span> |
| <span class="source-line-no">084</span><span id="line-84"> * @param tagsLength the given length of tags</span> |
| <span class="source-line-no">085</span><span id="line-85"> * @throws IllegalArgumentException if tagslength is invalid</span> |
| <span class="source-line-no">086</span><span id="line-86"> */</span> |
| <span class="source-line-no">087</span><span id="line-87"> public static void checkForTagsLength(int tagsLength) {</span> |
| <span class="source-line-no">088</span><span id="line-88"> if (tagsLength > MAX_TAGS_LENGTH) {</span> |
| <span class="source-line-no">089</span><span id="line-89"> throw new IllegalArgumentException("tagslength " + tagsLength + " > " + MAX_TAGS_LENGTH);</span> |
| <span class="source-line-no">090</span><span id="line-90"> }</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"> /** Returns A new cell which is having the extra tags also added to it. */</span> |
| <span class="source-line-no">094</span><span id="line-94"> public static Cell createCell(Cell cell, List<Tag> tags) {</span> |
| <span class="source-line-no">095</span><span id="line-95"> return PrivateCellUtil.createCell((ExtendedCell) cell, tags);</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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
