http://git-wip-us.apache.org/repos/asf/hbase-site/blob/8418e382/1.1/apidocs/org/apache/hadoop/hbase/KeyValue.html ---------------------------------------------------------------------- diff --git a/1.1/apidocs/org/apache/hadoop/hbase/KeyValue.html b/1.1/apidocs/org/apache/hadoop/hbase/KeyValue.html new file mode 100644 index 0000000..2614e78 --- /dev/null +++ b/1.1/apidocs/org/apache/hadoop/hbase/KeyValue.html @@ -0,0 +1,2986 @@ +<!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 (version 1.7.0_80) on Tue Nov 08 06:02:57 PST 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>KeyValue (Apache HBase 1.1.7 API)</title> +<meta name="date" content="2016-11-08"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="KeyValue (Apache HBase 1.1.7 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/KeyValue.KeyOnlyKeyValue.html" title="class in org.apache.hadoop.hbase"><span class="strong">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="http://docs.oracle.com/javase/7/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="http://docs.oracle.com/javase/7/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/io/HeapSize.html" title="interface in org.apache.hadoop.hbase.io">HeapSize</a>, <a href="../../../../org/apache/hadoop/hbase/SettableSequenceId.html" title="interface in org.apache.hadoop.hbase">SettableSequenceId</a>, <a href="../../../../org/apache/hadoop/hbase/SettableTimestamp.html" title="interface in org.apache.hadoop.hbase">SettableTimestamp</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></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../org/apache/hadoop/hbase/classification/InterfaceAudience.Private.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceAudience.Private</a> +public class <span class="strong">KeyValue</span> +extends <a href="http://docs.oracle.com/javase/7/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/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>, <a href="../../../../org/apache/hadoop/hbase/io/HeapSize.html" title="interface in org.apache.hadoop.hbase.io">HeapSize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../org/apache/hadoop/hbase/SettableSequenceId.html" title="interface in org.apache.hadoop.hbase">SettableSequenceId</a>, <a href="../../../../org/apache/hadoop/hbase/SettableTimestamp.html" title="interface in org.apache.hadoop.hbase">SettableTimestamp</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#getRow()"><code>getRow()</code></a>, + <a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getFamily()"><code>getFamily()</code></a>, <a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getQualifier()"><code>getQualifier()</code></a>, <a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getTimestamp()"><code>getTimestamp()</code></a>, and <a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getValue()"><code>getValue()</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="overviewSummary" 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.KeyOnlyKeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue.KeyOnlyKeyValue</a></strong></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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.KVComparator.html" title="class in org.apache.hadoop.hbase">KeyValue.KVComparator</a></strong></code> +<div class="block">Compare KeyValues.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.MetaComparator.html" title="class in org.apache.hadoop.hbase">KeyValue.MetaComparator</a></strong></code> +<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> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.RawBytesComparator.html" title="class in org.apache.hadoop.hbase">KeyValue.RawBytesComparator</a></strong></code> +<div class="block">This is a TEST only Comparator used in TestSeekTo and TestReseekTo.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.RowOnlyComparator.html" title="class in org.apache.hadoop.hbase">KeyValue.RowOnlyComparator</a></strong></code> +<div class="block">Comparator that compares row component only of a KeyValue.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static interface </code></td> +<td class="colLast"><code><strong><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>></strong></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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.Type.html" title="enum in org.apache.hadoop.hbase">KeyValue.Type</a></strong></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="overviewSummary" 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#bytes">bytes</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#COLUMN_FAMILY_DELIM_ARRAY">COLUMN_FAMILY_DELIM_ARRAY</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static char</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#COLUMN_FAMILY_DELIMITER">COLUMN_FAMILY_DELIMITER</a></strong></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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#COMPARATOR">COMPARATOR</a></strong></code> +<div class="block">Comparator for plain key/values; i.e.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#FAMILY_LENGTH_SIZE">FAMILY_LENGTH_SIZE</a></strong></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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KEY_INFRASTRUCTURE_SIZE">KEY_INFRASTRUCTURE_SIZE</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KEY_LENGTH_SIZE">KEY_LENGTH_SIZE</a></strong></code> +<div class="block">Size of the key length field in bytes</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KEYVALUE_INFRASTRUCTURE_SIZE">KEYVALUE_INFRASTRUCTURE_SIZE</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KEYVALUE_WITH_TAGS_INFRASTRUCTURE_SIZE">KEYVALUE_WITH_TAGS_INFRASTRUCTURE_SIZE</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#length">length</a></strong></code> </td> +</tr> +<tr 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#LOWESTKEY">LOWESTKEY</a></strong></code> +<div class="block">Lowest possible key.</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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#META_COMPARATOR">META_COMPARATOR</a></strong></code> +<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> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#offset">offset</a></strong></code> </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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#RAW_COMPARATOR">RAW_COMPARATOR</a></strong></code> +<div class="block">Needed for Bloom Filters.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#ROW_LENGTH_SIZE">ROW_LENGTH_SIZE</a></strong></code> +<div class="block">Size of the row length field in bytes</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#ROW_OFFSET">ROW_OFFSET</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#TAGS_LENGTH_SIZE">TAGS_LENGTH_SIZE</a></strong></code> +<div class="block">Size of the tags length field in bytes</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#TIMESTAMP_SIZE">TIMESTAMP_SIZE</a></strong></code> +<div class="block">Size of the timestamp field in bytes</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#TIMESTAMP_TYPE_SIZE">TIMESTAMP_TYPE_SIZE</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#TYPE_SIZE">TYPE_SIZE</a></strong></code> +<div class="block">Size of the key type field in bytes</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue()">KeyValue</a></strong>()</code> +<div class="block">Writable Constructor -- DO NOT USE</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[])">KeyValue</a></strong>(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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20byte[],%20byte[])">KeyValue</a></strong>(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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20byte[],%20byte[],%20byte[])">KeyValue</a></strong>(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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20byte[],%20byte[],%20int,%20int,%20long,%20org.apache.hadoop.hbase.KeyValue.Type,%20byte[],%20int,%20int,%20byte[])">KeyValue</a></strong>(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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20byte[],%20byte[],%20int,%20int,%20long,%20org.apache.hadoop.hbase.KeyValue.Type,%20byte[],%20int,%20int,%20java.util.List)">KeyValue</a></strong>(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="http://docs.oracle.com/javase/7/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="class 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20byte[],%20byte[],%20long,%20byte[])">KeyValue</a></strong>(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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20byte[],%20byte[],%20long,%20byte[],%20java.util.List)">KeyValue</a></strong>(byte[] row, + byte[] family, + byte[] qualifier, + long timestamp, + byte[] value, + <a href="http://docs.oracle.com/javase/7/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="class 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20byte[],%20byte[],%20long,%20byte[],%20org.apache.hadoop.hbase.Tag[])">KeyValue</a></strong>(byte[] row, + byte[] family, + byte[] qualifier, + long timestamp, + byte[] value, + <a href="../../../../org/apache/hadoop/hbase/Tag.html" title="class 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20byte[],%20byte[],%20long,%20org.apache.hadoop.hbase.KeyValue.Type)">KeyValue</a></strong>(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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20byte[],%20byte[],%20long,%20org.apache.hadoop.hbase.KeyValue.Type,%20byte[])">KeyValue</a></strong>(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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20byte[],%20byte[],%20long,%20org.apache.hadoop.hbase.KeyValue.Type,%20byte[],%20byte[])">KeyValue</a></strong>(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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20byte[],%20byte[],%20long,%20org.apache.hadoop.hbase.KeyValue.Type,%20byte[],%20java.util.List)">KeyValue</a></strong>(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="http://docs.oracle.com/javase/7/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="class 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20int)">KeyValue</a></strong>(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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20int,%20byte[],%20int,%20int,%20byte[],%20int,%20int,%20byte[],%20int,%20int,%20long,%20org.apache.hadoop.hbase.KeyValue.Type,%20byte[],%20int,%20int,%20org.apache.hadoop.hbase.Tag[])">KeyValue</a></strong>(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="class 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20int,%20int)">KeyValue</a></strong>(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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20int,%20int,%20byte[],%20int,%20int,%20byte[],%20int,%20int,%20long,%20org.apache.hadoop.hbase.KeyValue.Type,%20byte[],%20int,%20int)">KeyValue</a></strong>(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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20int,%20int,%20byte[],%20int,%20int,%20byte[],%20int,%20int,%20long,%20org.apache.hadoop.hbase.KeyValue.Type,%20byte[],%20int,%20int,%20byte[],%20int,%20int)">KeyValue</a></strong>(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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20int,%20int,%20byte[],%20int,%20int,%20byte[],%20int,%20int,%20long,%20org.apache.hadoop.hbase.KeyValue.Type,%20byte[],%20int,%20int,%20java.util.List)">KeyValue</a></strong>(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="http://docs.oracle.com/javase/7/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="class 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20int,%20int,%20byte[],%20int,%20int,%20java.nio.ByteBuffer,%20long,%20org.apache.hadoop.hbase.KeyValue.Type,%20java.nio.ByteBuffer,%20java.util.List)">KeyValue</a></strong>(byte[] row, + int roffset, + int rlength, + byte[] family, + int foffset, + int flength, + <a href="http://docs.oracle.com/javase/7/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="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> value, + <a href="http://docs.oracle.com/javase/7/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="class in org.apache.hadoop.hbase">Tag</a>> tags)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20int,%20int,%20long)">KeyValue</a></strong>(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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20long)">KeyValue</a></strong>(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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(byte[],%20long,%20org.apache.hadoop.hbase.KeyValue.Type)">KeyValue</a></strong>(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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(org.apache.hadoop.hbase.Cell)">KeyValue</a></strong>(<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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(int,%20int,%20int,%20long,%20org.apache.hadoop.hbase.KeyValue.Type,%20int)">KeyValue</a></strong>(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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#KeyValue(int,%20int,%20int,%20long,%20org.apache.hadoop.hbase.KeyValue.Type,%20int,%20int)">KeyValue</a></strong>(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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#clone()">clone</a></strong>()</code> +<div class="block">Clones a KeyValue.</div> +</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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#cloneAndAddTags(org.apache.hadoop.hbase.Cell,%20java.util.List)">cloneAndAddTags</a></strong>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c, + <a href="http://docs.oracle.com/javase/7/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="class in org.apache.hadoop.hbase">Tag</a>> newTags)</code> +<div class="block">Create a new KeyValue by copying existing cell and adding new tags</div> +</td> +</tr> +<tr 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#create(java.io.DataInput)">create</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/DataInput.html?is-external=true" title="class or interface in java.io">DataInput</a> in)</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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#create(int,%20java.io.DataInput)">create</a></strong>(int length, + <a href="http://docs.oracle.com/javase/7/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 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#createFirstOnRow(byte[])">createFirstOnRow</a></strong>(byte[] row)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Since 0.99.2. Use <a href="../../../../org/apache/hadoop/hbase/KeyValueUtil.html#createFirstOnRow(byte[])"><code>KeyValueUtil.createFirstOnRow(byte [])</code></a> instead</i></div> +</div> +</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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#createFirstOnRow(byte[],%20byte[],%20byte[])">createFirstOnRow</a></strong>(byte[] row, + byte[] family, + byte[] qualifier)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Since 0.99.2. Use <a href="../../../../org/apache/hadoop/hbase/KeyValueUtil.html#createFirstOnRow(byte[],%20byte[],%20byte[])"><code>KeyValueUtil.createFirstOnRow(byte[], byte[], byte[])</code></a> + instead</i></div> +</div> +</td> +</tr> +<tr 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#createFirstOnRow(byte[],%20int,%20int,%20byte[],%20int,%20int,%20byte[],%20int,%20int)">createFirstOnRow</a></strong>(byte[] row, + int roffset, + int rlength, + byte[] family, + int foffset, + int flength, + byte[] qualifier, + int qoffset, + int qlength)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Since 0.99.2. Use <a href="../../../../org/apache/hadoop/hbase/KeyValueUtil.html#createFirstOnRow(byte[],%20int,%20int,%20byte[],%20int,%20int,%20byte[],%20int,%20int)"><code>KeyValueUtil.createFirstOnRow(byte[], int, int, + byte[], int, int, byte[], int, int)</code></a> instead</i></div> +</div> +</td> +</tr> +<tr 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#createKeyOnly(boolean)">createKeyOnly</a></strong>(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 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#createKeyValueFromKey(byte[])">createKeyValueFromKey</a></strong>(byte[] b)</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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#createKeyValueFromKey(byte[],%20int,%20int)">createKeyValueFromKey</a></strong>(byte[] b, + int o, + int l)</code> </td> +</tr> +<tr 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#createKeyValueFromKey(java.nio.ByteBuffer)">createKeyValueFromKey</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> bb)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://docs.oracle.com/javase/7/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 class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getBuffer()">getBuffer</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Since 0.98.0. Use Cell Interface instead. Do not presume single backing buffer.</i></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getDelimiter(byte[],%20int,%20int,%20int)">getDelimiter</a></strong>(byte[] b, + int offset, + int length, + int delimiter)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getDelimiterInReverse(byte[],%20int,%20int,%20int)">getDelimiterInReverse</a></strong>(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 class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getFamily()">getFamily</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getFamilyArray()">getFamilyArray</a></strong>()</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 class="rowColor"> +<td class="colFirst"><code>byte</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getFamilyLength()">getFamilyLength</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getFamilyLength(int)">getFamilyLength</a></strong>(int foffset)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getFamilyOffset()">getFamilyOffset</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getKey()">getKey</a></strong>()</code> +<div class="block">Do not use unless you have to.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getKeyDataStructureSize(int,%20int,%20int)">getKeyDataStructureSize</a></strong>(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 class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getKeyLength()">getKeyLength</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getKeyOffset()">getKeyOffset</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getKeyString()">getKeyString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getKeyValueDataStructureSize(int,%20int,%20int)">getKeyValueDataStructureSize</a></strong>(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 class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getKeyValueDataStructureSize(int,%20int,%20int,%20int)">getKeyValueDataStructureSize</a></strong>(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 class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getKeyValueDataStructureSize(int,%20int,%20int,%20int,%20int)">getKeyValueDataStructureSize</a></strong>(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 class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getLength()">getLength</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getMvccVersion()">getMvccVersion</a></strong>()</code> +<div class="block">Here be dragons</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getOffset()">getOffset</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getQualifier()">getQualifier</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getQualifierArray()">getQualifierArray</a></strong>()</code> +<div class="block">Contiguous raw bytes that may start at any index in the containing array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getQualifierLength()">getQualifierLength</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getQualifierOffset()">getQualifierOffset</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getRow()">getRow</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getRowArray()">getRowArray</a></strong>()</code> +<div class="block">Contiguous raw bytes that may start at any index in the containing array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>short</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getRowLength()">getRowLength</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getRowOffset()">getRowOffset</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getSequenceId()">getSequenceId</a></strong>()</code> +<div class="block">used to achieve atomic operations in the memstore.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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="class in org.apache.hadoop.hbase">Tag</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getTags()">getTags</a></strong>()</code> +<div class="block">Returns any tags embedded in the KeyValue.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getTagsArray()">getTagsArray</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getTagsLength()">getTagsLength</a></strong>()</code> +<div class="block">This returns the total length of the tag bytes</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getTagsOffset()">getTagsOffset</a></strong>()</code> +<div class="block">This returns the offset where the tag actually starts.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getTimestamp()">getTimestamp</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getTimestampOffset()">getTimestampOffset</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getType()">getType</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getTypeByte()">getTypeByte</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getValue()">getValue</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getValueArray()">getValueArray</a></strong>()</code> +<div class="block">Contiguous raw bytes that may start at any index in the containing array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getValueLength()">getValueLength</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#getValueOffset()">getValueOffset</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#hashCode()">hashCode</a></strong>()</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 class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#heapSize()">heapSize</a></strong>()</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 class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#heapSizeWithoutTags()">heapSizeWithoutTags</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#humanReadableTimestamp(long)">humanReadableTimestamp</a></strong>(long timestamp)</code> </td> +</tr> +<tr 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#iscreate(java.io.InputStream)">iscreate</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> in)</code> +<div class="block">Create a KeyValue reading from the raw InputStream.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#isDelete()">isDelete</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#isDelete(byte)">isDelete</a></strong>(byte t)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#isLatestTimestamp()">isLatestTimestamp</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#keyToString(byte[])">keyToString</a></strong>(byte[] k)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#keyToString(byte[],%20int,%20int)">keyToString</a></strong>(byte[] b, + int o, + int l)</code> +<div class="block">Use for logging.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#makeColumn(byte[],%20byte[])">makeColumn</a></strong>(byte[] family, + byte[] qualifier)</code> +<div class="block">Makes a column in family:qualifier form from separate byte arrays.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#oswrite(org.apache.hadoop.hbase.KeyValue,%20java.io.OutputStream)">oswrite</a></strong>(<a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a> kv, + <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</a> out)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>use <a href="../../../../org/apache/hadoop/hbase/KeyValue.html#oswrite(org.apache.hadoop.hbase.KeyValue,%20java.io.OutputStream,%20boolean)"><code>oswrite(KeyValue, OutputStream, boolean)</code></a> instead</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#oswrite(org.apache.hadoop.hbase.KeyValue,%20java.io.OutputStream,%20boolean)">oswrite</a></strong>(<a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a> kv, + <a href="http://docs.oracle.com/javase/7/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 out a KeyValue in the manner in which we used to when KeyValue was a Writable but do + not require a <a href="http://docs.oracle.com/javase/7/docs/api/java/io/DataOutput.html?is-external=true" title="class or interface in java.io"><code>DataOutput</code></a>, just take plain <a href="http://docs.oracle.com/javase/7/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io"><code>OutputStream</code></a> + Named <code>oswrite</code> so does not clash with <a href="../../../../org/apache/hadoop/hbase/KeyValue.html#write(org.apache.hadoop.hbase.KeyValue,%20java.io.DataOutput)"><code>write(KeyValue, DataOutput)</code></a></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static byte[][]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#parseColumn(byte[])">parseColumn</a></strong>(byte[] c)</code> +<div class="block">Splits a column in <code>family:qualifier</code> form into separate byte arrays.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#setSequenceId(long)">setSequenceId</a></strong>(long seqId)</code> +<div class="block">Sets with the given seqId.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#setTimestamp(byte[],%20int)">setTimestamp</a></strong>(byte[] ts, + int tsOffset)</code> +<div class="block">Sets with the given timestamp.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#setTimestamp(long)">setTimestamp</a></strong>(long ts)</code> +<div class="block">Sets with the given timestamp.</div> +</td> +</tr> +<tr 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><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#shallowCopy()">shallowCopy</a></strong>()</code> +<div class="block">Creates a shallow copy of this KeyValue, reusing the data byte buffer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#toStringMap()">toStringMap</a></strong>()</code> +<div class="block">Produces a string map for this key/value pair.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#updateLatestStamp(byte[])">updateLatestStamp</a></strong>(byte[] now)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#write(org.apache.hadoop.hbase.KeyValue,%20java.io.DataOutput)">write</a></strong>(<a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a> kv, + <a href="http://docs.oracle.com/javase/7/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 class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.html#writeByteArray(byte[],%20int,%20byte[],%20int,%20int,%20byte[],%20int,%20int,%20byte[],%20int,%20int,%20long,%20org.apache.hadoop.hbase.KeyValue.Type,%20byte[],%20int,%20int,%20org.apache.hadoop.hbase.Tag[])">writeByteArray</a></strong>(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="class 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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is- external=true#wait(long,%20int)" title="class or interface in java.lang">wait</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="COLUMN_FAMILY_DELIMITER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COLUMN_FAMILY_DELIMITER</h4> +<pre>public static final char COLUMN_FAMILY_DELIMITER</pre> +<div class="block">Colon character in UTF-8</div> +<dl><dt><span class="strong">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[] COLUMN_FAMILY_DELIM_ARRAY</pre> +</li> +</ul> +<a name="COMPARATOR"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>COMPARATOR</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/KeyValue.KVComparator.html" title="class in org.apache.hadoop.hbase">KeyValue.KVComparator</a> COMPARATOR</pre> +<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>public static final <a href="../../../../org/apache/hadoop/hbase/KeyValue.KVComparator.html" title="class in org.apache.hadoop.hbase">KeyValue.KVComparator</a> META_COMPARATOR</pre> +<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="RAW_COMPARATOR"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RAW_COMPARATOR</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/KeyValue.KVComparator.html" title="class in org.apache.hadoop.hbase">KeyValue.KVComparator</a> RAW_COMPARATOR</pre> +<div class="block">Needed for Bloom Filters.</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 KEY_LENGTH_SIZE</pre> +<div class="block">Size of the key length field in bytes</div> +<dl><dt><span class="strong">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 TYPE_SIZE</pre> +<div class="block">Size of the key type field in bytes</div> +<dl><dt><span class="strong">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 ROW_LENGTH_SIZE</pre> +<div class="block">Size of the row length field in bytes</div> +<dl><dt><span class="strong">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 FAMILY_LENGTH_SIZE</pre> +<div class="block">Size of the family length field in bytes</div> +<dl><dt><span class="strong">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 TIMESTAMP_SIZE</pre> +<div class="block">Size of the timestamp field in bytes</div> +<dl><dt><span class="strong">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 TIMESTAMP_TYPE_SIZE</pre> +<dl><dt><span class="strong">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 KEY_INFRASTRUCTURE_SIZE</pre> +<dl><dt><span class="strong">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 ROW_OFFSET</pre> +<dl><dt><span class="strong">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="KEYVALUE_INFRASTRUCTURE_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KEYVALUE_INFRASTRUCTURE_SIZE</h4> +<pre>public static final int KEYVALUE_INFRASTRUCTURE_SIZE</pre> +<dl><dt><span class="strong">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 TAGS_LENGTH_SIZE</pre> +<div class="block">Size of the tags length field in bytes</div> +<dl><dt><span class="strong">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 KEYVALUE_WITH_TAGS_INFRASTRUCTURE_SIZE</pre> +<dl><dt><span class="strong">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> LOWESTKEY</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[] bytes</pre> +</li> +</ul> +<a name="offset"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>offset</h4> +<pre>protected int offset</pre> +</li> +</ul> +<a name="length"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>length</h4> +<pre>protected int length</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 KeyValue()</pre> +<div class="block">Writable Constructor -- DO NOT USE</div> +</li> +</ul> +<a name="KeyValue(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public KeyValue(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="strong">Parameters:</span></dt><dd><code>bytes</code> - byte array</dd></dl> +</li> +</ul> +<a name="KeyValue(byte[], int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public KeyValue(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="strong">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[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public KeyValue(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="strong">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[], int, int, long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public KeyValue(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="strong">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[], long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public KeyValue(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="strong">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[], long, org.apache.hadoop.hbase.KeyValue.Type)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public KeyValue(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="strong">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[], byte[], byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public KeyValue(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="strong">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[], byte[], byte[], byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public KeyValue(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="strong">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[], byte[], byte[], long, org.apache.hadoop.hbase.KeyValue.Type)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public KeyValue(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="strong">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="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/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[], byte[], byte[], long, byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public KeyValue(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="strong">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="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/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[], byte[], byte[], long, byte[], org.apache.hadoop.hbase.Tag[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public KeyValue(byte[] row, + byte[] family, + byte[] qualifier, + long timestamp, + byte[] value, + <a href="../../../../org/apache/hadoop/hbase/Tag.html" title="class in org.apache.hadoop.hbase">Tag</a>[] tags)</pre> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +<dl><dt><span class="strong">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="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/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[], byte[], byte[], long, byte[], java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public KeyValue(byte[] row, + byte[] family, + byte[] qualifier, + long timestamp, + byte[] value, + <a href="http://docs.oracle.com/javase/7/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="class in org.apache.hadoop.hbase">Tag</a>> tags)</pre> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +<dl><dt><span class="strong">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="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/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[], byte[], byte[], long, org.apache.hadoop.hbase.KeyValue.Type, byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public KeyValue(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)</pre> +<div class="block">Constructs KeyValue structure filled with specified values.</div> +<dl><dt><span class="strong">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><dd><code>value</code> - column value</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/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[], byte[], byte[], long, org.apache.hadoop.hbase.KeyValue.Type, byte[], java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>KeyValue</h4> +<pre>public KeyValue(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="http://docs.oracle.com/javase/7/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="class in org.apache.hadoop.hbase">Tag</a>> tags)</pre> +<div class="block">Constructs KeyValue structure filled with specified values. + <p> + Column is split into two fields, family and qualifier.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>row</code> - row key</dd><
<TRUNCATED>
