| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Copyright The Apache Software Foundation<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> *<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * or more contributor license agreements. See the NOTICE file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * distributed with this work for additional information<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * regarding copyright ownership. The ASF licenses this file<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * to you under the Apache License, Version 2.0 (the<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * "License"); you may not use this file except in compliance<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * with the License. You may obtain a copy of the License at<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> *<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * Unless required by applicable law or agreed to in writing, software<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * See the License for the specific language governing permissions and<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> * limitations under the License.<a name="line.18"></a> |
| <span class="sourceLineNo">019</span> */<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>package org.apache.hadoop.hbase;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.nio.ByteBuffer;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.util.ByteBufferUtils;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.yetus.audience.InterfaceStability;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>/**<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * Tags are part of cells and helps to add metadata about them.<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * Metadata could be ACLs, visibility labels, etc.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * <p><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * Each Tag is having a type (one byte) and value part. The max value length for a Tag is 65533.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * <p><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * See {@link TagType} for reserved tag types.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> */<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>@InterfaceStability.Evolving<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>public interface Tag {<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> public final static int TYPE_LENGTH_SIZE = Bytes.SIZEOF_BYTE;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> public final static int TAG_LENGTH_SIZE = Bytes.SIZEOF_SHORT;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> public final static int INFRASTRUCTURE_SIZE = TYPE_LENGTH_SIZE + TAG_LENGTH_SIZE;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> public static final int MAX_TAG_LENGTH = (2 * Short.MAX_VALUE) + 1 - TAG_LENGTH_SIZE;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> /**<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Custom tags if created are suggested to be above this range. So that<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * it does not overlap with internal tag types<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> public static final byte CUSTOM_TAG_TYPE_RANGE = (byte)64;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> /**<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * @return the tag type<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> */<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> byte getType();<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> /**<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @return Offset of tag value within the backed buffer<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> int getValueOffset();<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> /**<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * @return Length of tag value within the backed buffer<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> */<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> int getValueLength();<a name="line.64"></a> |
| <span class="sourceLineNo">065</span><a name="line.65"></a> |
| <span class="sourceLineNo">066</span> /**<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * Tells whether or not this Tag is backed by a byte array.<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * @return true when this Tag is backed by byte array<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> */<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> boolean hasArray();<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> /**<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @return The array containing the value bytes.<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> * @throws UnsupportedOperationException<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> * when {@link #hasArray()} return false. Use {@link #getValueByteBuffer()} in such<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * situation<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> */<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> byte[] getValueArray();<a name="line.78"></a> |
| <span class="sourceLineNo">079</span><a name="line.79"></a> |
| <span class="sourceLineNo">080</span> /**<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * @return The {@link java.nio.ByteBuffer} containing the value bytes.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> */<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> ByteBuffer getValueByteBuffer();<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> /**<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * Returns tag value in a new byte array. Primarily for use client-side. If server-side, use<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * {@link Tag#getValueArray()} with appropriate {@link Tag#getValueOffset()} and<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * {@link Tag#getValueLength()} instead to save on allocations.<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @param tag The Tag whose value to be returned<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @return tag value in a new byte array.<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> */<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> public static byte[] cloneValue(Tag tag) {<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> int tagLength = tag.getValueLength();<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> byte[] tagArr = new byte[tagLength];<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> if (tag.hasArray()) {<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> Bytes.putBytes(tagArr, 0, tag.getValueArray(), tag.getValueOffset(), tagLength);<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> } else {<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> ByteBufferUtils.copyFromBufferToArray(tagArr, tag.getValueByteBuffer(), tag.getValueOffset(),<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> 0, tagLength);<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> }<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> return tagArr;<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> }<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> /**<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> * Converts the value bytes of the given tag into a String value<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * @param tag The Tag<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @return value as String<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> */<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> public static String getValueAsString(Tag tag) {<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> if (tag.hasArray()) {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> return Bytes.toString(tag.getValueArray(), tag.getValueOffset(), tag.getValueLength());<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> }<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> return Bytes.toString(cloneValue(tag));<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> }<a name="line.114"></a> |
| <span class="sourceLineNo">115</span><a name="line.115"></a> |
| <span class="sourceLineNo">116</span> /**<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * Matches the value part of given tags<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * @param t1 Tag to match the value<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @param t2 Tag to match the value<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * @return True if values of both tags are same.<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> */<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> public static boolean matchingValue(Tag t1, Tag t2) {<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> if (t1.hasArray() && t2.hasArray()) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> return Bytes.equals(t1.getValueArray(), t1.getValueOffset(), t1.getValueLength(),<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> t2.getValueArray(), t2.getValueOffset(), t2.getValueLength());<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> }<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> if (t1.hasArray()) {<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> return ByteBufferUtils.equals(t2.getValueByteBuffer(), t2.getValueOffset(),<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> t2.getValueLength(), t1.getValueArray(), t1.getValueOffset(), t1.getValueLength());<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> if (t2.hasArray()) {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> return ByteBufferUtils.equals(t1.getValueByteBuffer(), t1.getValueOffset(),<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> t1.getValueLength(), t2.getValueArray(), t2.getValueOffset(), t2.getValueLength());<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> }<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> return ByteBufferUtils.equals(t1.getValueByteBuffer(), t1.getValueOffset(), t1.getValueLength(),<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> t2.getValueByteBuffer(), t2.getValueOffset(), t2.getValueLength());<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> }<a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> /**<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * Copies the tag's value bytes to the given byte array<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * @param tag The Tag<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * @param out The byte array where to copy the Tag value.<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * @param offset The offset within 'out' array where to copy the Tag value.<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> */<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> public static void copyValueTo(Tag tag, byte[] out, int offset) {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> if (tag.hasArray()) {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> Bytes.putBytes(out, offset, tag.getValueArray(), tag.getValueOffset(), tag.getValueLength());<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> } else {<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> ByteBufferUtils.copyFromBufferToArray(out, tag.getValueByteBuffer(), tag.getValueOffset(),<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> offset, tag.getValueLength());<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> }<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> }<a name="line.152"></a> |
| <span class="sourceLineNo">153</span><a name="line.153"></a> |
| <span class="sourceLineNo">154</span> /**<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * Converts the value bytes of the given tag into a long value<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * @param tag The Tag<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * @return value as long<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> */<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> public static long getValueAsLong(Tag tag) {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> if (tag.hasArray()) {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> return Bytes.toLong(tag.getValueArray(), tag.getValueOffset(), tag.getValueLength());<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> return ByteBufferUtils.toLong(tag.getValueByteBuffer(), tag.getValueOffset());<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> }<a name="line.164"></a> |
| <span class="sourceLineNo">165</span><a name="line.165"></a> |
| <span class="sourceLineNo">166</span> /**<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * Converts the value bytes of the given tag into a byte value<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * @param tag The Tag<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * @return value as byte<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> */<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> public static byte getValueAsByte(Tag tag) {<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> if (tag.hasArray()) {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> return tag.getValueArray()[tag.getValueOffset()];<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> return ByteBufferUtils.toByte(tag.getValueByteBuffer(), tag.getValueOffset());<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<a name="line.176"></a> |
| <span class="sourceLineNo">177</span>}<a name="line.177"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
