http://git-wip-us.apache.org/repos/asf/hbase-site/blob/b1eb7453/devapidocs/org/apache/hadoop/hbase/ProcedureState.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/ProcedureState.html b/devapidocs/org/apache/hadoop/hbase/ProcedureState.html index c087a98..8fae66b 100644 --- a/devapidocs/org/apache/hadoop/hbase/ProcedureState.html +++ b/devapidocs/org/apache/hadoop/hbase/ProcedureState.html @@ -50,7 +50,7 @@ var activeTableTab = "activeTableTab"; <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.ValueAndTagRewriteCell.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/hadoop/hbase/RegionException.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/hadoop/hbase/ProcedureState.html" target="_top">Frames</a></li> @@ -359,7 +359,7 @@ not permitted.)</div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.ValueAndTagRewriteCell.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/hadoop/hbase/RegionException.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/apache/hadoop/hbase/ProcedureState.html" target="_top">Frames</a></li>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/b1eb7453/devapidocs/org/apache/hadoop/hbase/RawCell.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/RawCell.html b/devapidocs/org/apache/hadoop/hbase/RawCell.html new file mode 100644 index 0000000..b7bbbc8 --- /dev/null +++ b/devapidocs/org/apache/hadoop/hbase/RawCell.html @@ -0,0 +1,355 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>RawCell (Apache HBase 3.0.0-SNAPSHOT API)</title> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="RawCell (Apache HBase 3.0.0-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":17,"i1":18,"i2":18,"i3":18}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],16:["t5","Default Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/RawCell.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/ProcedureState.html" title="enum in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/RegionException.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/hadoop/hbase/RawCell.html" target="_top">Frames</a></li> +<li><a href="RawCell.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>Constr | </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>Constr | </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="Interface RawCell" class="title">Interface RawCell</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/hadoop/hbase/io/encoding/BufferedDataBlockEncoder.OffheapDecodedCell.html" title="class in org.apache.hadoop.hbase.io.encoding">BufferedDataBlockEncoder.OffheapDecodedCell</a>, <a href="../../../../org/apache/hadoop/hbase/io/encoding/BufferedDataBlockEncoder.OnheapDecodedCell.html" title="class in org.apache.hadoop.hbase.io.encoding">BufferedDataBlockEncoder.OnheapDecodedCell</a>, <a href="../../../../org/apache/hadoop/hbase/regionserver/ByteBufferChunkCell.html" title="class in org.apache.hadoop.hbase.regionserver">ByteBufferChunkCell</a>, <a href="../../../../org/apache/hadoop/hbase/ByteBufferKeyValue.html" title="class in org.apache.hadoop.hbase">ByteBufferKeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/IndividualBytesFieldCell.html" title="class in org.apache.hadoop.hbase">IndividualBytesFieldCell</a>, <a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class in org.apache.hadoop.hbase">KeyValue</a>, <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/util/MapReduceCell.html" title="class in org.apache.hadoop.hbase.util">MapReduceCell</a>, <a href="../../../../org/apache/hadoop/hbase/regionserver/NoTagByteBufferChunkCell.html" title="class in org.apache.hadoop.hbase.regionserver">NoTagByteBufferChunkCell</a>, <a href="../../../../org/apache/hadoop/hbase/NoTagsByteBufferKeyValue.html" title="class in org.apache.hadoop.hbase">NoTagsByteBufferKeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/NoTagsKeyValue.html" title="class in org.apache.hadoop.hbase">NoTagsKeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.TagRewriteByteBufferCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.TagRewriteByteBufferCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.TagRewriteCell.html" title="class in org.apac he.hadoop.hbase">PrivateCellUtil.TagRewriteCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.ValueAndTagRewriteByteBufferCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.ValueAndTagRewriteByteBufferCell</a>, <a href="../../../../org/apache/hadoop/hbase/PrivateCellUtil.ValueAndTagRewriteCell.html" title="class in org.apache.hadoop.hbase">PrivateCellUtil.ValueAndTagRewriteCell</a>, <a href="../../../../org/apache/hadoop/hbase/SizeCachedKeyValue.html" title="class in org.apache.hadoop.hbase">SizeCachedKeyValue</a>, <a href="../../../../org/apache/hadoop/hbase/SizeCachedNoTagsKeyValue.html" title="class in org.apache.hadoop.hbase">SizeCachedNoTagsKeyValue</a></dd> +</dl> +<hr> +<br> +<pre>@InterfaceAudience.LimitedPrivate(value="Coprocesssor") +public interface <a href="../../../../src-html/org/apache/hadoop/hbase/RawCell.html#line.29">RawCell</a> +extends <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></pre> +<div class="block">An extended version of cell that gives more power to CPs</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/RawCell.html#MAX_TAGS_LENGTH">MAX_TAGS_LENGTH</a></span></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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/RawCell.html#checkForTagsLength-int-">checkForTagsLength</a></span>(int tagsLength)</code> +<div class="block">Check the length of tags.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>default byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/RawCell.html#cloneTags--">cloneTags</a></span>()</code> +<div class="block">Allows cloning the tags in the cell to a new byte[]</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/RawCell.html#getTag-byte-">getTag</a></span>(byte type)</code> +<div class="block">Returns the specific tag of the given type</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/RawCell.html#getTags--">getTags</a></span>()</code> +<div class="block">Creates a list of tags in the current cell</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.Cell"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a></h3> +<code><a href="../../../../org/apache/hadoop/hbase/Cell.html#getFamilyArray--">getFamilyArray</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getFamilyLength--">getFamilyLength</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getFamilyOffset--">getFamilyOffset</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getQualifierArray--">getQualifierArray</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getQualifierLength--">getQualifierLength</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getQualifierOffset--">getQualifierOffset</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getRowArray--">getRowArray</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getRowLength--">getRowLength</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getRowOffset--">getRowOffset</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getSequenceId--">getSequenceId</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.h tml#getTagsArray--">getTagsArray</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getTagsLength--">getTagsLength</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getTagsOffset--">getTagsOffset</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getTimestamp--">getTimestamp</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getTypeByte--">getTypeByte</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getValueArray--">getValueArray</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getValueLength--">getValueLength</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html#getValueOffset--">getValueOffset</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="MAX_TAGS_LENGTH"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MAX_TAGS_LENGTH</h4> +<pre>static final int <a href="../../../../src-html/org/apache/hadoop/hbase/RawCell.html#line.30">MAX_TAGS_LENGTH</a></pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.RawCell.MAX_TAGS_LENGTH">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="cloneTags--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cloneTags</h4> +<pre>default byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/RawCell.html#line.36">cloneTags</a>()</pre> +<div class="block">Allows cloning the tags in the cell to a new byte[]</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the byte[] having the tags</dd> +</dl> +</li> +</ul> +<a name="getTags--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTags</h4> +<pre>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> <a href="../../../../src-html/org/apache/hadoop/hbase/RawCell.html#line.44">getTags</a>()</pre> +<div class="block">Creates a list of tags in the current cell</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a list of tags</dd> +</dl> +</li> +</ul> +<a name="getTag-byte-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTag</h4> +<pre>default <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> <a href="../../../../src-html/org/apache/hadoop/hbase/RawCell.html#line.54">getTag</a>(byte type)</pre> +<div class="block">Returns the specific tag of the given type</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>type</code> - the type of the tag</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the specific tag if available or null</dd> +</dl> +</li> +</ul> +<a name="checkForTagsLength-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>checkForTagsLength</h4> +<pre>static void <a href="../../../../src-html/org/apache/hadoop/hbase/RawCell.html#line.63">checkForTagsLength</a>(int tagsLength)</pre> +<div class="block">Check the length of tags. If it is invalid, throw IllegalArgumentException</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>tagsLength</code> - the given length of tags</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if tagslength is invalid</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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/RawCell.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/ProcedureState.html" title="enum in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/RegionException.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/hadoop/hbase/RawCell.html" target="_top">Frames</a></li> +<li><a href="RawCell.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>Constr | </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>Constr | </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–2017 <a href="https://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/b1eb7453/devapidocs/org/apache/hadoop/hbase/RegionException.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/RegionException.html b/devapidocs/org/apache/hadoop/hbase/RegionException.html index 57e074b..13df95a 100644 --- a/devapidocs/org/apache/hadoop/hbase/RegionException.html +++ b/devapidocs/org/apache/hadoop/hbase/RegionException.html @@ -43,7 +43,7 @@ </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/hadoop/hbase/ProcedureState.html" title="enum in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../org/apache/hadoop/hbase/RegionLoad.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> @@ -296,7 +296,7 @@ extends <a href="../../../../org/apache/hadoop/hbase/HBaseIOException.html" titl </div> <div class="subNav"> <ul class="navList"> -<li><a href="../../../../org/apache/hadoop/hbase/ProcedureState.html" title="enum in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../org/apache/hadoop/hbase/RegionLoad.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/b1eb7453/devapidocs/org/apache/hadoop/hbase/SizeCachedKeyValue.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/SizeCachedKeyValue.html b/devapidocs/org/apache/hadoop/hbase/SizeCachedKeyValue.html index 0fe1106..494edb6 100644 --- a/devapidocs/org/apache/hadoop/hbase/SizeCachedKeyValue.html +++ b/devapidocs/org/apache/hadoop/hbase/SizeCachedKeyValue.html @@ -114,7 +114,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> -<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>, <a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/io/HeapSize.html" title="interface in org.apache.hadoop.hbase.io">HeapSize</a>, <a href="../../../../org/apache/hadoop/hbase/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> +<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>, <a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/io/HeapSize.html" title="interface in org.apache.hadoop.hbase.io">HeapSize</a>, <a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase">RawCell</a>, <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> @@ -190,6 +190,13 @@ extends <a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class <h3>Fields inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></h3> <code><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#CELL_NOT_BASED_ON_CHUNK">CELL_NOT_BASED_ON_CHUNK</a></code></li> </ul> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.hbase.RawCell"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase">RawCell</a></h3> +<code><a href="../../../../org/apache/hadoop/hbase/RawCell.html#MAX_TAGS_LENGTH">MAX_TAGS_LENGTH</a></code></li> +</ul> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> @@ -263,6 +270,13 @@ extends <a href="../../../../org/apache/hadoop/hbase/KeyValue.html" title="class <h3>Methods inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></h3> <code><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#getChunkId--">getChunkId</a></code></li> </ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.RawCell"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase">RawCell</a></h3> +<code><a href="../../../../org/apache/hadoop/hbase/RawCell.html#checkForTagsLength-int-">checkForTagsLength</a>, <a href="../../../../org/apache/hadoop/hbase/RawCell.html#cloneTags--">cloneTags</a>, <a href="../../../../org/apache/hadoop/hbase/RawCell.html#getTag-byte-">getTag</a></code></li> +</ul> </li> </ul> </li> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/b1eb7453/devapidocs/org/apache/hadoop/hbase/SizeCachedNoTagsKeyValue.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/SizeCachedNoTagsKeyValue.html b/devapidocs/org/apache/hadoop/hbase/SizeCachedNoTagsKeyValue.html index 4ad995a..104c423 100644 --- a/devapidocs/org/apache/hadoop/hbase/SizeCachedNoTagsKeyValue.html +++ b/devapidocs/org/apache/hadoop/hbase/SizeCachedNoTagsKeyValue.html @@ -119,7 +119,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> -<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>, <a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/io/HeapSize.html" title="interface in org.apache.hadoop.hbase.io">HeapSize</a>, <a href="../../../../org/apache/hadoop/hbase/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> +<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>, <a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a>, <a href="../../../../org/apache/hadoop/hbase/io/HeapSize.html" title="interface in org.apache.hadoop.hbase.io">HeapSize</a>, <a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase">RawCell</a>, <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> <hr> <br> @@ -170,6 +170,13 @@ extends <a href="../../../../org/apache/hadoop/hbase/SizeCachedKeyValue.html" ti <h3>Fields inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></h3> <code><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#CELL_NOT_BASED_ON_CHUNK">CELL_NOT_BASED_ON_CHUNK</a></code></li> </ul> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.hbase.RawCell"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase">RawCell</a></h3> +<code><a href="../../../../org/apache/hadoop/hbase/RawCell.html#MAX_TAGS_LENGTH">MAX_TAGS_LENGTH</a></code></li> +</ul> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> @@ -250,6 +257,13 @@ extends <a href="../../../../org/apache/hadoop/hbase/SizeCachedKeyValue.html" ti <h3>Methods inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html" title="interface in org.apache.hadoop.hbase">ExtendedCell</a></h3> <code><a href="../../../../org/apache/hadoop/hbase/ExtendedCell.html#getChunkId--">getChunkId</a></code></li> </ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.RawCell"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.hadoop.hbase.<a href="../../../../org/apache/hadoop/hbase/RawCell.html" title="interface in org.apache.hadoop.hbase">RawCell</a></h3> +<code><a href="../../../../org/apache/hadoop/hbase/RawCell.html#checkForTagsLength-int-">checkForTagsLength</a>, <a href="../../../../org/apache/hadoop/hbase/RawCell.html#cloneTags--">cloneTags</a>, <a href="../../../../org/apache/hadoop/hbase/RawCell.html#getTag-byte-">getTag</a></code></li> +</ul> </li> </ul> </li> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/b1eb7453/devapidocs/org/apache/hadoop/hbase/Tag.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/Tag.html b/devapidocs/org/apache/hadoop/hbase/Tag.html index a02a6a8..22dc95b 100644 --- a/devapidocs/org/apache/hadoop/hbase/Tag.html +++ b/devapidocs/org/apache/hadoop/hbase/Tag.html @@ -18,8 +18,8 @@ catch(err) { } //--> -var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var methods = {"i0":17,"i1":17,"i2":17,"i3":6,"i4":6,"i5":17,"i6":17,"i7":17,"i8":6,"i9":6,"i10":6,"i11":6,"i12":17}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; @@ -105,9 +105,9 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>@InterfaceAudience.Private +<pre>@InterfaceAudience.LimitedPrivate(value="Coprocesssor") @InterfaceStability.Evolving -public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.38">Tag</a></pre> +public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.40">Tag</a></pre> <div class="block">Tags are part of cells and helps to add metadata about them. Metadata could be ACLs, visibility labels, etc. <p> @@ -133,18 +133,24 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html# <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> +<td class="colFirst"><code>static byte</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#CUSTOM_TAG_TYPE_RANGE">CUSTOM_TAG_TYPE_RANGE</a></span></code> +<div class="block">Custom tags if created are suggested to be above this range.</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#INFRASTRUCTURE_SIZE">INFRASTRUCTURE_SIZE</a></span></code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#MAX_TAG_LENGTH">MAX_TAG_LENGTH</a></span></code> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#TAG_LENGTH_SIZE">TAG_LENGTH_SIZE</a></span></code> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#TYPE_LENGTH_SIZE">TYPE_LENGTH_SIZE</a></span></code> </td> </tr> @@ -158,37 +164,82 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html# </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#cloneValue-org.apache.hadoop.hbase.Tag-">cloneValue</a></span>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag)</code> +<div class="block">Returns tag value in a new byte array.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#copyValueTo-org.apache.hadoop.hbase.Tag-byte:A-int-">copyValueTo</a></span>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag, + byte[] out, + int offset)</code> +<div class="block">Copies the tag's value bytes to the given byte array</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static byte[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#fromList-java.util.List-">fromList</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> tags)</code> +<div class="block">Write a list of tags into a byte array</div> +</td> +</tr> +<tr id="i3" class="rowColor"> <td class="colFirst"><code>byte</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#getType--">getType</a></span>()</code> </td> </tr> -<tr id="i1" class="rowColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code>byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#getValueArray--">getValueArray</a></span>()</code> </td> </tr> -<tr id="i2" class="altColor"> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>static byte</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#getValueAsByte-org.apache.hadoop.hbase.Tag-">getValueAsByte</a></span>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag)</code> +<div class="block">Converts the value bytes of the given tag into a byte value</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#getValueAsLong-org.apache.hadoop.hbase.Tag-">getValueAsLong</a></span>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag)</code> +<div class="block">Converts the value bytes of the given tag into a long value</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#getValueAsString-org.apache.hadoop.hbase.Tag-">getValueAsString</a></span>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag)</code> +<div class="block">Converts the value bytes of the given tag into a String value</div> +</td> +</tr> +<tr id="i8" class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#getValueByteBuffer--">getValueByteBuffer</a></span>()</code> </td> </tr> -<tr id="i3" class="rowColor"> +<tr id="i9" class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#getValueLength--">getValueLength</a></span>()</code> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i10" class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#getValueOffset--">getValueOffset</a></span>()</code> </td> </tr> -<tr id="i5" class="rowColor"> +<tr id="i11" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#hasArray--">hasArray</a></span>()</code> <div class="block">Tells whether or not this Tag is backed by a byte array.</div> </td> </tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#matchingValue-org.apache.hadoop.hbase.Tag-org.apache.hadoop.hbase.Tag-">matchingValue</a></span>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> t1, + <a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> t2)</code> +<div class="block">Matches the value part of given tags</div> +</td> +</tr> </table> </li> </ul> @@ -210,7 +261,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html# <ul class="blockList"> <li class="blockList"> <h4>TYPE_LENGTH_SIZE</h4> -<pre>static final int <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.40">TYPE_LENGTH_SIZE</a></pre> +<pre>static final int <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.42">TYPE_LENGTH_SIZE</a></pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.Tag.TYPE_LENGTH_SIZE">Constant Field Values</a></dd> @@ -223,7 +274,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html# <ul class="blockList"> <li class="blockList"> <h4>TAG_LENGTH_SIZE</h4> -<pre>static final int <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.41">TAG_LENGTH_SIZE</a></pre> +<pre>static final int <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.43">TAG_LENGTH_SIZE</a></pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.Tag.TAG_LENGTH_SIZE">Constant Field Values</a></dd> @@ -236,7 +287,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html# <ul class="blockList"> <li class="blockList"> <h4>INFRASTRUCTURE_SIZE</h4> -<pre>static final int <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.42">INFRASTRUCTURE_SIZE</a></pre> +<pre>static final int <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.44">INFRASTRUCTURE_SIZE</a></pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.Tag.INFRASTRUCTURE_SIZE">Constant Field Values</a></dd> @@ -246,16 +297,31 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html# <a name="MAX_TAG_LENGTH"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>MAX_TAG_LENGTH</h4> -<pre>static final int <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.43">MAX_TAG_LENGTH</a></pre> +<pre>static final int <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.45">MAX_TAG_LENGTH</a></pre> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.Tag.MAX_TAG_LENGTH">Constant Field Values</a></dd> </dl> </li> </ul> +<a name="CUSTOM_TAG_TYPE_RANGE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CUSTOM_TAG_TYPE_RANGE</h4> +<pre>static final byte <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.51">CUSTOM_TAG_TYPE_RANGE</a></pre> +<div class="block">Custom tags if created are suggested to be above this range. So that + it does not overlap with internal tag types</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.Tag.CUSTOM_TAG_TYPE_RANGE">Constant Field Values</a></dd> +</dl> +</li> +</ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> @@ -270,7 +336,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html# <ul class="blockList"> <li class="blockList"> <h4>getType</h4> -<pre>byte <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.48">getType</a>()</pre> +<pre>byte <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.55">getType</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the tag type</dd> @@ -283,7 +349,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html# <ul class="blockList"> <li class="blockList"> <h4>getValueOffset</h4> -<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.53">getValueOffset</a>()</pre> +<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.60">getValueOffset</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>Offset of tag value within the backed buffer</dd> @@ -296,7 +362,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html# <ul class="blockList"> <li class="blockList"> <h4>getValueLength</h4> -<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.58">getValueLength</a>()</pre> +<pre>int <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.65">getValueLength</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>Length of tag value within the backed buffer</dd> @@ -309,7 +375,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html# <ul class="blockList"> <li class="blockList"> <h4>hasArray</h4> -<pre>boolean <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.64">hasArray</a>()</pre> +<pre>boolean <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.71">hasArray</a>()</pre> <div class="block">Tells whether or not this Tag is backed by a byte array.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -323,7 +389,7 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html# <ul class="blockList"> <li class="blockList"> <h4>getValueArray</h4> -<pre>byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.72">getValueArray</a>()</pre> +<pre>byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.79">getValueArray</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The array containing the value bytes.</dd> @@ -336,16 +402,134 @@ public interface <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html# <a name="getValueByteBuffer--"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>getValueByteBuffer</h4> -<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.77">getValueByteBuffer</a>()</pre> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.84">getValueByteBuffer</a>()</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The <a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio"><code>ByteBuffer</code></a> containing the value bytes.</dd> </dl> </li> </ul> +<a name="cloneValue-org.apache.hadoop.hbase.Tag-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cloneValue</h4> +<pre>static byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.93">cloneValue</a>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag)</pre> +<div class="block">Returns tag value in a new byte array. Primarily for use client-side. If server-side, use + <a href="../../../../org/apache/hadoop/hbase/Tag.html#getValueArray--"><code>getValueArray()</code></a> with appropriate <a href="../../../../org/apache/hadoop/hbase/Tag.html#getValueOffset--"><code>getValueOffset()</code></a> and + <a href="../../../../org/apache/hadoop/hbase/Tag.html#getValueLength--"><code>getValueLength()</code></a> instead to save on allocations.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>tag</code> - The Tag whose value to be returned</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>tag value in a new byte array.</dd> +</dl> +</li> +</ul> +<a name="getValueAsString-org.apache.hadoop.hbase.Tag-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValueAsString</h4> +<pre>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.110">getValueAsString</a>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag)</pre> +<div class="block">Converts the value bytes of the given tag into a String value</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>tag</code> - The Tag</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>value as String</dd> +</dl> +</li> +</ul> +<a name="matchingValue-org.apache.hadoop.hbase.Tag-org.apache.hadoop.hbase.Tag-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>matchingValue</h4> +<pre>static boolean <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.123">matchingValue</a>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> t1, + <a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> t2)</pre> +<div class="block">Matches the value part of given tags</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>t1</code> - Tag to match the value</dd> +<dd><code>t2</code> - Tag to match the value</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>True if values of both tags are same.</dd> +</dl> +</li> +</ul> +<a name="copyValueTo-org.apache.hadoop.hbase.Tag-byte:A-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>copyValueTo</h4> +<pre>static void <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.146">copyValueTo</a>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag, + byte[] out, + int offset)</pre> +<div class="block">Copies the tag's value bytes to the given byte array</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>tag</code> - The Tag</dd> +<dd><code>out</code> - The byte array where to copy the Tag value.</dd> +<dd><code>offset</code> - The offset within 'out' array where to copy the Tag value.</dd> +</dl> +</li> +</ul> +<a name="fromList-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fromList</h4> +<pre>static byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.161">fromList</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> tags)</pre> +<div class="block">Write a list of tags into a byte array</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>tags</code> - The list of tags</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the serialized tag data as bytes</dd> +</dl> +</li> +</ul> +<a name="getValueAsLong-org.apache.hadoop.hbase.Tag-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getValueAsLong</h4> +<pre>static long <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.192">getValueAsLong</a>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag)</pre> +<div class="block">Converts the value bytes of the given tag into a long value</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>tag</code> - The Tag</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>value as long</dd> +</dl> +</li> +</ul> +<a name="getValueAsByte-org.apache.hadoop.hbase.Tag-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getValueAsByte</h4> +<pre>static byte <a href="../../../../src-html/org/apache/hadoop/hbase/Tag.html#line.204">getValueAsByte</a>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag)</pre> +<div class="block">Converts the value bytes of the given tag into a byte value</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>tag</code> - The Tag</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>value as byte</dd> +</dl> +</li> +</ul> </li> </ul> </li> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/b1eb7453/devapidocs/org/apache/hadoop/hbase/TagUtil.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/TagUtil.html b/devapidocs/org/apache/hadoop/hbase/TagUtil.html index fbf6f94..8adfa16 100644 --- a/devapidocs/org/apache/hadoop/hbase/TagUtil.html +++ b/devapidocs/org/apache/hadoop/hbase/TagUtil.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9,"i14":9}; +var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9}; var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -110,7 +110,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>@InterfaceAudience.Private -public final class <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.35">TagUtil</a> +public final class <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.32">TagUtil</a> extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> </li> </ul> @@ -136,10 +136,6 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <div class="block">Iterator returned when no Tags.</div> </td> </tr> -<tr class="rowColor"> -<td class="colFirst"><code>private static int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#MAX_TAGS_LENGTH">MAX_TAGS_LENGTH</a></span></code> </td> -</tr> </table> </li> </ul> @@ -157,9 +153,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? </tr> <tr class="altColor"> <td class="colFirst"><code>private </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#TagUtil--">TagUtil</a></span>()</code> -<div class="block">Private constructor to keep this class from being instantiated.</div> -</td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#TagUtil--">TagUtil</a></span>()</code> </td> </tr> </table> </li> @@ -186,85 +180,26 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#asList-java.nio.ByteBuffer-int-int-">asList</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> b, - int offset, - int length)</code> -<div class="block">Creates list of tags from given ByteBuffer, expected that it is in the expected tag format.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#carryForwardTags-org.apache.hadoop.hbase.Cell-">carryForwardTags</a></span>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</code> </td> </tr> -<tr id="i3" class="rowColor"> +<tr id="i2" class="altColor"> <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#carryForwardTags-java.util.List-org.apache.hadoop.hbase.Cell-">carryForwardTags</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> tagsOrNull, <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</code> <div class="block">Add to <code>tagsOrNull</code> any Tags <code>cell</code> is carrying or null if none.</div> </td> </tr> -<tr id="i4" class="altColor"> +<tr id="i3" class="rowColor"> <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#carryForwardTTLTag-java.util.List-long-">carryForwardTTLTag</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> tagsOrNull, long ttl)</code> </td> </tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code>static void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#checkForTagsLength-int-">checkForTagsLength</a></span>(int tagsLength)</code> -<div class="block">Check the length of tags.</div> -</td> -</tr> -<tr id="i6" class="altColor"> -<td class="colFirst"><code>static byte[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#cloneValue-org.apache.hadoop.hbase.Tag-">cloneValue</a></span>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag)</code> -<div class="block">Returns tag value in a new byte array.</div> -</td> -</tr> -<tr id="i7" class="rowColor"> +<tr id="i4" class="altColor"> <td class="colFirst"><code>static byte[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#concatTags-byte:A-org.apache.hadoop.hbase.Cell-">concatTags</a></span>(byte[] tags, <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</code> </td> </tr> -<tr id="i8" class="altColor"> -<td class="colFirst"><code>static void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#copyValueTo-org.apache.hadoop.hbase.Tag-byte:A-int-">copyValueTo</a></span>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag, - byte[] out, - int offset)</code> -<div class="block">Copies the tag's value bytes to the given byte array</div> -</td> -</tr> -<tr id="i9" class="rowColor"> -<td class="colFirst"><code>static byte[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#fromList-java.util.List-">fromList</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> tags)</code> -<div class="block">Write a list of tags into a byte array</div> -</td> -</tr> -<tr id="i10" class="altColor"> -<td class="colFirst"><code>static byte</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#getValueAsByte-org.apache.hadoop.hbase.Tag-">getValueAsByte</a></span>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag)</code> -<div class="block">Converts the value bytes of the given tag into a byte value</div> -</td> -</tr> -<tr id="i11" class="rowColor"> -<td class="colFirst"><code>static long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#getValueAsLong-org.apache.hadoop.hbase.Tag-">getValueAsLong</a></span>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag)</code> -<div class="block">Converts the value bytes of the given tag into a long value</div> -</td> -</tr> -<tr id="i12" class="altColor"> -<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#getValueAsString-org.apache.hadoop.hbase.Tag-">getValueAsString</a></span>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag)</code> -<div class="block">Converts the value bytes of the given tag into a String value</div> -</td> -</tr> -<tr id="i13" class="rowColor"> -<td class="colFirst"><code>static boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#matchingValue-org.apache.hadoop.hbase.Tag-org.apache.hadoop.hbase.Tag-">matchingValue</a></span>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> t1, - <a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> t2)</code> -<div class="block">Matches the value part of given tags</div> -</td> -</tr> -<tr id="i14" class="altColor"> +<tr id="i5" class="rowColor"> <td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TagUtil.html#readVIntValuePart-org.apache.hadoop.hbase.Tag-int-">readVIntValuePart</a></span>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag, int offset)</code> @@ -293,26 +228,13 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <!-- --> </a> <h3>Field Detail</h3> -<a name="MAX_TAGS_LENGTH"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>MAX_TAGS_LENGTH</h4> -<pre>private static final int <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.38">MAX_TAGS_LENGTH</a></pre> -<dl> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../../../constant-values.html#org.apache.hadoop.hbase.TagUtil.MAX_TAGS_LENGTH">Constant Field Values</a></dd> -</dl> -</li> -</ul> <a name="EMPTY_TAGS_ITR"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>EMPTY_TAGS_ITR</h4> -<pre>static final <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.298">EMPTY_TAGS_ITR</a></pre> +<pre>static final <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.142">EMPTY_TAGS_ITR</a></pre> <div class="block">Iterator returned when no Tags. Used by CellUtil too.</div> </li> </ul> @@ -330,8 +252,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>TagUtil</h4> -<pre>private <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.43">TagUtil</a>()</pre> -<div class="block">Private constructor to keep this class from being instantiated.</div> +<pre>private <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.34">TagUtil</a>()</pre> </li> </ul> </li> @@ -342,32 +263,13 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <!-- --> </a> <h3>Method Detail</h3> -<a name="cloneValue-org.apache.hadoop.hbase.Tag-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>cloneValue</h4> -<pre>public static byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.54">cloneValue</a>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag)</pre> -<div class="block">Returns tag value in a new byte array. - Primarily for use client-side. If server-side, use - <a href="../../../../org/apache/hadoop/hbase/Tag.html#getValueArray--"><code>Tag.getValueArray()</code></a> with appropriate <a href="../../../../org/apache/hadoop/hbase/Tag.html#getValueOffset--"><code>Tag.getValueOffset()</code></a> - and <a href="../../../../org/apache/hadoop/hbase/Tag.html#getValueLength--"><code>Tag.getValueLength()</code></a> instead to save on allocations.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>tag</code> - The Tag whose value to be returned</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>tag value in a new byte array.</dd> -</dl> -</li> -</ul> <a name="asList-byte:A-int-int-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>asList</h4> -<pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.74">asList</a>(byte[] b, +<pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.43">asList</a>(byte[] b, int offset, int length)</pre> <div class="block">Creates list of tags from given byte array, expected that it is in the expected tag format.</div> @@ -381,133 +283,13 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? </dl> </li> </ul> -<a name="asList-java.nio.ByteBuffer-int-int-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>asList</h4> -<pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.93">asList</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a> b, - int offset, - int length)</pre> -<div class="block">Creates list of tags from given ByteBuffer, expected that it is in the expected tag format.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>b</code> - The ByteBuffer</dd> -<dd><code>offset</code> - The offset in ByteBuffer where tag bytes begin</dd> -<dd><code>length</code> - Total length of all tags bytes</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>List of tags</dd> -</dl> -</li> -</ul> -<a name="fromList-java.util.List-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>fromList</h4> -<pre>public static byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.110">fromList</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> tags)</pre> -<div class="block">Write a list of tags into a byte array</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>tags</code> - The list of tags</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the serialized tag data as bytes</dd> -</dl> -</li> -</ul> -<a name="getValueAsLong-org.apache.hadoop.hbase.Tag-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getValueAsLong</h4> -<pre>public static long <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.141">getValueAsLong</a>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag)</pre> -<div class="block">Converts the value bytes of the given tag into a long value</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>tag</code> - The Tag</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>value as long</dd> -</dl> -</li> -</ul> -<a name="getValueAsByte-org.apache.hadoop.hbase.Tag-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getValueAsByte</h4> -<pre>public static byte <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.153">getValueAsByte</a>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag)</pre> -<div class="block">Converts the value bytes of the given tag into a byte value</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>tag</code> - The Tag</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>value as byte</dd> -</dl> -</li> -</ul> -<a name="getValueAsString-org.apache.hadoop.hbase.Tag-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getValueAsString</h4> -<pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.165">getValueAsString</a>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag)</pre> -<div class="block">Converts the value bytes of the given tag into a String value</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>tag</code> - The Tag</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>value as String</dd> -</dl> -</li> -</ul> -<a name="matchingValue-org.apache.hadoop.hbase.Tag-org.apache.hadoop.hbase.Tag-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>matchingValue</h4> -<pre>public static boolean <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.178">matchingValue</a>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> t1, - <a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> t2)</pre> -<div class="block">Matches the value part of given tags</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>t1</code> - Tag to match the value</dd> -<dd><code>t2</code> - Tag to match the value</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>True if values of both tags are same.</dd> -</dl> -</li> -</ul> -<a name="copyValueTo-org.apache.hadoop.hbase.Tag-byte:A-int-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>copyValueTo</h4> -<pre>public static void <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.201">copyValueTo</a>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag, - byte[] out, - int offset)</pre> -<div class="block">Copies the tag's value bytes to the given byte array</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>tag</code> - The Tag</dd> -<dd><code>out</code> - The byte array where to copy the Tag value.</dd> -<dd><code>offset</code> - The offset within 'out' array where to copy the Tag value.</dd> -</dl> -</li> -</ul> <a name="readVIntValuePart-org.apache.hadoop.hbase.Tag-int-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>readVIntValuePart</h4> -<pre>public static <a href="../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.217">readVIntValuePart</a>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag, +<pre>public static <a href="../../../../org/apache/hadoop/hbase/util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>,<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true" title="class or interface in java.lang">Integer</a>> <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.61">readVIntValuePart</a>(<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a> tag, int offset) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block">Reads an int value stored as a VInt at tag's given offset.</div> @@ -528,7 +310,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>carryForwardTags</h4> -<pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.227">carryForwardTags</a>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</pre> +<pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.71">carryForwardTags</a>(<a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>A List<Tag> of any Tags found in <code>cell</code> else null.</dd> @@ -541,7 +323,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>carryForwardTags</h4> -<pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.234">carryForwardTags</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> tagsOrNull, +<pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.78">carryForwardTags</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> tagsOrNull, <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</pre> <div class="block">Add to <code>tagsOrNull</code> any Tags <code>cell</code> is carrying or null if none.</div> </li> @@ -552,17 +334,17 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>concatTags</h4> -<pre>public static byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.250">concatTags</a>(byte[] tags, +<pre>public static byte[] <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.94">concatTags</a>(byte[] tags, <a href="../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> cell)</pre> </li> </ul> <a name="carryForwardTTLTag-java.util.List-long-"> <!-- --> </a> -<ul class="blockList"> +<ul class="blockListLast"> <li class="blockList"> <h4>carryForwardTTLTag</h4> -<pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.270">carryForwardTTLTag</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> tagsOrNull, +<pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.114">carryForwardTTLTag</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="interface in org.apache.hadoop.hbase">Tag</a>> tagsOrNull, long ttl)</pre> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -570,22 +352,6 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? </dl> </li> </ul> -<a name="checkForTagsLength-int-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>checkForTagsLength</h4> -<pre>public static void <a href="../../../../src-html/org/apache/hadoop/hbase/TagUtil.html#line.323">checkForTagsLength</a>(int tagsLength)</pre> -<div class="block">Check the length of tags. If it is invalid, throw IllegalArgumentException</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>tagsLength</code> - </dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if tagslength is invalid</dd> -</dl> -</li> -</ul> </li> </ul> </li> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/b1eb7453/devapidocs/org/apache/hadoop/hbase/backup/package-tree.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/backup/package-tree.html b/devapidocs/org/apache/hadoop/hbase/backup/package-tree.html index 6dce061..922f98e 100644 --- a/devapidocs/org/apache/hadoop/hbase/backup/package-tree.html +++ b/devapidocs/org/apache/hadoop/hbase/backup/package-tree.html @@ -167,10 +167,10 @@ <ul> <li type="circle">java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang"><span class="typeNameLink">Enum</span></a><E> (implements java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><T>, java.io.<a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>) <ul> -<li type="circle">org.apache.hadoop.hbase.backup.<a href="../../../../../org/apache/hadoop/hbase/backup/BackupType.html" title="enum in org.apache.hadoop.hbase.backup"><span class="typeNameLink">BackupType</span></a></li> <li type="circle">org.apache.hadoop.hbase.backup.<a href="../../../../../org/apache/hadoop/hbase/backup/BackupInfo.BackupState.html" title="enum in org.apache.hadoop.hbase.backup"><span class="typeNameLink">BackupInfo.BackupState</span></a></li> -<li type="circle">org.apache.hadoop.hbase.backup.<a href="../../../../../org/apache/hadoop/hbase/backup/BackupRestoreConstants.BackupCommand.html" title="enum in org.apache.hadoop.hbase.backup"><span class="typeNameLink">BackupRestoreConstants.BackupCommand</span></a></li> <li type="circle">org.apache.hadoop.hbase.backup.<a href="../../../../../org/apache/hadoop/hbase/backup/BackupInfo.BackupPhase.html" title="enum in org.apache.hadoop.hbase.backup"><span class="typeNameLink">BackupInfo.BackupPhase</span></a></li> +<li type="circle">org.apache.hadoop.hbase.backup.<a href="../../../../../org/apache/hadoop/hbase/backup/BackupType.html" title="enum in org.apache.hadoop.hbase.backup"><span class="typeNameLink">BackupType</span></a></li> +<li type="circle">org.apache.hadoop.hbase.backup.<a href="../../../../../org/apache/hadoop/hbase/backup/BackupRestoreConstants.BackupCommand.html" title="enum in org.apache.hadoop.hbase.backup"><span class="typeNameLink">BackupRestoreConstants.BackupCommand</span></a></li> </ul> </li> </ul>
