http://git-wip-us.apache.org/repos/asf/hbase-site/blob/b6a0cea2/1.2/apidocs/org/apache/hadoop/hbase/TableStateManager.html ---------------------------------------------------------------------- diff --git a/1.2/apidocs/org/apache/hadoop/hbase/TableStateManager.html b/1.2/apidocs/org/apache/hadoop/hbase/TableStateManager.html deleted file mode 100644 index 4c11e91..0000000 --- a/1.2/apidocs/org/apache/hadoop/hbase/TableStateManager.html +++ /dev/null @@ -1,454 +0,0 @@ -<!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 (1.8.0_101) on Mon Nov 14 17:17:28 PST 2016 --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>TableStateManager (Apache HBase 1.2.4 API)</title> -<meta name="date" content="2016-11-14"> -<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="TableStateManager (Apache HBase 1.2.4 API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/TableStateManager.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/TableNotFoundException.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/hadoop/hbase/Tag.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/TableStateManager.html" target="_top">Frames</a></li> -<li><a href="TableStateManager.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>Constr | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </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 TableStateManager" class="title">Interface TableStateManager</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Known Implementing Classes:</dt> -<dd><a href="../../../../org/apache/hadoop/hbase/zookeeper/ZKTableStateManager.html" title="class in org.apache.hadoop.hbase.zookeeper">ZKTableStateManager</a></dd> -</dl> -<hr> -<br> -<pre><a href="../../../../org/apache/hadoop/hbase/classification/InterfaceAudience.Private.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceAudience.Private</a> -public interface <span class="typeNameLabel">TableStateManager</span></pre> -<div class="block">Helper class for table state management for operations running inside - RegionServer or HMaster. - Depending on implementation, fetches information from HBase system table, - local data store, ZooKeeper ensemble or somewhere else. - Code running on client side (with no coordinated state context) shall instead use - <a href="../../../../org/apache/hadoop/hbase/zookeeper/ZKTableStateClientSideReader.html" title="class in org.apache.hadoop.hbase.zookeeper"><code>ZKTableStateClientSideReader</code></a></div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========== 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="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> -<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>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TableStateManager.html#checkAndRemoveTableState-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State-boolean-">checkAndRemoveTableState</a></span>(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, - <a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a> states, - boolean deletePermanentState)</code> -<div class="block">If the table is found in the given state the in-memory state is removed.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TableStateManager.html#getTablesInStates-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State...-">getTablesInStates</a></span>(<a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a>... states)</code> </td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TableStateManager.html#isTablePresent-org.apache.hadoop.hbase.TableName-">isTablePresent</a></span>(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code> -<div class="block">Checks if table is present.</div> -</td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TableStateManager.html#isTableState-org.apache.hadoop.hbase.TableName-boolean-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State...-">isTableState</a></span>(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, - boolean checkSource, - <a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a>... states)</code> </td> -</tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TableStateManager.html#isTableState-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State...-">isTableState</a></span>(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, - <a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a>... states)</code> </td> -</tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TableStateManager.html#setDeletedTable-org.apache.hadoop.hbase.TableName-">setDeletedTable</a></span>(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code> -<div class="block">Mark table as deleted.</div> -</td> -</tr> -<tr id="i6" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TableStateManager.html#setTableState-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State-">setTableState</a></span>(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, - <a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a> state)</code> -<div class="block">Sets the table into desired state.</div> -</td> -</tr> -<tr id="i7" class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TableStateManager.html#setTableStateIfInStates-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State...-">setTableStateIfInStates</a></span>(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, - <a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a> newState, - <a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a>... states)</code> -<div class="block">Sets the specified table into the newState, but only if the table is already in - one of the possibleCurrentStates (otherwise no operation is performed).</div> -</td> -</tr> -<tr id="i8" class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/TableStateManager.html#setTableStateIfNotInStates-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State...-">setTableStateIfNotInStates</a></span>(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, - <a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a> newState, - <a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a>... states)</code> -<div class="block">Sets the specified table into the newState, but only if the table is NOT in - one of the possibleCurrentStates (otherwise no operation is performed).</div> -</td> -</tr> -</table> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="setTableState-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setTableState</h4> -<pre>void setTableState(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, - <a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a> state) - throws <a href="../../../../org/apache/hadoop/hbase/CoordinatedStateException.html" title="class in org.apache.hadoop.hbase">CoordinatedStateException</a></pre> -<div class="block">Sets the table into desired state. Fails silently if the table is already in this state.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>tableName</code> - table to process</dd> -<dd><code>state</code> - new state of this table</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/hadoop/hbase/CoordinatedStateException.html" title="class in org.apache.hadoop.hbase">CoordinatedStateException</a></code> - if error happened when trying to set table state</dd> -</dl> -</li> -</ul> -<a name="setTableStateIfInStates-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State...-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setTableStateIfInStates</h4> -<pre>boolean setTableStateIfInStates(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, - <a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a> newState, - <a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a>... states) - throws <a href="../../../../org/apache/hadoop/hbase/CoordinatedStateException.html" title="class in org.apache.hadoop.hbase">CoordinatedStateException</a></pre> -<div class="block">Sets the specified table into the newState, but only if the table is already in - one of the possibleCurrentStates (otherwise no operation is performed).</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>tableName</code> - table to process</dd> -<dd><code>newState</code> - new state for the table</dd> -<dd><code>states</code> - table should be in one of these states for the operation - to be performed</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true if operation succeeded, false otherwise</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/hadoop/hbase/CoordinatedStateException.html" title="class in org.apache.hadoop.hbase">CoordinatedStateException</a></code> - if error happened while performing operation</dd> -</dl> -</li> -</ul> -<a name="setTableStateIfNotInStates-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State...-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setTableStateIfNotInStates</h4> -<pre>boolean setTableStateIfNotInStates(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, - <a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a> newState, - <a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a>... states) - throws <a href="../../../../org/apache/hadoop/hbase/CoordinatedStateException.html" title="class in org.apache.hadoop.hbase">CoordinatedStateException</a></pre> -<div class="block">Sets the specified table into the newState, but only if the table is NOT in - one of the possibleCurrentStates (otherwise no operation is performed).</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>tableName</code> - table to process</dd> -<dd><code>newState</code> - new state for the table</dd> -<dd><code>states</code> - table should NOT be in one of these states for the operation - to be performed</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true if operation succeeded, false otherwise</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/hadoop/hbase/CoordinatedStateException.html" title="class in org.apache.hadoop.hbase">CoordinatedStateException</a></code> - if error happened while performing operation</dd> -</dl> -</li> -</ul> -<a name="isTableState-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State...-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>isTableState</h4> -<pre>boolean isTableState(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, - <a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a>... states)</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true if the table is in any one of the listed states, false otherwise.</dd> -</dl> -</li> -</ul> -<a name="isTableState-org.apache.hadoop.hbase.TableName-boolean-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State...-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>isTableState</h4> -<pre>boolean isTableState(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, - boolean checkSource, - <a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a>... states)</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true if the table is in any one of the listed states, false otherwise.</dd> -</dl> -</li> -</ul> -<a name="setDeletedTable-org.apache.hadoop.hbase.TableName-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setDeletedTable</h4> -<pre>void setDeletedTable(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName) - throws <a href="../../../../org/apache/hadoop/hbase/CoordinatedStateException.html" title="class in org.apache.hadoop.hbase">CoordinatedStateException</a></pre> -<div class="block">Mark table as deleted. Fails silently if the table is not currently marked as disabled.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>tableName</code> - table to be deleted</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/hadoop/hbase/CoordinatedStateException.html" title="class in org.apache.hadoop.hbase">CoordinatedStateException</a></code> - if error happened while performing operation</dd> -</dl> -</li> -</ul> -<a name="isTablePresent-org.apache.hadoop.hbase.TableName-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>isTablePresent</h4> -<pre>boolean isTablePresent(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</pre> -<div class="block">Checks if table is present.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>tableName</code> - table we're checking</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true if the table is present, false otherwise</dd> -</dl> -</li> -</ul> -<a name="getTablesInStates-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State...-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getTablesInStates</h4> -<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>> getTablesInStates(<a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a>... states) - throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InterruptedIOException.html?is-external=true"; title="class or interface in java.io">InterruptedIOException</a>, - <a href="../../../../org/apache/hadoop/hbase/CoordinatedStateException.html" title="class in org.apache.hadoop.hbase">CoordinatedStateException</a></pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>set of tables which are in any one of the listed states, empty Set if none</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InterruptedIOException.html?is-external=true"; title="class or interface in java.io">InterruptedIOException</a></code></dd> -<dd><code><a href="../../../../org/apache/hadoop/hbase/CoordinatedStateException.html" title="class in org.apache.hadoop.hbase">CoordinatedStateException</a></code></dd> -</dl> -</li> -</ul> -<a name="checkAndRemoveTableState-org.apache.hadoop.hbase.TableName-org.apache.hadoop.hbase.protobuf.generated.ZooKeeperProtos.Table.State-boolean-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>checkAndRemoveTableState</h4> -<pre>void checkAndRemoveTableState(<a href="../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName, - <a href="../../../../org/apache/hadoop/hbase/protobuf/generated/ZooKeeperProtos.Table.State.html" title="enum in org.apache.hadoop.hbase.protobuf.generated">ZooKeeperProtos.Table.State</a> states, - boolean deletePermanentState) - throws <a href="../../../../org/apache/hadoop/hbase/CoordinatedStateException.html" title="class in org.apache.hadoop.hbase">CoordinatedStateException</a></pre> -<div class="block">If the table is found in the given state the in-memory state is removed. This - helps in cases where CreateTable is to be retried by the client in case of - failures. If deletePermanentState is true - the flag kept permanently is - also reset.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>tableName</code> - table we're working on</dd> -<dd><code>states</code> - if table isn't in any one of these states, operation aborts</dd> -<dd><code>deletePermanentState</code> - if true, reset the permanent flag</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../../../org/apache/hadoop/hbase/CoordinatedStateException.html" title="class in org.apache.hadoop.hbase">CoordinatedStateException</a></code> - if error happened in underlying coordination engine</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/TableStateManager.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/TableNotFoundException.html" title="class in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/hadoop/hbase/Tag.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/TableStateManager.html" target="_top">Frames</a></li> -<li><a href="TableStateManager.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>Constr | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </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–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/b6a0cea2/1.2/apidocs/org/apache/hadoop/hbase/Tag.html ---------------------------------------------------------------------- diff --git a/1.2/apidocs/org/apache/hadoop/hbase/Tag.html b/1.2/apidocs/org/apache/hadoop/hbase/Tag.html deleted file mode 100644 index 81c987d..0000000 --- a/1.2/apidocs/org/apache/hadoop/hbase/Tag.html +++ /dev/null @@ -1,640 +0,0 @@ -<!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 (1.8.0_101) on Mon Nov 14 17:17:28 PST 2016 --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Tag (Apache HBase 1.2.4 API)</title> -<meta name="date" content="2016-11-14"> -<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="Tag (Apache HBase 1.2.4 API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":10,"i5":9,"i6":10,"i7":10,"i8":10,"i9":10}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/Tag.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/TableStateManager.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/hadoop/hbase/TagRewriteCell.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/Tag.html" target="_top">Frames</a></li> -<li><a href="Tag.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 Tag" class="title">Class Tag</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.Tag</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre><a href="../../../../org/apache/hadoop/hbase/classification/InterfaceAudience.Private.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceAudience.Private</a> - <a href="../../../../org/apache/hadoop/hbase/classification/InterfaceStability.Evolving.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceStability.Evolving</a> -public class <span class="typeNameLabel">Tag</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></pre> -<div class="block">Tags are part of cells and helps to add metadata about the KVs. - Metadata could be ACLs per cells, visibility labels, etc.</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/Tag.html#INFRASTRUCTURE_SIZE">INFRASTRUCTURE_SIZE</a></span></code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>static int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#MAX_TAG_LENGTH">MAX_TAG_LENGTH</a></span></code> </td> -</tr> -<tr class="altColor"> -<td class="colFirst"><code>static int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#TAG_LENGTH_SIZE">TAG_LENGTH_SIZE</a></span></code> </td> -</tr> -<tr class="rowColor"> -<td class="colFirst"><code>static int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#TYPE_LENGTH_SIZE">TYPE_LENGTH_SIZE</a></span></code> </td> -</tr> -</table> -</li> -</ul> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#Tag-byte:A-int-">Tag</a></span>(byte[] bytes, - int offset)</code> -<div class="block">Creates a Tag from the specified byte array and offset.</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#Tag-byte:A-int-int-">Tag</a></span>(byte[] bytes, - int offset, - int length)</code> -<div class="block">Creates a Tag from the specified byte array, starting at offset, and for length - <code>length</code>.</div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#Tag-byte-byte:A-">Tag</a></span>(byte tagType, - byte[] tag)</code> </td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#Tag-byte-java.lang.String-">Tag</a></span>(byte tagType, - <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> tag)</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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 <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="class in org.apache.hadoop.hbase">Tag</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#asList-byte:A-int-int-">asList</a></span>(byte[] b, - int offset, - int length)</code> -<div class="block">Creates the list of tags from the byte array b.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="class in org.apache.hadoop.hbase">Tag</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.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="i2" class="altColor"> -<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="class in org.apache.hadoop.hbase">Tag</a>></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#carryForwardTags-java.util.List-org.apache.hadoop.hbase.Cell-">carryForwardTags</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="class in org.apache.hadoop.hbase">Tag</a>> tagsOrNull, - <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"> -<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/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="class in org.apache.hadoop.hbase">Tag</a>> tags)</code> -<div class="block">Write a list of tags into a byte array</div> -</td> -</tr> -<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#getBuffer--">getBuffer</a></span>()</code> </td> -</tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code>static <a href="../../../../org/apache/hadoop/hbase/Tag.html" title="class in org.apache.hadoop.hbase">Tag</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#getTag-byte:A-int-int-byte-">getTag</a></span>(byte[] b, - int offset, - int length, - byte type)</code> -<div class="block">Retrieve the first tag from the tags byte array matching the passed in tag type</div> -</td> -</tr> -<tr id="i6" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#getTagLength--">getTagLength</a></span>()</code> </td> -</tr> -<tr id="i7" class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#getTagOffset--">getTagOffset</a></span>()</code> </td> -</tr> -<tr id="i8" class="altColor"> -<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="i9" class="rowColor"> -<td class="colFirst"><code>byte[]</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/hadoop/hbase/Tag.html#getValue--">getValue</a></span>()</code> -<div class="block">Returns tag value in a new byte array.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> -<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#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-int-"; 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="TYPE_LENGTH_SIZE"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>TYPE_LENGTH_SIZE</h4> -<pre>public static final int TYPE_LENGTH_SIZE</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> -</dl> -</li> -</ul> -<a name="TAG_LENGTH_SIZE"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>TAG_LENGTH_SIZE</h4> -<pre>public static final int TAG_LENGTH_SIZE</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> -</dl> -</li> -</ul> -<a name="INFRASTRUCTURE_SIZE"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>INFRASTRUCTURE_SIZE</h4> -<pre>public static final int INFRASTRUCTURE_SIZE</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> -</dl> -</li> -</ul> -<a name="MAX_TAG_LENGTH"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>MAX_TAG_LENGTH</h4> -<pre>public static final int MAX_TAG_LENGTH</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> -</li> -</ul> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="Tag-byte-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>Tag</h4> -<pre>public Tag(byte tagType, - <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> tag)</pre> -</li> -</ul> -<a name="Tag-byte-byte:A-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>Tag</h4> -<pre>public Tag(byte tagType, - byte[] tag)</pre> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>tagType</code> - </dd> -<dd><code>tag</code> - </dd> -</dl> -</li> -</ul> -<a name="Tag-byte:A-int-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>Tag</h4> -<pre>public Tag(byte[] bytes, - int offset)</pre> -<div class="block">Creates a Tag from the specified byte array and offset. Presumes - <code>bytes</code> content starting at <code>offset</code> is formatted as - a Tag blob. - The bytes to include the tag type, tag length and actual tag bytes.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>bytes</code> - byte array</dd> -<dd><code>offset</code> - offset to start of Tag</dd> -</dl> -</li> -</ul> -<a name="Tag-byte:A-int-int-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>Tag</h4> -<pre>public Tag(byte[] bytes, - int offset, - int length)</pre> -<div class="block">Creates a Tag from the specified byte array, starting at offset, and for length - <code>length</code>. Presumes <code>bytes</code> content starting at <code>offset</code> is - formatted as a Tag blob.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>bytes</code> - byte array</dd> -<dd><code>offset</code> - offset to start of the Tag</dd> -<dd><code>length</code> - length of the Tag</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="getBuffer--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getBuffer</h4> -<pre>public byte[] getBuffer()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The byte array backing this Tag.</dd> -</dl> -</li> -</ul> -<a name="getType--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getType</h4> -<pre>public byte getType()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the tag type</dd> -</dl> -</li> -</ul> -<a name="getTagLength--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getTagLength</h4> -<pre>public int getTagLength()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>Length of actual tag bytes within the backed buffer</dd> -</dl> -</li> -</ul> -<a name="getTagOffset--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getTagOffset</h4> -<pre>public int getTagOffset()</pre> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>Offset of actual tag bytes within the backed buffer</dd> -</dl> -</li> -</ul> -<a name="getValue--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getValue</h4> -<pre>public byte[] getValue()</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#getBuffer--"><code>getBuffer()</code></a> with appropriate <a href="../../../../org/apache/hadoop/hbase/Tag.html#getTagOffset--"><code>getTagOffset()</code></a> and <a href="../../../../org/apache/hadoop/hbase/Tag.html#getTagLength--"><code>getTagLength()</code></a> - instead to save on allocations.</div> -<dl> -<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/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="class in org.apache.hadoop.hbase">Tag</a>> asList(byte[] b, - int offset, - int length)</pre> -<div class="block">Creates the list of tags from the byte array b. Expected that b is in the - expected tag format</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>b</code> - </dd> -<dd><code>offset</code> - </dd> -<dd><code>length</code> - </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[] fromList(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="class in org.apache.hadoop.hbase">Tag</a>> tags)</pre> -<div class="block">Write a list of tags into a byte array</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>tags</code> - </dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the serialized tag data as bytes</dd> -</dl> -</li> -</ul> -<a name="getTag-byte:A-int-int-byte-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getTag</h4> -<pre>public static <a href="../../../../org/apache/hadoop/hbase/Tag.html" title="class in org.apache.hadoop.hbase">Tag</a> getTag(byte[] b, - int offset, - int length, - byte type)</pre> -<div class="block">Retrieve the first tag from the tags byte array matching the passed in tag type</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>b</code> - </dd> -<dd><code>offset</code> - </dd> -<dd><code>length</code> - </dd> -<dd><code>type</code> - </dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>null if there is no tag of the passed in tag type</dd> -</dl> -</li> -</ul> -<a name="carryForwardTags-org.apache.hadoop.hbase.Cell-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>carryForwardTags</h4> -<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="class in org.apache.hadoop.hbase">Tag</a>> carryForwardTags(<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> -</dl> -</li> -</ul> -<a name="carryForwardTags-java.util.List-org.apache.hadoop.hbase.Cell-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>carryForwardTags</h4> -<pre>public static <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="class in org.apache.hadoop.hbase">Tag</a>> carryForwardTags(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../org/apache/hadoop/hbase/Tag.html" title="class in org.apache.hadoop.hbase">Tag</a>> tagsOrNull, - <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>Add to <code>tagsOrNull</code> any Tags <code>cell</code> is carrying or null if - it is carrying no Tags AND the passed in <code>tagsOrNull</code> is null (else we return new - List<Tag> with Tags found).</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/Tag.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/TableStateManager.html" title="interface in org.apache.hadoop.hbase"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../../../org/apache/hadoop/hbase/TagRewriteCell.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/Tag.html" target="_top">Frames</a></li> -<li><a href="Tag.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>
