http://git-wip-us.apache.org/repos/asf/hbase-site/blob/97d559f1/2.0/apidocs/org/apache/hadoop/hbase/KeyValue.html ---------------------------------------------------------------------- diff --git a/2.0/apidocs/org/apache/hadoop/hbase/KeyValue.html b/2.0/apidocs/org/apache/hadoop/hbase/KeyValue.html new file mode 100644 index 0000000..12f399e --- /dev/null +++ b/2.0/apidocs/org/apache/hadoop/hbase/KeyValue.html @@ -0,0 +1,3086 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>KeyValue (Apache HBase 2.0.0-beta-2 API)</title> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="KeyValue (Apache HBase 2.0.0-beta-2 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":9,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":9,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":9,"i15":10,"i16":10,"i17":10,"i18":9,"i19":9,"i20":9,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":9,"i43":10,"i44":9,"i45":9,"i46":41,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":9,"i56":10,"i57":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/KeyValue.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/KeyValue.KeyOnlyKeyValue.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/hadoop/hbase/KeyValue.html" target="_top">Frames</a></li> +<li><a href="KeyValue.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.hadoop.hbase</div> +<h2 title="Class KeyValue" class="title">Class KeyValue</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hadoop.hbase.KeyValue</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>, <a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/io/HeapSize.html" title="interface in org.apache.hadoop.hbase.io">HeapSize</a>, <a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase">RawCell</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/hadoop/hbase/KeyValue.KeyOnlyKeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue.KeyOnlyKeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/NoTagsKeyValue.html" title="class in org.apache.hadoop.hbase">NoTagsKeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/SizeCachedKeyValue.html" title="class in org.apache.hadoop.hbase">SizeCachedKeyValue</a></dd> +</dl> +<hr> +<br> +<pre>@InterfaceAudience.Private +public class <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.79">KeyValue</a> +extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> +implements <a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></pre> +<div class="block">An HBase Key/Value. This is the fundamental HBase Type. + <p> + HBase applications and users should use the Cell interface and avoid directly using KeyValue and + member functions not defined in Cell. + <p> + If being used client-side, the primary methods to access individual fields are + <a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getRowArray--"><code>getRowArray()</code></a>, <a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getFamilyArray--"><code>getFamilyArray()</code></a>, <a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getQualifierArray--"><code>getQualifierArray()</code></a>, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getTimestamp--"><code>getTimestamp()</code></a>, and <a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getValueArray--"><code>getValueArray()</code></a>. These methods allocate new byte arrays + and return copies. Avoid their use server-side. + <p> + Instances of this class are immutable. They do not implement Comparable but Comparators are + provided. Comparators change with context, whether user table or a catalog table comparison. Its + critical you use the appropriate comparator. There are Comparators for normal HFiles, Meta's + Hfiles, and bloom filter keys. + <p> + KeyValue wraps a byte array and takes offsets and lengths into passed array at where to start + interpreting the content as KeyValue. The KeyValue format inside a byte array is: + <code><keylength> <valuelength> <key> <value></code> Key is further + decomposed as: <code><rowlength> <row> <columnfamilylength> + <columnfamily> <columnqualifier> + <timestamp> <keytype></code> The <code>rowlength</code> maximum is + <code>Short.MAX_SIZE</code>, column family length maximum is <code>Byte.MAX_SIZE</code>, and + column qualifier + key length must be < <code>Integer.MAX_SIZE</code>. The column does not + contain the family/qualifier delimiter, <a href="../../../../org/apache/hadoop/hbase/KeyValue.html#COLUMN_FAMILY_DELIMITER"><code>COLUMN_FAMILY_DELIMITER</code></a><br> + KeyValue can optionally contain Tags. When it contains tags, it is added in the byte array after + the value part. The format for this part is: <code><tagslength><tagsbytes></code>. + <code>tagslength</code> maximum is <code>Short.MAX_SIZE</code>. The <code>tagsbytes</code> + contain one or more tags where as each tag is of the form + <code><taglength><tagtype><tagbytes></code>. <code>tagtype</code> is one byte + and <code>taglength</code> maximum is <code>Short.MAX_SIZE</code> and it includes 1 byte type + length and actual tag bytes length.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.KeyOnlyKeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue.KeyOnlyKeyValue</a></span></code> +<div class="block">A simple form of KeyValue that creates a keyvalue with only the key part of the byte[] + Mainly used in places where we need to compare two cells.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.KVComparator.html" title="class in org.apache.hadoop.hbase">KeyValue.KVComparator</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">: Use <a href="../../../../org/apache/hadoop/hbase/CellComparatorImpl.html" title="class in org.apache.hadoop.hbase"><code>CellComparatorImpl</code></a>. Deprecated for hbase 2.0, remove for hbase 3.0.</span></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.MetaComparator.html" title="class in org.apache.hadoop.hbase">KeyValue.MetaComparator</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">: <a href="../../../../org/apache/hadoop/hbase/CellComparatorImpl.html#META_COMPARATOR"><code>CellComparatorImpl.META_COMPARATOR</code></a> to be used. Deprecated for hbase 2.0, remove for hbase 3.0.</span></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.SamePrefixComparator.html" title="interface in org.apache.hadoop.hbase">KeyValue.SamePrefixComparator</a><<a href="../../../../org/apache/hadoop/hbase/KeyValue.SamePrefixComparator.html" title="type parameter in KeyValue.SamePrefixComparator">T</a>></span></code> +<div class="block">Avoids redundant comparisons for better performance.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a></span></code> +<div class="block">Key type.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#bytes">bytes</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#COLUMN_FAMILY_DELIM_ARRAY">COLUMN_FAMILY_DELIM_ARRAY</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static char</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#COLUMN_FAMILY_DELIMITER">COLUMN_FAMILY_DELIMITER</a></span></code> +<div class="block">Colon character in UTF-8</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/KeyValue.KVComparator.html" title="class in org.apache.hadoop.hbase">KeyValue.KVComparator</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#COMPARATOR">COMPARATOR</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/hbase/CellComparator.html#getInstance--"><code>CellComparator.getInstance()</code></a> instead. Deprecated for hbase 2.0, remove for hbase 3.0.</span></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#FAMILY_LENGTH_SIZE">FAMILY_LENGTH_SIZE</a></span></code> +<div class="block">Size of the family length field in bytes</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#FIXED_OVERHEAD">FIXED_OVERHEAD</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KEY_INFRASTRUCTURE_SIZE">KEY_INFRASTRUCTURE_SIZE</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KEY_LENGTH_SIZE">KEY_LENGTH_SIZE</a></span></code> +<div class="block">Size of the key length field in bytes</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KEYVALUE_INFRASTRUCTURE_SIZE">KEYVALUE_INFRASTRUCTURE_SIZE</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KEYVALUE_WITH_TAGS_INFRASTRUCTURE_SIZE">KEYVALUE_WITH_TAGS_INFRASTRUCTURE_SIZE</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#length">length</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#LOWESTKEY">LOWESTKEY</a></span></code> +<div class="block">Lowest possible key.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/KeyValue.KVComparator.html" title="class in org.apache.hadoop.hbase">KeyValue.KVComparator</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#META_COMPARATOR">META_COMPARATOR</a></span></code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/hbase/CellComparatorImpl.html#META_COMPARATOR"><code>CellComparatorImpl.META_COMPARATOR</code></a> instead. Deprecated for hbase 2.0, remove for hbase 3.0.</span></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#offset">offset</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#ROW_KEY_OFFSET">ROW_KEY_OFFSET</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#ROW_LENGTH_SIZE">ROW_LENGTH_SIZE</a></span></code> +<div class="block">Size of the row length field in bytes</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#ROW_OFFSET">ROW_OFFSET</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#TAGS_LENGTH_SIZE">TAGS_LENGTH_SIZE</a></span></code> +<div class="block">Size of the tags length field in bytes</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#TIMESTAMP_SIZE">TIMESTAMP_SIZE</a></span></code> +<div class="block">Size of the timestamp field in bytes</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#TIMESTAMP_TYPE_SIZE">TIMESTAMP_TYPE_SIZE</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#TYPE_SIZE">TYPE_SIZE</a></span></code> +<div class="block">Size of the key type field in bytes</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.hbase.ExtendedCell"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></h3> +<code><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#CELL_NOT_BASED_ON_CHUNK">CELL_NOT_BASED_ON_CHUNK</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.hbase.RawCell"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase">RawCell</a></h3> +<code><a href="../../../../org/apache/hadoop/hbase/RawCell.html#MAX_TAGS_LENGTH">MAX_TAGS_LENGTH</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue--">KeyValue</a></span>()</code> +<div class="block">Writable Constructor -- DO NOT USE</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-">KeyValue</a></span>(byte[] bytes)</code> +<div class="block">Creates a KeyValue from the start of the specified byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-byte:A-byte:A-">KeyValue</a></span>(byte[] row, + byte[] family, + byte[] qualifier)</code> +<div class="block">Constructs KeyValue structure filled with null value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-byte:A-byte:A-byte:A-">KeyValue</a></span>(byte[] row, + byte[] family, + byte[] qualifier, + byte[] value)</code> +<div class="block">Constructs KeyValue structure as a put filled with specified values and + LATEST_TIMESTAMP.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-byte:A-byte:A-int-int-long-org.apache.hadoop.hbase.KeyValue.Type-byte:A-int-int-byte:A-">KeyValue</a></span>(byte[] row, + byte[] family, + byte[] qualifier, + int qoffset, + int qlength, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type, + byte[] value, + int voffset, + int vlength, + byte[] tags)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-byte:A-byte:A-int-int-long-org.apache.hadoop.hbase.KeyValue.Type-byte:A-int-int-java.util.List-">KeyValue</a></span>(byte[] row, + byte[] family, + byte[] qualifier, + int qoffset, + int qlength, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type, + byte[] value, + int voffset, + int vlength, + <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> tags)</code> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-byte:A-byte:A-long-byte:A-">KeyValue</a></span>(byte[] row, + byte[] family, + byte[] qualifier, + long timestamp, + byte[] value)</code> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-byte:A-byte:A-long-byte:A-java.util.List-">KeyValue</a></span>(byte[] row, + byte[] family, + byte[] qualifier, + long timestamp, + byte[] value, + <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> tags)</code> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-byte:A-byte:A-long-byte:A-org.apache.hadoop.hbase.Tag:A-">KeyValue</a></span>(byte[] row, + byte[] family, + byte[] qualifier, + long timestamp, + byte[] value, + <a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>[] tags)</code> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-byte:A-byte:A-long-org.apache.hadoop.hbase.KeyValue.Type-">KeyValue</a></span>(byte[] row, + byte[] family, + byte[] qualifier, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type)</code> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-byte:A-byte:A-long-org.apache.hadoop.hbase.KeyValue.Type-byte:A-">KeyValue</a></span>(byte[] row, + byte[] family, + byte[] qualifier, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type, + byte[] value)</code> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-byte:A-byte:A-long-org.apache.hadoop.hbase.KeyValue.Type-byte:A-byte:A-">KeyValue</a></span>(byte[] row, + byte[] family, + byte[] qualifier, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type, + byte[] value, + byte[] tags)</code> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-byte:A-byte:A-long-org.apache.hadoop.hbase.KeyValue.Type-byte:A-java.util.List-">KeyValue</a></span>(byte[] row, + byte[] family, + byte[] qualifier, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type, + byte[] value, + <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> tags)</code> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-int-">KeyValue</a></span>(byte[] bytes, + int offset)</code> +<div class="block">Creates a KeyValue from the specified byte array and offset.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-int-byte:A-int-int-byte:A-int-int-byte:A-int-int-long-org.apache.hadoop.hbase.KeyValue.Type-byte:A-int-int-org.apache.hadoop.hbase.Tag:A-">KeyValue</a></span>(byte[] buffer, + int boffset, + byte[] row, + int roffset, + int rlength, + byte[] family, + int foffset, + int flength, + byte[] qualifier, + int qoffset, + int qlength, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type, + byte[] value, + int voffset, + int vlength, + <a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>[] tags)</code> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-int-int-">KeyValue</a></span>(byte[] bytes, + int offset, + int length)</code> +<div class="block">Creates a KeyValue from the specified byte array, starting at offset, and + for length <code>length</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-int-int-byte:A-int-int-byte:A-int-int-long-org.apache.hadoop.hbase.KeyValue.Type-byte:A-int-int-">KeyValue</a></span>(byte[] row, + int roffset, + int rlength, + byte[] family, + int foffset, + int flength, + byte[] qualifier, + int qoffset, + int qlength, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type, + byte[] value, + int voffset, + int vlength)</code> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-int-int-byte:A-int-int-byte:A-int-int-long-org.apache.hadoop.hbase.KeyValue.Type-byte:A-int-int-byte:A-int-int-">KeyValue</a></span>(byte[] row, + int roffset, + int rlength, + byte[] family, + int foffset, + int flength, + byte[] qualifier, + int qoffset, + int qlength, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type, + byte[] value, + int voffset, + int vlength, + byte[] tags, + int tagsOffset, + int tagsLength)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-int-int-byte:A-int-int-byte:A-int-int-long-org.apache.hadoop.hbase.KeyValue.Type-byte:A-int-int-java.util.List-">KeyValue</a></span>(byte[] row, + int roffset, + int rlength, + byte[] family, + int foffset, + int flength, + byte[] qualifier, + int qoffset, + int qlength, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type, + byte[] value, + int voffset, + int vlength, + <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> tags)</code> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-int-int-byte:A-int-int-java.nio.ByteBuffer-long-org.apache.hadoop.hbase.KeyValue.Type-java.nio.ByteBuffer-java.util.List-">KeyValue</a></span>(byte[] row, + int roffset, + int rlength, + byte[] family, + int foffset, + int flength, + <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> qualifier, + long ts, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type, + <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> value, + <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> tags)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-int-int-long-">KeyValue</a></span>(byte[] bytes, + int offset, + int length, + long ts)</code> +<div class="block">Creates a KeyValue from the specified byte array, starting at offset, and + for length <code>length</code>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-long-">KeyValue</a></span>(byte[] row, + long timestamp)</code> +<div class="block">Constructs KeyValue structure filled with null value.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-byte:A-long-org.apache.hadoop.hbase.KeyValue.Type-">KeyValue</a></span>(byte[] row, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type)</code> +<div class="block">Constructs KeyValue structure filled with null value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-org.apache.hadoop.hbase.Cell-">KeyValue</a></span>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-int-int-int-long-org.apache.hadoop.hbase.KeyValue.Type-int-">KeyValue</a></span>(int rlength, + int flength, + int qlength, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type, + int vlength)</code> +<div class="block">Constructs an empty KeyValue structure, with specified sizes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue-int-int-int-long-org.apache.hadoop.hbase.KeyValue.Type-int-int-">KeyValue</a></span>(int rlength, + int flength, + int qlength, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type, + int vlength, + int tagsLength)</code> +<div class="block">Constructs an empty KeyValue structure, with specified sizes.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#clone--">clone</a></span>()</code> +<div class="block">Clones a KeyValue.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#create-java.io.DataInput-">create</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</a> in)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#create-int-java.io.DataInput-">create</a></span>(int length, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</a> in)</code> +<div class="block">Create a KeyValue reading <code>length</code> from <code>in</code></div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#createKeyOnly-boolean-">createKeyOnly</a></span>(boolean lenAsVal)</code> +<div class="block">Creates a new KeyValue that only contains the key portion (the value is + set to be null).</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#deepClone--">deepClone</a></span>()</code> +<div class="block">Does a deep copy of the contents to a new memory area and returns it as a new cell.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> other)</code> +<div class="block">Needed doing 'contains' on List.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getBuffer--">getBuffer</a></span>()</code> +<div class="block">To be used only in tests where the Cells are clearly assumed to be of type KeyValue + and that we need access to the backing array to do some test case related assertions.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getDelimiter-byte:A-int-int-int-">getDelimiter</a></span>(byte[] b, + int offset, + int length, + int delimiter)</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getDelimiterInReverse-byte:A-int-int-int-">getDelimiterInReverse</a></span>(byte[] b, + int offset, + int length, + int delimiter)</code> +<div class="block">Find index of passed delimiter walking from end of buffer backwards.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getFamilyArray--">getFamilyArray</a></span>()</code> +<div class="block">Contiguous bytes composed of legal HDFS filename characters which may start at any index in the + containing array.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>byte</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getFamilyLength--">getFamilyLength</a></span>()</code> </td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>byte</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getFamilyLength-int-">getFamilyLength</a></span>(int foffset)</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getFamilyOffset--">getFamilyOffset</a></span>()</code> </td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getKey--">getKey</a></span>()</code> +<div class="block">Do not use unless you have to.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getKeyDataStructureSize-int-int-int-">getKeyDataStructureSize</a></span>(int rlength, + int flength, + int qlength)</code> +<div class="block">Computes the number of bytes that a <code>KeyValue</code> instance with the provided + characteristics would take up in its underlying data structure for the key.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getKeyLength--">getKeyLength</a></span>()</code> </td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getKeyOffset--">getKeyOffset</a></span>()</code> </td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getKeyString--">getKeyString</a></span>()</code> </td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getKeyValueDataStructureSize-int-int-int-">getKeyValueDataStructureSize</a></span>(int klength, + int vlength, + int tagsLength)</code> +<div class="block">Computes the number of bytes that a <code>KeyValue</code> instance with the provided + characteristics would take up for its underlying data structure.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getKeyValueDataStructureSize-int-int-int-int-">getKeyValueDataStructureSize</a></span>(int rlength, + int flength, + int qlength, + int vlength)</code> +<div class="block">Computes the number of bytes that a <code>KeyValue</code> instance with the provided + characteristics would take up for its underlying data structure.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getKeyValueDataStructureSize-int-int-int-int-int-">getKeyValueDataStructureSize</a></span>(int rlength, + int flength, + int qlength, + int vlength, + int tagsLength)</code> +<div class="block">Computes the number of bytes that a <code>KeyValue</code> instance with the provided + characteristics would take up for its underlying data structure.</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getLength--">getLength</a></span>()</code> </td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getOffset--">getOffset</a></span>()</code> </td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getQualifierArray--">getQualifierArray</a></span>()</code> +<div class="block">Contiguous raw bytes that may start at any index in the containing array.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getQualifierLength--">getQualifierLength</a></span>()</code> </td> +</tr> +<tr id="i25" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getQualifierOffset--">getQualifierOffset</a></span>()</code> </td> +</tr> +<tr id="i26" class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getRowArray--">getRowArray</a></span>()</code> +<div class="block">Contiguous raw bytes that may start at any index in the containing array.</div> +</td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code>short</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getRowLength--">getRowLength</a></span>()</code> </td> +</tr> +<tr id="i28" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getRowOffset--">getRowOffset</a></span>()</code> </td> +</tr> +<tr id="i29" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getSequenceId--">getSequenceId</a></span>()</code> +<div class="block">used to achieve atomic operations in the memstore.</div> +</td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getSerializedSize-boolean-">getSerializedSize</a></span>(boolean withTags)</code> </td> +</tr> +<tr id="i31" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getTagsArray--">getTagsArray</a></span>()</code> +<div class="block">Contiguous raw bytes representing tags that may start at any index in the containing array.</div> +</td> +</tr> +<tr id="i32" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getTagsLength--">getTagsLength</a></span>()</code> +<div class="block">This returns the total length of the tag bytes</div> +</td> +</tr> +<tr id="i33" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getTagsOffset--">getTagsOffset</a></span>()</code> +<div class="block">This returns the offset where the tag actually starts.</div> +</td> +</tr> +<tr id="i34" class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getTimestamp--">getTimestamp</a></span>()</code> </td> +</tr> +<tr id="i35" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getTimestampOffset--">getTimestampOffset</a></span>()</code> </td> +</tr> +<tr id="i36" class="altColor"> +<td class="colFirst"><code>byte</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getTypeByte--">getTypeByte</a></span>()</code> </td> +</tr> +<tr id="i37" class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getValueArray--">getValueArray</a></span>()</code> +<div class="block">Contiguous raw bytes that may start at any index in the containing array.</div> +</td> +</tr> +<tr id="i38" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getValueLength--">getValueLength</a></span>()</code> </td> +</tr> +<tr id="i39" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getValueOffset--">getValueOffset</a></span>()</code> </td> +</tr> +<tr id="i40" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#hashCode--">hashCode</a></span>()</code> +<div class="block">In line with <a href="../../../../org/apache/hadoop/hbase/KeyValue.html#equals-java.lang.Object-"><code>equals(Object)</code></a>, only uses the key portion, not the value.</div> +</td> +</tr> +<tr id="i41" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#heapSize--">heapSize</a></span>()</code> +<div class="block">HeapSize implementation + + We do not count the bytes in the rowCache because it should be empty for a KeyValue in the + MemStore.</div> +</td> +</tr> +<tr id="i42" class="altColor"> +<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#humanReadableTimestamp-long-">humanReadableTimestamp</a></span>(long timestamp)</code> </td> +</tr> +<tr id="i43" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#isLatestTimestamp--">isLatestTimestamp</a></span>()</code> </td> +</tr> +<tr id="i44" class="altColor"> +<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#keyToString-byte:A-">keyToString</a></span>(byte[] k)</code> </td> +</tr> +<tr id="i45" class="rowColor"> +<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#keyToString-byte:A-int-int-">keyToString</a></span>(byte[] b, + int o, + int l)</code> +<div class="block">Use for logging.</div> +</td> +</tr> +<tr id="i46" class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#oswrite-org.apache.hadoop.hbase.KeyValue-java.io.OutputStream-boolean-">oswrite</a></span>(<a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a> kv, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out, + boolean withTags)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">As of release 2.0.0, this will be removed in HBase 3.0.0. + Instead use <a href="../../../../org/apache/hadoop/hbase/KeyValue.html#write-java.io.OutputStream-boolean-"><code>write(OutputStream, boolean)</code></a></span></div> +</div> +</td> +</tr> +<tr id="i47" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#setSequenceId-long-">setSequenceId</a></span>(long seqId)</code> +<div class="block">Sets with the given seqId.</div> +</td> +</tr> +<tr id="i48" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#setTimestamp-byte:A-">setTimestamp</a></span>(byte[] ts)</code> +<div class="block">Sets with the given timestamp.</div> +</td> +</tr> +<tr id="i49" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#setTimestamp-long-">setTimestamp</a></span>(long ts)</code> +<div class="block">Sets with the given timestamp.</div> +</td> +</tr> +<tr id="i50" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#shallowCopy--">shallowCopy</a></span>()</code> +<div class="block">Creates a shallow copy of this KeyValue, reusing the data byte buffer.</div> +</td> +</tr> +<tr id="i51" class="rowColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#toString--">toString</a></span>()</code> </td> +</tr> +<tr id="i52" class="altColor"> +<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#toStringMap--">toStringMap</a></span>()</code> +<div class="block">Produces a string map for this key/value pair.</div> +</td> +</tr> +<tr id="i53" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#updateLatestStamp-byte:A-">updateLatestStamp</a></span>(byte[] now)</code> </td> +</tr> +<tr id="i54" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#write-java.nio.ByteBuffer-int-">write</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> buf, + int offset)</code> +<div class="block">Write this Cell into the given buf's offset in a <a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase"><code>KeyValue</code></a> format.</div> +</td> +</tr> +<tr id="i55" class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#write-org.apache.hadoop.hbase.KeyValue-java.io.DataOutput-">write</a></span>(<a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a> kv, + <a href="https://docs.oracle.com/javase/8/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io">DataOutput</a> out)</code> +<div class="block">Write out a KeyValue in the manner in which we used to when KeyValue was a Writable.</div> +</td> +</tr> +<tr id="i56" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#write-java.io.OutputStream-boolean-">write</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out, + boolean withTags)</code> +<div class="block">Write this cell to an OutputStream in a <a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase"><code>KeyValue</code></a> format.</div> +</td> +</tr> +<tr id="i57" class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#writeByteArray-byte:A-int-byte:A-int-int-byte:A-int-int-byte:A-int-int-long-org.apache.hadoop.hbase.KeyValue.Type-byte:A-int-int-org.apache.hadoop.hbase.Tag:A-">writeByteArray</a></span>(byte[] buffer, + int boffset, + byte[] row, + int roffset, + int rlength, + byte[] family, + int foffset, + int flength, + byte[] qualifier, + int qoffset, + int qlength, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type, + byte[] value, + int voffset, + int vlength, + <a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>[] tags)</code> +<div class="block">Write KeyValue format into the provided byte array.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.h tml?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.ExtendedCell"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></h3> +<code><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#getChunkId--">getChunkId</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.RawCell"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase">RawCell</a></h3> +<code><a href="../../../../org/apache/hadoop/hbase/RawCell.html#checkForTagsLength-int-">checkForTagsLength</a>, <a href="../../../../org/apache/hadoop/hbase/RawCell.html#cloneTags--">cloneTags</a>, <a href="../../../../org/apache/hadoop/hbase/RawCell.html#getTag-byte-">getTag</a>, <a href="../../../../org/apache/hadoop/hbase/RawCell.html#getTags--">getTags</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.Cell"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></h3> +<code><a href="../../../../org/apache/hadoop/hbase/Cell.html#getType--">getType</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="FIXED_OVERHEAD"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FIXED_OVERHEAD</h4> +<pre>public static final int <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.84">FIXED_OVERHEAD</a></pre> +</li> +</ul> +<a name="COLUMN_FAMILY_DELIMITER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COLUMN_FAMILY_DELIMITER</h4> +<pre>public static final char <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.92">COLUMN_FAMILY_DELIMITER</a></pre> +<div class="block">Colon character in UTF-8</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.KeyValue.COLUMN_FAMILY_DELIMITER">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="COLUMN_FAMILY_DELIM_ARRAY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COLUMN_FAMILY_DELIM_ARRAY</h4> +<pre>public static final byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.94">COLUMN_FAMILY_DELIM_ARRAY</a></pre> +</li> +</ul> +<a name="COMPARATOR"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COMPARATOR</h4> +<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +public static final <a href="../../../../org/apache/hadoop/hbase/KeyValue.KVComparator.html" title="class in org.apache.hadoop.hbase">KeyValue.KVComparator</a> <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.103">COMPARATOR</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/hbase/CellComparator.html#getInstance--"><code>CellComparator.getInstance()</code></a> instead. Deprecated for hbase 2.0, remove for hbase 3.0.</span></div> +<div class="block">Comparator for plain key/values; i.e. non-catalog table key/values. Works on Key portion + of KeyValue only.</div> +</li> +</ul> +<a name="META_COMPARATOR"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>META_COMPARATOR</h4> +<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +public static final <a href="../../../../org/apache/hadoop/hbase/KeyValue.KVComparator.html" title="class in org.apache.hadoop.hbase">KeyValue.KVComparator</a> <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.110">META_COMPARATOR</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../org/apache/hadoop/hbase/CellComparatorImpl.html#META_COMPARATOR"><code>CellComparatorImpl.META_COMPARATOR</code></a> instead. Deprecated for hbase 2.0, remove for hbase 3.0.</span></div> +<div class="block">A <a href="../../../../org/apache/hadoop/hbase/KeyValue.KVComparator.html" title="class in org.apache.hadoop.hbase"><code>KeyValue.KVComparator</code></a> for <code>hbase:meta</code> catalog table + <a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase"><code>KeyValue</code></a>s.</div> +</li> +</ul> +<a name="KEY_LENGTH_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KEY_LENGTH_SIZE</h4> +<pre>public static final int <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.113">KEY_LENGTH_SIZE</a></pre> +<div class="block">Size of the key length field in bytes</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.KeyValue.KEY_LENGTH_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TYPE_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TYPE_SIZE</h4> +<pre>public static final int <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.116">TYPE_SIZE</a></pre> +<div class="block">Size of the key type field in bytes</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.KeyValue.TYPE_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="ROW_LENGTH_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ROW_LENGTH_SIZE</h4> +<pre>public static final int <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.119">ROW_LENGTH_SIZE</a></pre> +<div class="block">Size of the row length field in bytes</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.KeyValue.ROW_LENGTH_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="FAMILY_LENGTH_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FAMILY_LENGTH_SIZE</h4> +<pre>public static final int <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.122">FAMILY_LENGTH_SIZE</a></pre> +<div class="block">Size of the family length field in bytes</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.KeyValue.FAMILY_LENGTH_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TIMESTAMP_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TIMESTAMP_SIZE</h4> +<pre>public static final int <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.125">TIMESTAMP_SIZE</a></pre> +<div class="block">Size of the timestamp field in bytes</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.KeyValue.TIMESTAMP_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TIMESTAMP_TYPE_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TIMESTAMP_TYPE_SIZE</h4> +<pre>public static final int <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.128">TIMESTAMP_TYPE_SIZE</a></pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.KeyValue.TIMESTAMP_TYPE_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="KEY_INFRASTRUCTURE_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KEY_INFRASTRUCTURE_SIZE</h4> +<pre>public static final int <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.131">KEY_INFRASTRUCTURE_SIZE</a></pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.KeyValue.KEY_INFRASTRUCTURE_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="ROW_OFFSET"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ROW_OFFSET</h4> +<pre>public static final int <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.136">ROW_OFFSET</a></pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.KeyValue.ROW_OFFSET">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="ROW_KEY_OFFSET"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ROW_KEY_OFFSET</h4> +<pre>public static final int <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.140">ROW_KEY_OFFSET</a></pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.KeyValue.ROW_KEY_OFFSET">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="KEYVALUE_INFRASTRUCTURE_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KEYVALUE_INFRASTRUCTURE_SIZE</h4> +<pre>public static final int <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.143">KEYVALUE_INFRASTRUCTURE_SIZE</a></pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.KeyValue.KEYVALUE_INFRASTRUCTURE_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TAGS_LENGTH_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TAGS_LENGTH_SIZE</h4> +<pre>public static final int <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.146">TAGS_LENGTH_SIZE</a></pre> +<div class="block">Size of the tags length field in bytes</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.KeyValue.TAGS_LENGTH_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="KEYVALUE_WITH_TAGS_INFRASTRUCTURE_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KEYVALUE_WITH_TAGS_INFRASTRUCTURE_SIZE</h4> +<pre>public static final int <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.148">KEYVALUE_WITH_TAGS_INFRASTRUCTURE_SIZE</a></pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.KeyValue.KEYVALUE_WITH_TAGS_INFRASTRUCTURE_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="LOWESTKEY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LOWESTKEY</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a> <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.274">LOWESTKEY</a></pre> +<div class="block">Lowest possible key. + Makes a Key with highest possible Timestamp, empty row and column. No + key can be equal or lower than this one in memstore or in store file.</div> +</li> +</ul> +<a name="bytes"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>bytes</h4> +<pre>protected byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.279">bytes</a></pre> +</li> +</ul> +<a name="offset"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>offset</h4> +<pre>protected int <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.280">offset</a></pre> +</li> +</ul> +<a name="length"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>length</h4> +<pre>protected int <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.281">length</a></pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="KeyValue--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.305">KeyValue</a>()</pre> +<div class="block">Writable Constructor -- DO NOT USE</div> +</li> +</ul> +<a name="KeyValue-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.312">KeyValue</a>(byte[] bytes)</pre> +<div class="block">Creates a KeyValue from the start of the specified byte array. + Presumes <code>bytes</code> content is formatted as a KeyValue blob.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>bytes</code> - byte array</dd> +</dl> +</li> +</ul> +<a name="KeyValue-byte:A-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.323">KeyValue</a>(byte[] bytes, + int offset)</pre> +<div class="block">Creates a KeyValue from the specified byte array and offset. + Presumes <code>bytes</code> content starting at <code>offset</code> is + formatted as a KeyValue blob.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>bytes</code> - byte array</dd> +<dd><code>offset</code> - offset to start of KeyValue</dd> +</dl> +</li> +</ul> +<a name="KeyValue-byte:A-int-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.334">KeyValue</a>(byte[] bytes, + int offset, + int length)</pre> +<div class="block">Creates a KeyValue from the specified byte array, starting at offset, and + for length <code>length</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>bytes</code> - byte array</dd> +<dd><code>offset</code> - offset to start of the KeyValue</dd> +<dd><code>length</code> - length of the KeyValue</dd> +</dl> +</li> +</ul> +<a name="KeyValue-byte:A-int-int-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.349">KeyValue</a>(byte[] bytes, + int offset, + int length, + long ts)</pre> +<div class="block">Creates a KeyValue from the specified byte array, starting at offset, and + for length <code>length</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>bytes</code> - byte array</dd> +<dd><code>offset</code> - offset to start of the KeyValue</dd> +<dd><code>length</code> - length of the KeyValue</dd> +<dd><code>ts</code> - </dd> +</dl> +</li> +</ul> +<a name="KeyValue-byte:A-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.361">KeyValue</a>(byte[] row, + long timestamp)</pre> +<div class="block">Constructs KeyValue structure filled with null value. + Sets type to <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html#Maximum"><code>KeyValue.Type.Maximum</code></a></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>row</code> - - row key (arbitrary byte array)</dd> +<dd><code>timestamp</code> - </dd> +</dl> +</li> +</ul> +<a name="KeyValue-byte:A-long-org.apache.hadoop.hbase.KeyValue.Type-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.370">KeyValue</a>(byte[] row, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type)</pre> +<div class="block">Constructs KeyValue structure filled with null value.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>row</code> - - row key (arbitrary byte array)</dd> +<dd><code>timestamp</code> - </dd> +</dl> +</li> +</ul> +<a name="KeyValue-byte:A-byte:A-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.381">KeyValue</a>(byte[] row, + byte[] family, + byte[] qualifier)</pre> +<div class="block">Constructs KeyValue structure filled with null value. + Sets type to <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html#Maximum"><code>KeyValue.Type.Maximum</code></a></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>row</code> - - row key (arbitrary byte array)</dd> +<dd><code>family</code> - family name</dd> +<dd><code>qualifier</code> - column qualifier</dd> +</dl> +</li> +</ul> +<a name="KeyValue-byte:A-byte:A-byte:A-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.393">KeyValue</a>(byte[] row, + byte[] family, + byte[] qualifier, + byte[] value)</pre> +<div class="block">Constructs KeyValue structure as a put filled with specified values and + LATEST_TIMESTAMP.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>row</code> - - row key (arbitrary byte array)</dd> +<dd><code>family</code> - family name</dd> +<dd><code>qualifier</code> - column qualifier</dd> +</dl> +</li> +</ul> +<a name="KeyValue-byte:A-byte:A-byte:A-long-org.apache.hadoop.hbase.KeyValue.Type-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.407">KeyValue</a>(byte[] row, + byte[] family, + byte[] qualifier, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a> type)</pre> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>row</code> - row key</dd> +<dd><code>family</code> - family name</dd> +<dd><code>qualifier</code> - column qualifier</dd> +<dd><code>timestamp</code> - version timestamp</dd> +<dd><code>type</code> - key type</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code></dd> +</dl> +</li> +</ul> +<a name="KeyValue-byte:A-byte:A-byte:A-long-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.421">KeyValue</a>(byte[] row, + byte[] family, + byte[] qualifier, + long timestamp, + byte[] value)</pre> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>row</code> - row key</dd> +<dd><code>family</code> - family name</dd> +<dd><code>qualifier</code> - column qualifier</dd> +<dd><code>timestamp</code> - version timestamp</dd> +<dd><code>value</code> - column value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code></dd> +</dl> +</li> +</ul> +<a name="KeyValue-byte:A-byte:A-byte:A-long-byte:A-org.apache.hadoop.hbase.Tag:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.436">KeyValue</a>(byte[] row, + byte[] family, + byte[] qualifier, + long timestamp, + byte[] value, + <a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>[] tags)</pre> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>row</code> - row key</dd> +<dd><code>family</code> - family name</dd> +<dd><code>qualifier</code> - column qualifier</dd> +<dd><code>timestamp</code> - version timestamp</dd> +<dd><code>value</code> - column value</dd> +<dd><code>tags</code> - tags</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code></dd> +</dl> +</li> +</ul> +<a name="KeyValue-byte:A-byte:A-byte:A-long-byte:A-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.452">KeyValue</a>(byte[] row, + byte[] family, + byte[] qualifier, + long timestamp, + byte[] value, + <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> tags)</pre> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>row</code> - row key</dd> +<dd><code>family</code> - family name</dd> +<dd><code>qualifier</code> - column qualifier</dd> +<dd><code>timestamp</code> - version timestamp</dd> +<dd><code>value</code> - column value</dd> +<dd><code>tags</code> - tags non-empty list of tags or null</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code></dd> +</dl> +</li> +</ul> +<a name="KeyValue-byte:A-byte:A-byte:A-long-org.apache.hadoop.hbase.KeyValue.Type-byte:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public <a href="../../../../src-html/org/apache/hadoop/hbase/KeyValue.html#line.472">KeyValue</a>(byte[] row, + byte[] family, + byte[] qualifier, + long timestamp, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html"
<TRUNCATED>
