http://git-wip-us.apache.org/repos/asf/accumulo/blob/97bc584b/1.8/apidocs/org/apache/accumulo/core/client/ClientSideIteratorScanner.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/org/apache/accumulo/core/client/ClientSideIteratorScanner.html b/1.8/apidocs/org/apache/accumulo/core/client/ClientSideIteratorScanner.html new file mode 100644 index 0000000..53d9196 --- /dev/null +++ b/1.8/apidocs/org/apache/accumulo/core/client/ClientSideIteratorScanner.html @@ -0,0 +1,657 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Tue Sep 06 14:11:20 EDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ClientSideIteratorScanner (Apache Accumulo Project 1.8.0 API)</title> +<meta name="date" content="2016-09-06"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ClientSideIteratorScanner (Apache Accumulo Project 1.8.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ClientSideIteratorScanner.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/accumulo/core/client/ClientConfiguration.ClientProperty.html" title="enum in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html" title="class in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/ClientSideIteratorScanner.html" target="_top">Frames</a></li> +<li><a href="ClientSideIteratorScanner.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested_class_summary">Nested</a> | </li> +<li><a href="#fields_inherited_from_class_org.apache.accumulo.core.client.impl.ScannerOptions">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>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.accumulo.core.client</div> +<h2 title="Class ClientSideIteratorScanner" class="title">Class ClientSideIteratorScanner</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.accumulo.core.client.impl.ScannerOptions</li> +<li> +<ul class="inheritance"> +<li>org.apache.accumulo.core.client.ClientSideIteratorScanner</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true"; title="class or interface in java.lang">AutoCloseable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.Entry.html?is-external=true"; title="class or interface in java.util">Map.Entry</a><<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>>, <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ClientSideIteratorScanner</span> +extends org.apache.accumulo.core.client.impl.ScannerOptions +implements <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></pre> +<div class="block">A scanner that instantiates iterators on the client side instead of on the tablet server. This can be useful for testing iterators or in cases where you + don't want iterators affecting the performance of tablet servers.<br> + <br> + Suggested usage:<br> + <code>Scanner scanner = new ClientSideIteratorScanner(connector.createScanner(tableName, authorizations));</code><br> + <br> + Iterators added to this scanner will be run in the client JVM. Separate scan iterators can be run on the server side and client side by adding iterators to + the source scanner (which will execute server side) and to the client side scanner (which will execute client side).</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested_class_summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html" title="class in org.apache.accumulo.core.client">ClientSideIteratorScanner.ScannerTranslator</a></strong></code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>since 1.7.0 was never intended for public use. However this could have been used by anything extending this class.</i></div> +</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.accumulo.core.client.impl.ScannerOptions"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.accumulo.core.client.impl.ScannerOptions</h3> +<code>batchTimeOut, classLoaderContext, fetchedColumns, serverSideIteratorList, serverSideIteratorOptions, timeOut</code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#ClientSideIteratorScanner(org.apache.accumulo.core.client.Scanner)">ClientSideIteratorScanner</a></strong>(<a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a> scanner)</code> +<div class="block">Constructs a scanner that can execute client-side iterators.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#clearIteratorSamplerConfiguration()">clearIteratorSamplerConfiguration</a></strong>()</code> +<div class="block">Clear any iterator sampler configuration.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#disableIsolation()">disableIsolation</a></strong>()</code> +<div class="block">Disables row isolation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#enableIsolation()">enableIsolation</a></strong>()</code> +<div class="block">Enables row isolation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security">Authorizations</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#getAuthorizations()">getAuthorizations</a></strong>()</code> +<div class="block">Returns the authorizations that have been set on the scanner</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#getBatchSize()">getBatchSize</a></strong>()</code> +<div class="block">Returns the batch size (number of Key/Value pairs) that will be fetched at a time from a tablet server.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample">SamplerConfiguration</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#getIteratorSamplerConfiguration()">getIteratorSamplerConfiguration</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#getRange()">getRange</a></strong>()</code> +<div class="block">Returns the range of keys to scan over.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#getReadaheadThreshold()">getReadaheadThreshold</a></strong>()</code> +<div class="block">The number of batches of Key/Value pairs returned before the <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client"><code>Scanner</code></a> will begin to prefetch the next batch</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#getTimeOut()">getTimeOut</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util">Iterator</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.Entry.html?is-external=true"; title="class or interface in java.util">Map.Entry</a><<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#iterator()">iterator</a></strong>()</code> +<div class="block">Returns an iterator over an accumulo table.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#setBatchSize(int)">setBatchSize</a></strong>(int size)</code> +<div class="block">Sets the number of Key/Value pairs that will be fetched at a time from a tablet server.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#setIteratorSamplerConfiguration(org.apache.accumulo.core.client.sample.SamplerConfiguration)">setIteratorSamplerConfiguration</a></strong>(<a href="../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample">SamplerConfiguration</a> sc)</code> +<div class="block">This is provided for the case where no sampler configuration is set on the scanner, but there is a need to create iterator deep copies that have sampling + enabled.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#setRange(org.apache.accumulo.core.data.Range)">setRange</a></strong>(<a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a> range)</code> +<div class="block">Sets the range of keys to scan over.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#setReadaheadThreshold(long)">setReadaheadThreshold</a></strong>(long batches)</code> +<div class="block">Sets the number of batches of Key/Value pairs returned before the <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client"><code>Scanner</code></a> will begin to prefetch the next batch</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#setSource(org.apache.accumulo.core.client.Scanner)">setSource</a></strong>(<a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a> scanner)</code> +<div class="block">Sets the source Scanner.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.html#setTimeOut(int)">setTimeOut</a></strong>(int timeOut)</code> +<div class="block"><strong>Deprecated.</strong> </div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.accumulo.core.client.impl.ScannerOptions"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.accumulo.core.client.impl.ScannerOptions</h3> +<code>addScanIterator, clearClassLoaderContext, clearColumns, clearSamplerConfiguration, clearScanIterators, close, fetchColumn, fetchColumn, fetchColumnFamily, getBatchTimeout, getClassLoaderContext, getFetchedColumns, getSamplerConfiguration, getTimeout, removeScanIterator, setBatchTimeout, setClassLoaderContext, setOptions, setSamplerConfiguration, setTimeout, updateScanIteratorOption</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.accumulo.core.client.ScannerBase"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.accumulo.core.client.<a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></h3> +<code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#addScanIterator(org.apache.accumulo.core.client.IteratorSetting)">addScanIterator</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearClassLoaderContext()">clearClassLoaderContext</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearColumns()">clearColumns</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearSamplerConfiguration()">clearSamplerConfiguration</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#clearScanIterators()">clearScanIterators</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#close()">close</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#fetchColumn(org.apache.accumulo.core.client.IteratorSetting.Column)">fetchColumn</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#fetchColumn(org.ap ache.hadoop.io.Text,%20org.apache.hadoop.io.Text)">fetchColumn</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#fetchColumnFamily(org.apache.hadoop.io.Text)">fetchColumnFamily</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getBatchTimeout(java.util.concurrent.TimeUnit)">getBatchTimeout</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getClassLoaderContext()">getClassLoaderContext</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getSamplerConfiguration()">getSamplerConfiguration</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getTimeout(java.util.concurrent.TimeUnit)">getTimeout</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#removeScanIterator(java.lang.String)">removeScanIterator</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setBatchTimeout(long,%20java.util.concurrent.TimeUn it)">setBatchTimeout</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setClassLoaderContext(java.lang.String)">setClassLoaderContext</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setSamplerConfiguration(org.apache.accumulo.core.client.sample.SamplerConfiguration)">setSamplerConfiguration</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#setTimeout(long,%20java.util.concurrent.TimeUnit)">setTimeout</a>, <a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#updateScanIteratorOption(java.lang.String,%20java.lang.String,%20java.lang.String)">updateScanIteratorOption</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ClientSideIteratorScanner(org.apache.accumulo.core.client.Scanner)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ClientSideIteratorScanner</h4> +<pre>public ClientSideIteratorScanner(<a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a> scanner)</pre> +<div class="block">Constructs a scanner that can execute client-side iterators.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>scanner</code> - the source scanner</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="setSource(org.apache.accumulo.core.client.Scanner)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSource</h4> +<pre>public void setSource(<a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a> scanner)</pre> +<div class="block">Sets the source Scanner.</div> +</li> +</ul> +<a name="iterator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>iterator</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util">Iterator</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.Entry.html?is-external=true"; title="class or interface in java.util">Map.Entry</a><<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>> iterator()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#iterator()">ScannerBase</a></code></strong></div> +<div class="block">Returns an iterator over an accumulo table. This iterator uses the options that are currently set for its lifetime, so setting options will have no effect + on existing iterators. + + <p> + Keys returned by the iterator are not guaranteed to be in sorted order.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true#iterator()" title="class or interface in java.lang">iterator</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true"; title="class or interface in java.lang">Iterable</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.Entry.html?is-external=true"; title="class or interface in java.util">Map.Entry</a><<a href="../../../../../org/apache/accumulo/core/data/Key.html" title="class in org.apache.accumulo.core.data">Key</a>,<a href="../../../../../org/apache/accumulo/core/data/Value.html" title="class in org.apache.accumulo.core.data">Value</a>>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#iterator()">iterator</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>iterator</code> in class <code>org.apache.accumulo.core.client.impl.ScannerOptions</code></dd> +<dt><span class="strong">Returns:</span></dt><dd>an iterator over Key,Value pairs which meet the restrictions set on the scanner</dd></dl> +</li> +</ul> +<a name="getAuthorizations()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAuthorizations</h4> +<pre>public <a href="../../../../../org/apache/accumulo/core/security/Authorizations.html" title="class in org.apache.accumulo.core.security">Authorizations</a> getAuthorizations()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getAuthorizations()">ScannerBase</a></code></strong></div> +<div class="block">Returns the authorizations that have been set on the scanner</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html#getAuthorizations()">getAuthorizations</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/ScannerBase.html" title="interface in org.apache.accumulo.core.client">ScannerBase</a></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>getAuthorizations</code> in class <code>org.apache.accumulo.core.client.impl.ScannerOptions</code></dd> +<dt><span class="strong">Returns:</span></dt><dd>The authorizations set on the scanner instance</dd></dl> +</li> +</ul> +<a name="setTimeOut(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTimeOut</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public void setTimeOut(int timeOut)</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setTimeOut(int)">Scanner</a></code></strong></div> +<div class="block">This setting determines how long a scanner will automatically retry when a failure occurs. By default a scanner will retry forever.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setTimeOut(int)">setTimeOut</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>timeOut</code> - in seconds</dd></dl> +</li> +</ul> +<a name="getTimeOut()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTimeOut</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public int getTimeOut()</pre> +<div class="block"><span class="strong">Deprecated.</span> </div> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getTimeOut()">Scanner</a></code></strong></div> +<div class="block">Returns the setting for how long a scanner will automatically retry when a failure occurs.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getTimeOut()">getTimeOut</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the timeout configured for this scanner</dd></dl> +</li> +</ul> +<a name="setRange(org.apache.accumulo.core.data.Range)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRange</h4> +<pre>public void setRange(<a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a> range)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setRange(org.apache.accumulo.core.data.Range)">Scanner</a></code></strong></div> +<div class="block">Sets the range of keys to scan over.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setRange(org.apache.accumulo.core.data.Range)">setRange</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>range</code> - key range to begin and end scan</dd></dl> +</li> +</ul> +<a name="getRange()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRange</h4> +<pre>public <a href="../../../../../org/apache/accumulo/core/data/Range.html" title="class in org.apache.accumulo.core.data">Range</a> getRange()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getRange()">Scanner</a></code></strong></div> +<div class="block">Returns the range of keys to scan over.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getRange()">getRange</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the range configured for this scanner</dd></dl> +</li> +</ul> +<a name="setBatchSize(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBatchSize</h4> +<pre>public void setBatchSize(int size)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setBatchSize(int)">Scanner</a></code></strong></div> +<div class="block">Sets the number of Key/Value pairs that will be fetched at a time from a tablet server.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setBatchSize(int)">setBatchSize</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>size</code> - the number of Key/Value pairs to fetch per call to Accumulo</dd></dl> +</li> +</ul> +<a name="getBatchSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBatchSize</h4> +<pre>public int getBatchSize()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getBatchSize()">Scanner</a></code></strong></div> +<div class="block">Returns the batch size (number of Key/Value pairs) that will be fetched at a time from a tablet server.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getBatchSize()">getBatchSize</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the batch size configured for this scanner</dd></dl> +</li> +</ul> +<a name="enableIsolation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>enableIsolation</h4> +<pre>public void enableIsolation()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#enableIsolation()">Scanner</a></code></strong></div> +<div class="block">Enables row isolation. Writes that occur to a row after a scan of that row has begun will not be seen if this option is enabled.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#enableIsolation()">enableIsolation</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd> +</dl> +</li> +</ul> +<a name="disableIsolation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>disableIsolation</h4> +<pre>public void disableIsolation()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#disableIsolation()">Scanner</a></code></strong></div> +<div class="block">Disables row isolation. Writes that occur to a row after a scan of that row has begun may be seen if this option is enabled.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#disableIsolation()">disableIsolation</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd> +</dl> +</li> +</ul> +<a name="getReadaheadThreshold()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadaheadThreshold</h4> +<pre>public long getReadaheadThreshold()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getReadaheadThreshold()">Scanner</a></code></strong></div> +<div class="block">The number of batches of Key/Value pairs returned before the <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client"><code>Scanner</code></a> will begin to prefetch the next batch</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#getReadaheadThreshold()">getReadaheadThreshold</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>Number of batches before read-ahead begins</dd></dl> +</li> +</ul> +<a name="setReadaheadThreshold(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReadaheadThreshold</h4> +<pre>public void setReadaheadThreshold(long batches)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setReadaheadThreshold(long)">Scanner</a></code></strong></div> +<div class="block">Sets the number of batches of Key/Value pairs returned before the <a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client"><code>Scanner</code></a> will begin to prefetch the next batch</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html#setReadaheadThreshold(long)">setReadaheadThreshold</a></code> in interface <code><a href="../../../../../org/apache/accumulo/core/client/Scanner.html" title="interface in org.apache.accumulo.core.client">Scanner</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>batches</code> - Non-negative number of batches</dd></dl> +</li> +</ul> +<a name="setIteratorSamplerConfiguration(org.apache.accumulo.core.client.sample.SamplerConfiguration)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIteratorSamplerConfiguration</h4> +<pre>public void setIteratorSamplerConfiguration(<a href="../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample">SamplerConfiguration</a> sc)</pre> +<div class="block">This is provided for the case where no sampler configuration is set on the scanner, but there is a need to create iterator deep copies that have sampling + enabled. If sampler configuration is set on the scanner, then this method does not need to be called inorder to create deep copies with sampling. + + <p> + Setting this differently than the scanners sampler configuration may cause exceptions.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.8.0</dd></dl> +</li> +</ul> +<a name="clearIteratorSamplerConfiguration()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clearIteratorSamplerConfiguration</h4> +<pre>public void clearIteratorSamplerConfiguration()</pre> +<div class="block">Clear any iterator sampler configuration.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>1.8.0</dd></dl> +</li> +</ul> +<a name="getIteratorSamplerConfiguration()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getIteratorSamplerConfiguration</h4> +<pre>public <a href="../../../../../org/apache/accumulo/core/client/sample/SamplerConfiguration.html" title="class in org.apache.accumulo.core.client.sample">SamplerConfiguration</a> getIteratorSamplerConfiguration()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>currently set iterator sampler configuration.</dd><dt><span class="strong">Since:</span></dt> + <dd>1.8.0</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ClientSideIteratorScanner.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/accumulo/core/client/ClientConfiguration.ClientProperty.html" title="enum in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/ClientSideIteratorScanner.ScannerTranslator.html" title="class in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/ClientSideIteratorScanner.html" target="_top">Frames</a></li> +<li><a href="ClientSideIteratorScanner.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><a href="#nested_class_summary">Nested</a> | </li> +<li><a href="#fields_inherited_from_class_org.apache.accumulo.core.client.impl.ScannerOptions">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>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2011–2016 <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/accumulo/blob/97bc584b/1.8/apidocs/org/apache/accumulo/core/client/ConditionalWriter.Result.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/org/apache/accumulo/core/client/ConditionalWriter.Result.html b/1.8/apidocs/org/apache/accumulo/core/client/ConditionalWriter.Result.html new file mode 100644 index 0000000..bc30c52 --- /dev/null +++ b/1.8/apidocs/org/apache/accumulo/core/client/ConditionalWriter.Result.html @@ -0,0 +1,320 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Tue Sep 06 14:11:20 EDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ConditionalWriter.Result (Apache Accumulo Project 1.8.0 API)</title> +<meta name="date" content="2016-09-06"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ConditionalWriter.Result (Apache Accumulo Project 1.8.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ConditionalWriter.Result.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/accumulo/core/client/ConditionalWriter.html" title="interface in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/ConditionalWriter.Result.html" target="_top">Frames</a></li> +<li><a href="ConditionalWriter.Result.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.accumulo.core.client</div> +<h2 title="Class ConditionalWriter.Result" class="title">Class ConditionalWriter.Result</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.accumulo.core.client.ConditionalWriter.Result</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.html" title="interface in org.apache.accumulo.core.client">ConditionalWriter</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="strong">ConditionalWriter.Result</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> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Result.html#ConditionalWriter.Result(org.apache.accumulo.core.client.ConditionalWriter.Status,%20org.apache.accumulo.core.data.ConditionalMutation,%20java.lang.String)">ConditionalWriter.Result</a></strong>(<a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a> s, + <a href="../../../../../org/apache/accumulo/core/data/ConditionalMutation.html" title="class in org.apache.accumulo.core.data">ConditionalMutation</a> m, + <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> server)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Result.html#ConditionalWriter.Result(java.lang.Exception,%20org.apache.accumulo.core.data.ConditionalMutation,%20java.lang.String)">ConditionalWriter.Result</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a> e, + <a href="../../../../../org/apache/accumulo/core/data/ConditionalMutation.html" title="class in org.apache.accumulo.core.data">ConditionalMutation</a> cm, + <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> server)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/accumulo/core/data/ConditionalMutation.html" title="class in org.apache.accumulo.core.data">ConditionalMutation</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Result.html#getMutation()">getMutation</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Result.html#getStatus()">getStatus</a></strong>()</code> +<div class="block">If this method throws an exception, then its possible the mutation is still being actively processed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Result.html#getTabletServer()">getTabletServer</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ConditionalWriter.Result(org.apache.accumulo.core.client.ConditionalWriter.Status, org.apache.accumulo.core.data.ConditionalMutation, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ConditionalWriter.Result</h4> +<pre>public ConditionalWriter.Result(<a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a> s, + <a href="../../../../../org/apache/accumulo/core/data/ConditionalMutation.html" title="class in org.apache.accumulo.core.data">ConditionalMutation</a> m, + <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> server)</pre> +</li> +</ul> +<a name="ConditionalWriter.Result(java.lang.Exception, org.apache.accumulo.core.data.ConditionalMutation, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ConditionalWriter.Result</h4> +<pre>public ConditionalWriter.Result(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a> e, + <a href="../../../../../org/apache/accumulo/core/data/ConditionalMutation.html" title="class in org.apache.accumulo.core.data">ConditionalMutation</a> cm, + <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> server)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getStatus()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStatus</h4> +<pre>public <a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a> getStatus() + throws <a href="../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a>, + <a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></pre> +<div class="block">If this method throws an exception, then its possible the mutation is still being actively processed. Therefore if code chooses to continue after seeing + an exception it should take this into consideration.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>status of a conditional mutation</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/AccumuloException.html" title="class in org.apache.accumulo.core.client">AccumuloException</a></code></dd> +<dd><code><a href="../../../../../org/apache/accumulo/core/client/AccumuloSecurityException.html" title="class in org.apache.accumulo.core.client">AccumuloSecurityException</a></code></dd></dl> +</li> +</ul> +<a name="getMutation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMutation</h4> +<pre>public <a href="../../../../../org/apache/accumulo/core/data/ConditionalMutation.html" title="class in org.apache.accumulo.core.data">ConditionalMutation</a> getMutation()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>A copy of the mutation previously submitted by a user. The mutation will reference the same data, but the object may be different.</dd></dl> +</li> +</ul> +<a name="getTabletServer()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getTabletServer</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getTabletServer()</pre> +<dl><dt><span class="strong">Returns:</span></dt><dd>The server this mutation was sent to. Returns null if was not sent to a server.</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ConditionalWriter.Result.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/accumulo/core/client/ConditionalWriter.html" title="interface in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/ConditionalWriter.Result.html" target="_top">Frames</a></li> +<li><a href="ConditionalWriter.Result.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2011–2016 <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/accumulo/blob/97bc584b/1.8/apidocs/org/apache/accumulo/core/client/ConditionalWriter.Status.html ---------------------------------------------------------------------- diff --git a/1.8/apidocs/org/apache/accumulo/core/client/ConditionalWriter.Status.html b/1.8/apidocs/org/apache/accumulo/core/client/ConditionalWriter.Status.html new file mode 100644 index 0000000..7713384 --- /dev/null +++ b/1.8/apidocs/org/apache/accumulo/core/client/ConditionalWriter.Status.html @@ -0,0 +1,377 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_79) on Tue Sep 06 14:11:20 EDT 2016 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ConditionalWriter.Status (Apache Accumulo Project 1.8.0 API)</title> +<meta name="date" content="2016-09-06"> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ConditionalWriter.Status (Apache Accumulo Project 1.8.0 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ConditionalWriter.Status.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/accumulo/core/client/ConditionalWriter.Result.html" title="class in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriterConfig.html" title="class in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/ConditionalWriter.Status.html" target="_top">Frames</a></li> +<li><a href="ConditionalWriter.Status.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.accumulo.core.client</div> +<h2 title="Enum ConditionalWriter.Status" class="title">Enum ConditionalWriter.Status</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.accumulo.core.client.ConditionalWriter.Status</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><<a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a>></dd> +</dl> +<dl> +<dt>Enclosing interface:</dt> +<dd><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.html" title="interface in org.apache.accumulo.core.client">ConditionalWriter</a></dd> +</dl> +<hr> +<br> +<pre>public static enum <span class="strong">ConditionalWriter.Status</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a><<a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a>></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html#ACCEPTED">ACCEPTED</a></strong></code> +<div class="block">conditions were met and mutation was written</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html#INVISIBLE_VISIBILITY">INVISIBLE_VISIBILITY</a></strong></code> +<div class="block">A condition contained a column visibility that could never be seen</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html#REJECTED">REJECTED</a></strong></code> +<div class="block">conditions were not met and mutation was not written</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html#UNKNOWN">UNKNOWN</a></strong></code> +<div class="block">error occurred after mutation was sent to server, its unknown if the mutation was written.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html#VIOLATED">VIOLATED</a></strong></code> +<div class="block">mutation violated a constraint and was not written</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html#valueOf(java.lang.String)">valueOf</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/ api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,%20java.lang.String)" title="class or interface in java.lang">valueOf</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="ACCEPTED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ACCEPTED</h4> +<pre>public static final <a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a> ACCEPTED</pre> +<div class="block">conditions were met and mutation was written</div> +</li> +</ul> +<a name="REJECTED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>REJECTED</h4> +<pre>public static final <a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a> REJECTED</pre> +<div class="block">conditions were not met and mutation was not written</div> +</li> +</ul> +<a name="VIOLATED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>VIOLATED</h4> +<pre>public static final <a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a> VIOLATED</pre> +<div class="block">mutation violated a constraint and was not written</div> +</li> +</ul> +<a name="UNKNOWN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UNKNOWN</h4> +<pre>public static final <a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a> UNKNOWN</pre> +<div class="block">error occurred after mutation was sent to server, its unknown if the mutation was written. Although the status of the mutation is unknown, Accumulo + guarantees the mutation will not be written at a later point in time.</div> +</li> +</ul> +<a name="INVISIBLE_VISIBILITY"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>INVISIBLE_VISIBILITY</h4> +<pre>public static final <a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a> INVISIBLE_VISIBILITY</pre> +<div class="block">A condition contained a column visibility that could never be seen</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a>[] values()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (ConditionalWriter.Status c : ConditionalWriter.Status.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../../org/apache/accumulo/core/client/ConditionalWriter.Status.html" title="enum in org.apache.accumulo.core.client">ConditionalWriter.Status</a> valueOf(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true"; title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ConditionalWriter.Status.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/accumulo/core/client/ConditionalWriter.Result.html" title="class in org.apache.accumulo.core.client"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/accumulo/core/client/ConditionalWriterConfig.html" title="class in org.apache.accumulo.core.client"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/accumulo/core/client/ConditionalWriter.Status.html" target="_top">Frames</a></li> +<li><a href="ConditionalWriter.Status.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2011–2016 <a href="https://www.apache.org";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
