http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6960a0bd/1.1/apidocs/org/apache/hadoop/hbase/JMXListener.html ---------------------------------------------------------------------- diff --git a/1.1/apidocs/org/apache/hadoop/hbase/JMXListener.html b/1.1/apidocs/org/apache/hadoop/hbase/JMXListener.html new file mode 100644 index 0000000..eb773b6 --- /dev/null +++ b/1.1/apidocs/org/apache/hadoop/hbase/JMXListener.html @@ -0,0 +1,459 @@ +<!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 Mon Nov 07 22:02:44 PST 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>JMXListener (Apache HBase 1.1.8-SNAPSHOT API)</title> +<meta name="date" content="2016-11-07"> +<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="JMXListener (Apache HBase 1.1.8-SNAPSHOT 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/JMXListener.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/InvalidFamilyOperationException.html" title="class in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum 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/JMXListener.html" target="_top">Frames</a></li> +<li><a href="JMXListener.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>Nested | </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 JMXListener" class="title">Class JMXListener</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.JMXListener</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">JMXListener</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/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></pre> +<div class="block">Pluggable JMX Agent for HBase(to fix the 2 random TCP ports issue + of the out-of-the-box JMX Agent): + 1)connector port can share with the registry port if SSL is OFF + 2)support password authentication + 3)support subset of SSL (with default configuration)</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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.hadoop.hbase.Coprocessor"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></h3> +<code><a href="../../../../org/apache/hadoop/hbase/Coprocessor.State.html" title="enum in org.apache.hadoop.hbase">Coprocessor.State</a></code></li> +</ul> +</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>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/JMXListener.html#defMasterRMIRegistryPort">defMasterRMIRegistryPort</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/JMXListener.html#defRegionserverRMIRegistryPort">defRegionserverRMIRegistryPort</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static org.apache.commons.logging.Log</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/JMXListener.html#LOG">LOG</a></strong></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/JMXListener.html#RMI_CONNECTOR_PORT_CONF_KEY">RMI_CONNECTOR_PORT_CONF_KEY</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/JMXListener.html#RMI_REGISTRY_PORT_CONF_KEY">RMI_REGISTRY_PORT_CONF_KEY</a></strong></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.hadoop.hbase.Coprocessor"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></h3> +<code><a href="../../../../org/apache/hadoop/hbase/Coprocessor.html#PRIORITY_HIGHEST">PRIORITY_HIGHEST</a>, <a href="../../../../org/apache/hadoop/hbase/Coprocessor.html#PRIORITY_LOWEST">PRIORITY_LOWEST</a>, <a href="../../../../org/apache/hadoop/hbase/Coprocessor.html#PRIORITY_SYSTEM">PRIORITY_SYSTEM</a>, <a href="../../../../org/apache/hadoop/hbase/Coprocessor.html#PRIORITY_USER">PRIORITY_USER</a>, <a href="../../../../org/apache/hadoop/hbase/Coprocessor.html#VERSION">VERSION</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="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/JMXListener.html#JMXListener()">JMXListener</a></strong>()</code> </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>static <a href="http://docs.oracle.com/javase/7/docs/api/javax/management/remote/JMXServiceURL.html?is-external=true"; title="class or interface in javax.management.remote">JMXServiceURL</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/JMXListener.html#buildJMXServiceURL(int,%20int)">buildJMXServiceURL</a></strong>(int rmiRegistryPort, + int rmiConnectorPort)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/JMXListener.html#start(org.apache.hadoop.hbase.CoprocessorEnvironment)">start</a></strong>(<a href="../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a> env)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/JMXListener.html#startConnectorServer(int,%20int)">startConnectorServer</a></strong>(int rmiRegistryPort, + int rmiConnectorPort)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/JMXListener.html#stop(org.apache.hadoop.hbase.CoprocessorEnvironment)">stop</a></strong>(<a href="../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a> env)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/JMXListener.html#stopConnectorServer()">stopConnectorServer</a></strong>()</code> </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#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <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#hashCode()" title="class or interface in java.lang">hashCode</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#toString()" title="class or interface in java.lang">toString</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="LOG"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LOG</h4> +<pre>public static final org.apache.commons.logging.Log LOG</pre> +</li> +</ul> +<a name="RMI_REGISTRY_PORT_CONF_KEY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RMI_REGISTRY_PORT_CONF_KEY</h4> +<pre>public static final <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> RMI_REGISTRY_PORT_CONF_KEY</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.JMXListener.RMI_REGISTRY_PORT_CONF_KEY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="RMI_CONNECTOR_PORT_CONF_KEY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RMI_CONNECTOR_PORT_CONF_KEY</h4> +<pre>public static final <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> RMI_CONNECTOR_PORT_CONF_KEY</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.JMXListener.RMI_CONNECTOR_PORT_CONF_KEY">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="defMasterRMIRegistryPort"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>defMasterRMIRegistryPort</h4> +<pre>public static final int defMasterRMIRegistryPort</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.JMXListener.defMasterRMIRegistryPort">Constant Field Values</a></dd></dl> +</li> +</ul> +<a name="defRegionserverRMIRegistryPort"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>defRegionserverRMIRegistryPort</h4> +<pre>public static final int defRegionserverRMIRegistryPort</pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.JMXListener.defRegionserverRMIRegistryPort">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="JMXListener()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>JMXListener</h4> +<pre>public JMXListener()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="buildJMXServiceURL(int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>buildJMXServiceURL</h4> +<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/javax/management/remote/JMXServiceURL.html?is-external=true"; title="class or interface in javax.management.remote">JMXServiceURL</a> buildJMXServiceURL(int rmiRegistryPort, + int rmiConnectorPort) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="startConnectorServer(int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startConnectorServer</h4> +<pre>public void startConnectorServer(int rmiRegistryPort, + int rmiConnectorPort) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="stopConnectorServer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>stopConnectorServer</h4> +<pre>public void stopConnectorServer() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="start(org.apache.hadoop.hbase.CoprocessorEnvironment)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>start</h4> +<pre>public void start(<a href="../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a> env) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/hadoop/hbase/Coprocessor.html#start(org.apache.hadoop.hbase.CoprocessorEnvironment)">start</a></code> in interface <code><a href="../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +<a name="stop(org.apache.hadoop.hbase.CoprocessorEnvironment)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>stop</h4> +<pre>public void stop(<a href="../../../../org/apache/hadoop/hbase/CoprocessorEnvironment.html" title="interface in org.apache.hadoop.hbase">CoprocessorEnvironment</a> env) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/hadoop/hbase/Coprocessor.html#stop(org.apache.hadoop.hbase.CoprocessorEnvironment)">stop</a></code> in interface <code><a href="../../../../org/apache/hadoop/hbase/Coprocessor.html" title="interface in org.apache.hadoop.hbase">Coprocessor</a></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_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/JMXListener.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/InvalidFamilyOperationException.html" title="class in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum 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/JMXListener.html" target="_top">Frames</a></li> +<li><a href="JMXListener.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </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_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2007-2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6960a0bd/1.1/apidocs/org/apache/hadoop/hbase/KeepDeletedCells.html ---------------------------------------------------------------------- diff --git a/1.1/apidocs/org/apache/hadoop/hbase/KeepDeletedCells.html b/1.1/apidocs/org/apache/hadoop/hbase/KeepDeletedCells.html new file mode 100644 index 0000000..30ef760 --- /dev/null +++ b/1.1/apidocs/org/apache/hadoop/hbase/KeepDeletedCells.html @@ -0,0 +1,350 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>KeepDeletedCells (Apache HBase 1.1.8-SNAPSHOT API)</title> +<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="KeepDeletedCells (Apache HBase 1.1.8-SNAPSHOT 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/KeepDeletedCells.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/InvalidFamilyOperationException.html" title="class in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/LocalHBaseCluster.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/KeepDeletedCells.html" target="_top">Frames</a></li> +<li><a href="KeepDeletedCells.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>Nested | </li> +<li><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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="Enum KeepDeletedCells" class="title">Enum KeepDeletedCells</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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.hadoop.hbase.KeepDeletedCells</li> +</ul> +</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/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><<a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a>></dd> +</dl> +<hr> +<br> +<pre>@InterfaceAudience.Public +@InterfaceStability.Evolving +public enum <span class="strong">KeepDeletedCells</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a><<a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a>></pre> +<div class="block">Ways to keep cells marked for delete around.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html#FALSE">FALSE</a></strong></code> +<div class="block">Deleted Cells are not retained.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html#TRUE">TRUE</a></strong></code> +<div class="block">Deleted Cells are retained until they are removed by other means + such TTL or VERSIONS.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html#TTL">TTL</a></strong></code> +<div class="block">Deleted Cells are retained until the delete marker expires due to TTL.</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>static <a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html#valueOf(java.lang.String)">valueOf</a></strong>(<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> name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/ api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,%20java.lang.String)" title="class or interface in java.lang">valueOf</a></code></li> +</ul> +<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#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"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="FALSE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FALSE</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a> FALSE</pre> +<div class="block">Deleted Cells are not retained.</div> +</li> +</ul> +<a name="TRUE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TRUE</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a> TRUE</pre> +<div class="block">Deleted Cells are retained until they are removed by other means + such TTL or VERSIONS. + If no TTL is specified or no new versions of delete cells are + written, they are retained forever.</div> +</li> +</ul> +<a name="TTL"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TTL</h4> +<pre>public static final <a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a> TTL</pre> +<div class="block">Deleted Cells are retained until the delete marker expires due to TTL. + This is useful when TTL is combined with MIN_VERSIONS and one + wants to keep a minimum number of versions around but at the same + time remove deleted cells after the TTL.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (KeepDeletedCells c : KeepDeletedCells.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../org/apache/hadoop/hbase/KeepDeletedCells.html" title="enum in org.apache.hadoop.hbase">KeepDeletedCells</a> valueOf(<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> name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</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> - if this enum type has no constant with the specified name</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true"; title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_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/KeepDeletedCells.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/InvalidFamilyOperationException.html" title="class in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/LocalHBaseCluster.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/KeepDeletedCells.html" target="_top">Frames</a></li> +<li><a href="KeepDeletedCells.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2007–2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6960a0bd/1.1/apidocs/org/apache/hadoop/hbase/KeyValue.KVComparator.html ---------------------------------------------------------------------- diff --git a/1.1/apidocs/org/apache/hadoop/hbase/KeyValue.KVComparator.html b/1.1/apidocs/org/apache/hadoop/hbase/KeyValue.KVComparator.html new file mode 100644 index 0000000..1540983 --- /dev/null +++ b/1.1/apidocs/org/apache/hadoop/hbase/KeyValue.KVComparator.html @@ -0,0 +1,747 @@ +<!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 Mon Nov 07 22:02:44 PST 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>KeyValue.KVComparator (Apache HBase 1.1.8-SNAPSHOT API)</title> +<meta name="date" content="2016-11-07"> +<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.KVComparator (Apache HBase 1.1.8-SNAPSHOT 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.KVComparator.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/KeyValue.KeyOnlyKeyValue.html" title="class in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/KeyValue.MetaComparator.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.KVComparator.html" target="_top">Frames</a></li> +<li><a href="KeyValue.KVComparator.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>Nested | </li> +<li>Field | </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>Field | </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.KVComparator" class="title">Class KeyValue.KVComparator</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.KVComparator</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/util/Comparator.html?is-external=true"; title="class or interface in java.util">Comparator</a><<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>>, <a href="../../../../org/apache/hadoop/hbase/KeyValue.SamePrefixComparator.html" title="interface in org.apache.hadoop.hbase">KeyValue.SamePrefixComparator</a><byte[]>, org.apache.hadoop.io.RawComparator<<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/hadoop/hbase/KeyValue.MetaComparator.html" title="class in org.apache.hadoop.hbase">KeyValue.MetaComparator</a>, <a href="../../../../org/apache/hadoop/hbase/KeyValue.RawBytesComparator.html" title="class in org.apache.hadoop.hbase">KeyValue.RawBytesComparator</a></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">KeyValue.KVComparator</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 org.apache.hadoop.io.RawComparator<<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>>, <a href="../../../../org/apache/hadoop/hbase/KeyValue.SamePrefixComparator.html" title="interface in org.apache.hadoop.hbase">KeyValue.SamePrefixComparator</a><byte[]></pre> +<div class="block">Compare KeyValues. When we compare KeyValues, we only compare the Key + portion. This means two KeyValues with same Key but different Values are + considered the same as far as this Comparator is concerned.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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.KVComparator.html#KeyValue.KVComparator()">KeyValue.KVComparator</a></strong>()</code> </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>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/hadoop/hbase/KeyValue.KVComparator.html#calcIndexKey(byte[],%20byte[])">calcIndexKey</a></strong>(byte[] lastKeyOfPreviousBlock, + byte[] firstKeyInBlock)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <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.KVComparator.html#clone()">clone</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.KVComparator.html#compare(byte[],%20int,%20int,%20byte[],%20int,%20int)">compare</a></strong>(byte[] l, + int loff, + int llen, + byte[] r, + int roff, + int rlen)</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.KVComparator.html#compare(org.apache.hadoop.hbase.Cell,%20org.apache.hadoop.hbase.Cell)">compare</a></strong>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> left, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> right)</code> +<div class="block">Compares the Key of a cell -- with fields being more significant in this order: + rowkey, colfam/qual, timestamp, type, mvcc</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.KVComparator.html#compareColumns(byte[],%20int,%20int,%20byte[],%20int,%20int)">compareColumns</a></strong>(byte[] left, + int loffset, + int lquallength, + byte[] right, + int roffset, + int rquallength)</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.KVComparator.html#compareColumns(byte[],%20int,%20int,%20int,%20byte[],%20int,%20int,%20int)">compareColumns</a></strong>(byte[] left, + int loffset, + int llength, + int lfamilylength, + byte[] right, + int roffset, + int rlength, + int rfamilylength)</code> </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.KVComparator.html#compareFamilies(byte[],%20int,%20int,%20byte[],%20int,%20int)">compareFamilies</a></strong>(byte[] left, + int loffset, + int lfamilylength, + byte[] right, + int roffset, + int rfamilylength)</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.KVComparator.html#compareFlatKey(byte[],%20byte[])">compareFlatKey</a></strong>(byte[] left, + byte[] right)</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.KVComparator.html#compareFlatKey(byte[],%20int,%20int,%20byte[],%20int,%20int)">compareFlatKey</a></strong>(byte[] left, + int loffset, + int llength, + byte[] right, + int roffset, + int rlength)</code> +<div class="block">Compares left to right assuming that left,loffset,llength and right,roffset,rlength are + full KVs laid out in a flat byte[]s.</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.KVComparator.html#compareIgnoringPrefix(int,%20byte[],%20int,%20int,%20byte[],%20int,%20int)">compareIgnoringPrefix</a></strong>(int commonPrefix, + byte[] left, + int loffset, + int llength, + byte[] right, + int roffset, + int rlength)</code> +<div class="block">Overridden</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.KVComparator.html#compareKey(org.apache.hadoop.hbase.Cell,%20byte[],%20int,%20int,%20byte[],%20int,%20int,%20byte[],%20int,%20int,%20long,%20byte)">compareKey</a></strong>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell, + byte[] row, + int roff, + int rlen, + byte[] fam, + int foff, + int flen, + byte[] col, + int coff, + int clen, + long ts, + byte type)</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.KVComparator.html#compareOnlyKeyPortion(org.apache.hadoop.hbase.Cell,%20org.apache.hadoop.hbase.Cell)">compareOnlyKeyPortion</a></strong>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> left, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> right)</code> </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.KVComparator.html#compareRowKey(org.apache.hadoop.hbase.Cell,%20org.apache.hadoop.hbase.Cell)">compareRowKey</a></strong>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> left, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> right)</code> +<div class="block">Compares the only the user specified portion of a Key.</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.KVComparator.html#compareRows(byte[],%20int,%20int,%20byte[],%20int,%20int)">compareRows</a></strong>(byte[] left, + int loffset, + int llength, + byte[] right, + int roffset, + int rlength)</code> +<div class="block">Get the b[],o,l for left and right rowkey portions and compare.</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.KVComparator.html#compareRows(org.apache.hadoop.hbase.Cell,%20org.apache.hadoop.hbase.Cell)">compareRows</a></strong>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> left, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> right)</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.KVComparator.html#compareTimestamps(org.apache.hadoop.hbase.Cell,%20org.apache.hadoop.hbase.Cell)">compareTimestamps</a></strong>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> left, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> right)</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.KVComparator.html#getLegacyKeyComparatorName()">getLegacyKeyComparatorName</a></strong>()</code> +<div class="block">The HFileV2 file format's trailer contains this class name.</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.KVComparator.html#getShortMidpointKey(byte[],%20byte[])">getShortMidpointKey</a></strong>(byte[] leftKey, + byte[] rightKey)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Since 0.99.2; Use + <a href="../../../../org/apache/hadoop/hbase/CellComparator.html#getMidpoint(org.apache.hadoop.hbase.KeyValue.KVComparator,%20org.apache.hadoop.hbase.Cell,%20org.apache.hadoop.hbase.Cell)"><code>instead</code></a></i></div> +</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.KVComparator.html#matchingRowColumn(org.apache.hadoop.hbase.Cell,%20org.apache.hadoop.hbase.Cell)">matchingRowColumn</a></strong>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> left, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> right)</code> +<div class="block">Compares the row and column of two keyvalues for equality</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.KVComparator.html#matchingRows(byte[],%20int,%20int,%20byte[],%20int,%20int)">matchingRows</a></strong>(byte[] left, + int loffset, + int llength, + byte[] right, + int roffset, + int rlength)</code> +<div class="block">Compare rows.</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.KVComparator.html#matchingRows(org.apache.hadoop.hbase.Cell,%20org.apache.hadoop.hbase.Cell)">matchingRows</a></strong>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> left, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> right)</code> +<div class="block">Compares the row of two keyvalues for equality</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#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <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#hashCode()" title="class or interface in java.lang">hashCode</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/j ava/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</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> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.util.Comparator"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Comparator.html?is-external=true"; title="class or interface in java.util">Comparator</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Comparator.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.util">equals</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="KeyValue.KVComparator()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>KeyValue.KVComparator</h4> +<pre>public KeyValue.KVComparator()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getLegacyKeyComparatorName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLegacyKeyComparatorName</h4> +<pre>public <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> getLegacyKeyComparatorName()</pre> +<div class="block">The HFileV2 file format's trailer contains this class name. We reinterpret this and + instantiate the appropriate comparator. + TODO: With V3 consider removing this.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>legacy class name for FileFileTrailer#comparatorClassName</dd></dl> +</li> +</ul> +<a name="compare(byte[], int, int, byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compare</h4> +<pre>public int compare(byte[] l, + int loff, + int llen, + byte[] r, + int roff, + int rlen)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>compare</code> in interface <code>org.apache.hadoop.io.RawComparator<<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>></code></dd> +</dl> +</li> +</ul> +<a name="compareRowKey(org.apache.hadoop.hbase.Cell, org.apache.hadoop.hbase.Cell)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareRowKey</h4> +<pre>protected int compareRowKey(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> left, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> right)</pre> +<div class="block">Compares the only the user specified portion of a Key. This is overridden by MetaComparator.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>left</code> - </dd><dd><code>right</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>0 if equal, <0 if left smaller, >0 if right smaller</dd></dl> +</li> +</ul> +<a name="compareFlatKey(byte[], int, int, byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareFlatKey</h4> +<pre>public int compareFlatKey(byte[] left, + int loffset, + int llength, + byte[] right, + int roffset, + int rlength)</pre> +<div class="block">Compares left to right assuming that left,loffset,llength and right,roffset,rlength are + full KVs laid out in a flat byte[]s.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>left</code> - </dd><dd><code>loffset</code> - </dd><dd><code>llength</code> - </dd><dd><code>right</code> - </dd><dd><code>roffset</code> - </dd><dd><code>rlength</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>0 if equal, <0 if left smaller, >0 if right smaller</dd></dl> +</li> +</ul> +<a name="compareFlatKey(byte[], byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareFlatKey</h4> +<pre>public int compareFlatKey(byte[] left, + byte[] right)</pre> +</li> +</ul> +<a name="compareKey(org.apache.hadoop.hbase.Cell, byte[], int, int, byte[], int, int, byte[], int, int, long, byte)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareKey</h4> +<pre>public int compareKey(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell, + byte[] row, + int roff, + int rlen, + byte[] fam, + int foff, + int flen, + byte[] col, + int coff, + int clen, + long ts, + byte type)</pre> +</li> +</ul> +<a name="compareOnlyKeyPortion(org.apache.hadoop.hbase.Cell, org.apache.hadoop.hbase.Cell)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareOnlyKeyPortion</h4> +<pre>public int compareOnlyKeyPortion(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> left, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> right)</pre> +</li> +</ul> +<a name="compare(org.apache.hadoop.hbase.Cell, org.apache.hadoop.hbase.Cell)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compare</h4> +<pre>public int compare(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> left, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> right)</pre> +<div class="block">Compares the Key of a cell -- with fields being more significant in this order: + rowkey, colfam/qual, timestamp, type, mvcc</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Comparator.html?is-external=true#compare(T,%20T)" title="class or interface in java.util">compare</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Comparator.html?is-external=true"; title="class or interface in java.util">Comparator</a><<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>></code></dd> +</dl> +</li> +</ul> +<a name="compareTimestamps(org.apache.hadoop.hbase.Cell, org.apache.hadoop.hbase.Cell)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareTimestamps</h4> +<pre>public int compareTimestamps(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> left, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> right)</pre> +</li> +</ul> +<a name="compareRows(org.apache.hadoop.hbase.Cell, org.apache.hadoop.hbase.Cell)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareRows</h4> +<pre>public int compareRows(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> left, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> right)</pre> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>left</code> - </dd><dd><code>right</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>Result comparing rows.</dd></dl> +</li> +</ul> +<a name="compareRows(byte[], int, int, byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareRows</h4> +<pre>public int compareRows(byte[] left, + int loffset, + int llength, + byte[] right, + int roffset, + int rlength)</pre> +<div class="block">Get the b[],o,l for left and right rowkey portions and compare.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>left</code> - </dd><dd><code>loffset</code> - </dd><dd><code>llength</code> - </dd><dd><code>right</code> - </dd><dd><code>roffset</code> - </dd><dd><code>rlength</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>0 if equal, <0 if left smaller, >0 if right smaller</dd></dl> +</li> +</ul> +<a name="compareColumns(byte[], int, int, int, byte[], int, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareColumns</h4> +<pre>protected int compareColumns(byte[] left, + int loffset, + int llength, + int lfamilylength, + byte[] right, + int roffset, + int rlength, + int rfamilylength)</pre> +</li> +</ul> +<a name="compareIgnoringPrefix(int, byte[], int, int, byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareIgnoringPrefix</h4> +<pre>public int compareIgnoringPrefix(int commonPrefix, + byte[] left, + int loffset, + int llength, + byte[] right, + int roffset, + int rlength)</pre> +<div class="block">Overridden</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/hadoop/hbase/KeyValue.SamePrefixComparator.html#compareIgnoringPrefix(int,%20byte[],%20int,%20int,%20byte[],%20int,%20int)">compareIgnoringPrefix</a></code> in interface <code><a href="../../../../org/apache/hadoop/hbase/KeyValue.SamePrefixComparator.html" title="interface in org.apache.hadoop.hbase">KeyValue.SamePrefixComparator</a><byte[]></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>commonPrefix</code> - </dd><dd><code>left</code> - </dd><dd><code>loffset</code> - </dd><dd><code>llength</code> - </dd><dd><code>right</code> - </dd><dd><code>roffset</code> - </dd><dd><code>rlength</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>0 if equal, <0 if left smaller, >0 if right smaller</dd></dl> +</li> +</ul> +<a name="compareFamilies(byte[], int, int, byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareFamilies</h4> +<pre>protected int compareFamilies(byte[] left, + int loffset, + int lfamilylength, + byte[] right, + int roffset, + int rfamilylength)</pre> +</li> +</ul> +<a name="compareColumns(byte[], int, int, byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareColumns</h4> +<pre>protected int compareColumns(byte[] left, + int loffset, + int lquallength, + byte[] right, + int roffset, + int rquallength)</pre> +</li> +</ul> +<a name="matchingRowColumn(org.apache.hadoop.hbase.Cell, org.apache.hadoop.hbase.Cell)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>matchingRowColumn</h4> +<pre>public boolean matchingRowColumn(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> left, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> right)</pre> +<div class="block">Compares the row and column of two keyvalues for equality</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>left</code> - </dd><dd><code>right</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>True if same row and column.</dd></dl> +</li> +</ul> +<a name="matchingRows(org.apache.hadoop.hbase.Cell, org.apache.hadoop.hbase.Cell)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>matchingRows</h4> +<pre>public boolean matchingRows(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> left, + <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> right)</pre> +<div class="block">Compares the row of two keyvalues for equality</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>left</code> - </dd><dd><code>right</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>True if rows match.</dd></dl> +</li> +</ul> +<a name="matchingRows(byte[], int, int, byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>matchingRows</h4> +<pre>public boolean matchingRows(byte[] left, + int loffset, + int llength, + byte[] right, + int roffset, + int rlength)</pre> +<div class="block">Compare rows. Just calls Bytes.equals, but it's good to have this encapsulated.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>left</code> - Left row array.</dd><dd><code>loffset</code> - Left row offset.</dd><dd><code>llength</code> - Left row length.</dd><dd><code>right</code> - Right row array.</dd><dd><code>roffset</code> - Right row offset.</dd><dd><code>rlength</code> - Right row length.</dd> +<dt><span class="strong">Returns:</span></dt><dd>Whether rows are the same row.</dd></dl> +</li> +</ul> +<a name="calcIndexKey(byte[], byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>calcIndexKey</h4> +<pre>public byte[] calcIndexKey(byte[] lastKeyOfPreviousBlock, + byte[] firstKeyInBlock)</pre> +</li> +</ul> +<a name="getShortMidpointKey(byte[], byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getShortMidpointKey</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public byte[] getShortMidpointKey(byte[] leftKey, + byte[] rightKey)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>Since 0.99.2; Use + <a href="../../../../org/apache/hadoop/hbase/CellComparator.html#getMidpoint(org.apache.hadoop.hbase.KeyValue.KVComparator,%20org.apache.hadoop.hbase.Cell,%20org.apache.hadoop.hbase.Cell)"><code>instead</code></a></i></div> +<div class="block">This is a HFile block index key optimization.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>leftKey</code> - </dd><dd><code>rightKey</code> - </dd> +<dt><span class="strong">Returns:</span></dt><dd>0 if equal, <0 if left smaller, >0 if right smaller</dd></dl> +</li> +</ul> +<a name="clone()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>clone</h4> +<pre>protected <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> clone() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/CloneNotSupportedException.html?is-external=true"; title="class or interface in java.lang">CloneNotSupportedException</a></pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a></code> in class <code><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></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/CloneNotSupportedException.html?is-external=true"; title="class or interface in java.lang">CloneNotSupportedException</a></code></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_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.KVComparator.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/KeyValue.KeyOnlyKeyValue.html" title="class in org.apache.hadoop.hbase"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/KeyValue.MetaComparator.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.KVComparator.html" target="_top">Frames</a></li> +<li><a href="KeyValue.KVComparator.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </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>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2007-2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All Rights Reserved.</small></p> +</body> +</html>
