http://git-wip-us.apache.org/repos/asf/hbase-site/blob/9e2ced84/apidocs/org/apache/hadoop/hbase/filter/FilterList.Operator.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/filter/FilterList.Operator.html b/apidocs/org/apache/hadoop/hbase/filter/FilterList.Operator.html index d955b66..d2b30bb 100644 --- a/apidocs/org/apache/hadoop/hbase/filter/FilterList.Operator.html +++ b/apidocs/org/apache/hadoop/hbase/filter/FilterList.Operator.html @@ -123,7 +123,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>@InterfaceAudience.Public -public static enum <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.60">FilterList.Operator</a> +public static enum <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.57">FilterList.Operator</a> extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a>></pre> <div class="block">set operator</div> </li> @@ -216,7 +216,7 @@ the order they are declared.</div> <ul class="blockList"> <li class="blockList"> <h4>MUST_PASS_ALL</h4> -<pre>public static final <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.Operator.html#line.62">MUST_PASS_ALL</a></pre> +<pre>public static final <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.Operator.html#line.59">MUST_PASS_ALL</a></pre> <div class="block">!AND</div> </li> </ul> @@ -226,7 +226,7 @@ the order they are declared.</div> <ul class="blockListLast"> <li class="blockList"> <h4>MUST_PASS_ONE</h4> -<pre>public static final <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.Operator.html#line.64">MUST_PASS_ONE</a></pre> +<pre>public static final <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.Operator.html#line.61">MUST_PASS_ONE</a></pre> <div class="block">!OR</div> </li> </ul> @@ -244,7 +244,7 @@ the order they are declared.</div> <ul class="blockList"> <li class="blockList"> <h4>values</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a>[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.Operator.html#line.60">values</a>()</pre> +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a>[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.Operator.html#line.57">values</a>()</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: @@ -264,7 +264,7 @@ for (FilterList.Operator c : FilterList.Operator.values()) <ul class="blockListLast"> <li class="blockList"> <h4>valueOf</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.Operator.html#line.60">valueOf</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.Operator.html#line.57">valueOf</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> 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
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/9e2ced84/apidocs/org/apache/hadoop/hbase/filter/FilterList.html ---------------------------------------------------------------------- diff --git a/apidocs/org/apache/hadoop/hbase/filter/FilterList.html b/apidocs/org/apache/hadoop/hbase/filter/FilterList.html index 009323c..1ecbd43 100644 --- a/apidocs/org/apache/hadoop/hbase/filter/FilterList.html +++ b/apidocs/org/apache/hadoop/hbase/filter/FilterList.html @@ -120,7 +120,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>@InterfaceAudience.Public -public final class <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.57">FilterList</a> +public final class <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.54">FilterList</a> extends org.apache.hadoop.hbase.filter.FilterBase</pre> <div class="block">Implementation of <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a> that represents an ordered List of Filters which will be evaluated with a specified boolean operator <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html#MUST_PASS_ALL"><code>FilterList.Operator.MUST_PASS_ALL</code></a> @@ -405,63 +405,64 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <!-- --> </a> <h3>Constructor Detail</h3> -<a name="FilterList-org.apache.hadoop.hbase.filter.FilterList.Operator-java.util.List-"> +<a name="FilterList-java.util.List-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>FilterList</h4> -<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.97">FilterList</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> operator, - <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> rowFilters)</pre> -<div class="block">Constructor that takes a set of <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a>s and an operator.</div> +<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.87">FilterList</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> rowFilters)</pre> +<div class="block">Constructor that takes a set of <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a>s. The default operator + MUST_PASS_ALL is assumed. + All filters are cloned to internal list.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>operator</code> - Operator to process filter set with.</dd> -<dd><code>rowFilters</code> - Set of row filters.</dd> +<dd><code>rowFilters</code> - list of filters</dd> </dl> </li> </ul> -<a name="FilterList-java.util.List-"> +<a name="FilterList-org.apache.hadoop.hbase.filter.Filter...-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>FilterList</h4> -<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.109">FilterList</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> rowFilters)</pre> -<div class="block">Constructor that takes a set of <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a>s. The default operator MUST_PASS_ALL is assumed. - All filters are cloned to internal list.</div> +<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.97">FilterList</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>... rowFilters)</pre> +<div class="block">Constructor that takes a var arg number of <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a>s. The fefault operator + MUST_PASS_ALL is assumed.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>rowFilters</code> - list of filters</dd> +<dd><code>rowFilters</code> - </dd> </dl> </li> </ul> -<a name="FilterList-org.apache.hadoop.hbase.filter.Filter...-"> +<a name="FilterList-org.apache.hadoop.hbase.filter.FilterList.Operator-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>FilterList</h4> -<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.118">FilterList</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>... rowFilters)</pre> -<div class="block">Constructor that takes a var arg number of <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a>s. The default operator MUST_PASS_ALL - is assumed.</div> +<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.106">FilterList</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> operator)</pre> +<div class="block">Constructor that takes an operator.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>rowFilters</code> - </dd> +<dd><code>operator</code> - Operator to process filter set with.</dd> </dl> </li> </ul> -<a name="FilterList-org.apache.hadoop.hbase.filter.FilterList.Operator-"> +<a name="FilterList-org.apache.hadoop.hbase.filter.FilterList.Operator-java.util.List-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>FilterList</h4> -<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.126">FilterList</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> operator)</pre> -<div class="block">Constructor that takes an operator.</div> +<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.117">FilterList</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> operator, + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> rowFilters)</pre> +<div class="block">Constructor that takes a set of <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a>s and an operator.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>operator</code> - Operator to process filter set with.</dd> +<dd><code>rowFilters</code> - Set of row filters.</dd> </dl> </li> </ul> @@ -471,7 +472,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockListLast"> <li class="blockList"> <h4>FilterList</h4> -<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.135">FilterList</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> operator, +<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.128">FilterList</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> operator, <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>... rowFilters)</pre> <div class="block">Constructor that takes a var arg number of <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter"><code>Filter</code></a>s and an operator.</div> <dl> @@ -495,7 +496,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>getOperator</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.154">getOperator</a>()</pre> +<pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.Operator.html" title="enum in org.apache.hadoop.hbase.filter">FilterList.Operator</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.138">getOperator</a>()</pre> <div class="block">Get the operator.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -509,7 +510,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>getFilters</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.162">getFilters</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.147">getFilters</a>()</pre> <div class="block">Get the filters.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -523,7 +524,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>size</h4> -<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.166">size</a>()</pre> +<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.151">size</a>()</pre> </li> </ul> <a name="addFilter-java.util.List-"> @@ -532,7 +533,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>addFilter</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.186">addFilter</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> filters)</pre> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.184">addFilter</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a>> filters)</pre> </li> </ul> <a name="addFilter-org.apache.hadoop.hbase.filter.Filter-"> @@ -541,7 +542,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>addFilter</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.201">addFilter</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> filter)</pre> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.194">addFilter</a>(<a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html" title="class in org.apache.hadoop.hbase.filter">Filter</a> filter)</pre> <div class="block">Add a filter.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -555,7 +556,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>reset</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.206">reset</a>() +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.199">reset</a>() throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div> <div class="block">Filters that are purely stateless and do nothing in their reset() methods can inherit @@ -579,7 +580,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>filterRowKey</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.218">filterRowKey</a>(byte[] rowKey, +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.208">filterRowKey</a>(byte[] rowKey, int offset, int length) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> @@ -612,7 +613,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>filterRowKey</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.239">filterRowKey</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> firstRowCell) +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.232">filterRowKey</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> firstRowCell) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterRowKey-org.apache.hadoop.hbase.Cell-">Filter</a></code></span></div> <div class="block">Filters a row based on the row key. If this returns true, the entire row will be excluded. If @@ -640,7 +641,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>filterAllRemaining</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.260">filterAllRemaining</a>() +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.254">filterAllRemaining</a>() throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div> <div class="block">Filters that never filter all remaining can inherit this implementation that @@ -666,7 +667,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>transformCell</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.279">transformCell</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c) +<pre>public <a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.274">transformCell</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div> <div class="block">By default no transformation takes place @@ -699,7 +700,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>filterKeyValue</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter">Filter.ReturnCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.631">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c) +<pre>public <a href="../../../../../org/apache/hadoop/hbase/filter/Filter.ReturnCode.html" title="enum in org.apache.hadoop.hbase.filter">Filter.ReturnCode</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.288">filterKeyValue</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> c) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#filterKeyValue-org.apache.hadoop.hbase.Cell-">Filter</a></code></span></div> <div class="block">A way to filter based on the column family, column qualifier and/or the column value. Return @@ -736,7 +737,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>filterRowCells</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.651">filterRowCells</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>> cells) +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.385">filterRowCells</a>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a>> cells) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block">Filters that never filter by modifying the returned List of Cells can inherit this implementation that does nothing. @@ -764,7 +765,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>hasFilterRow</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.658">hasFilterRow</a>()</pre> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.393">hasFilterRow</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div> <div class="block">Fitlers that never filter by modifying the returned List of Cells can inherit this implementation that does nothing. @@ -785,7 +786,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>filterRow</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.668">filterRow</a>() +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.404">filterRow</a>() throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div> <div class="block">Filters that never filter by rows based on previously gathered state from @@ -814,7 +815,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>toByteArray</h4> -<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.690">toByteArray</a>() +<pre>public byte[] <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.427">toByteArray</a>() throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div> <div class="block">Return length 0 byte array for Filters that don't require special serialization</div> @@ -834,7 +835,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>parseFrom</h4> -<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html" title="class in org.apache.hadoop.hbase.filter">FilterList</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.705">parseFrom</a>(byte[] pbBytes) +<pre>public static <a href="../../../../../org/apache/hadoop/hbase/filter/FilterList.html" title="class in org.apache.hadoop.hbase.filter">FilterList</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.444">parseFrom</a>(byte[] pbBytes) throws org.apache.hadoop.hbase.exceptions.DeserializationException</pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -854,7 +855,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>getNextCellHint</h4> -<pre>public <a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.742">getNextCellHint</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell) +<pre>public <a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.482">getNextCellHint</a>(<a href="../../../../../org/apache/hadoop/hbase/Cell.html" title="interface in org.apache.hadoop.hbase">Cell</a> currentCell) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div> <div class="block">Filters that are not sure which key must be next seeked to, can inherit @@ -883,7 +884,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>isFamilyEssential</h4> -<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.785">isFamilyEssential</a>(byte[] name) +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.516">isFamilyEssential</a>(byte[] name) throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div> <div class="block">By default, we require all scan's column families to be present. Our @@ -910,7 +911,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>setReversed</h4> -<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.798">setReversed</a>(boolean reversed)</pre> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.530">setReversed</a>(boolean reversed)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/hadoop/hbase/filter/Filter.html#setReversed-boolean-">Filter</a></code></span></div> <div class="block">alter the reversed scan flag</div> <dl> @@ -927,7 +928,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockList"> <li class="blockList"> <h4>toString</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.806">toString</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.539">toString</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code>org.apache.hadoop.hbase.filter.FilterBase</code></span></div> <div class="block">Return filter's info for debugging and logging purpose.</div> <dl> @@ -942,7 +943,7 @@ extends org.apache.hadoop.hbase.filter.FilterBase</pre> <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> -<pre>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.810">toString</a>(int maxFilters)</pre> +<pre>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/filter/FilterList.html#line.543">toString</a>(int maxFilters)</pre> </li> </ul> </li> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/9e2ced84/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTableBase.html ---------------------------------------------------------------------- diff --git a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTableBase.html b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTableBase.html index 115beef..f5f24c5 100644 --- a/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTableBase.html +++ b/apidocs/src-html/org/apache/hadoop/hbase/client/AsyncTableBase.html @@ -199,247 +199,217 @@ <span class="sourceLineNo">191</span> }<a name="line.191"></a> <span class="sourceLineNo">192</span><a name="line.192"></a> <span class="sourceLineNo">193</span> /**<a name="line.193"></a> -<span class="sourceLineNo">194</span> * Atomically checks if a row/family/qualifier value equals to the expected value. If it does, it<a name="line.194"></a> -<span class="sourceLineNo">195</span> * adds the put. If the passed value is null, the check is for the lack of column (ie:<a name="line.195"></a> -<span class="sourceLineNo">196</span> * non-existence)<a name="line.196"></a> -<span class="sourceLineNo">197</span> * @param row to check<a name="line.197"></a> -<span class="sourceLineNo">198</span> * @param family column family to check<a name="line.198"></a> -<span class="sourceLineNo">199</span> * @param qualifier column qualifier to check<a name="line.199"></a> -<span class="sourceLineNo">200</span> * @param value the expected value<a name="line.200"></a> -<span class="sourceLineNo">201</span> * @param put data to put if check succeeds<a name="line.201"></a> -<span class="sourceLineNo">202</span> * @return true if the new put was executed, false otherwise. The return value will be wrapped by<a name="line.202"></a> -<span class="sourceLineNo">203</span> * a {@link CompletableFuture}.<a name="line.203"></a> -<span class="sourceLineNo">204</span> */<a name="line.204"></a> -<span class="sourceLineNo">205</span> default CompletableFuture<Boolean> checkAndPut(byte[] row, byte[] family, byte[] qualifier,<a name="line.205"></a> -<span class="sourceLineNo">206</span> byte[] value, Put put) {<a name="line.206"></a> -<span class="sourceLineNo">207</span> return checkAndPut(row, family, qualifier, CompareOperator.EQUAL, value, put);<a name="line.207"></a> -<span class="sourceLineNo">208</span> }<a name="line.208"></a> -<span class="sourceLineNo">209</span><a name="line.209"></a> -<span class="sourceLineNo">210</span> /**<a name="line.210"></a> -<span class="sourceLineNo">211</span> * Atomically checks if a row/family/qualifier value matches the expected value. If it does, it<a name="line.211"></a> -<span class="sourceLineNo">212</span> * adds the put. If the passed value is null, the check is for the lack of column (ie:<a name="line.212"></a> -<span class="sourceLineNo">213</span> * non-existence)<a name="line.213"></a> -<span class="sourceLineNo">214</span> * @param row to check<a name="line.214"></a> -<span class="sourceLineNo">215</span> * @param family column family to check<a name="line.215"></a> -<span class="sourceLineNo">216</span> * @param qualifier column qualifier to check<a name="line.216"></a> -<span class="sourceLineNo">217</span> * @param compareOp comparison operator to use<a name="line.217"></a> -<span class="sourceLineNo">218</span> * @param value the expected value<a name="line.218"></a> -<span class="sourceLineNo">219</span> * @param put data to put if check succeeds<a name="line.219"></a> -<span class="sourceLineNo">220</span> * @return true if the new put was executed, false otherwise. The return value will be wrapped by<a name="line.220"></a> -<span class="sourceLineNo">221</span> * a {@link CompletableFuture}.<a name="line.221"></a> -<span class="sourceLineNo">222</span> */<a name="line.222"></a> -<span class="sourceLineNo">223</span> CompletableFuture<Boolean> checkAndPut(byte[] row, byte[] family, byte[] qualifier,<a name="line.223"></a> -<span class="sourceLineNo">224</span> CompareOperator compareOp, byte[] value, Put put);<a name="line.224"></a> -<span class="sourceLineNo">225</span><a name="line.225"></a> -<span class="sourceLineNo">226</span> /**<a name="line.226"></a> -<span class="sourceLineNo">227</span> * Atomically checks if a row/family/qualifier value equals to the expected value. If it does, it<a name="line.227"></a> -<span class="sourceLineNo">228</span> * adds the delete. If the passed value is null, the check is for the lack of column (ie:<a name="line.228"></a> -<span class="sourceLineNo">229</span> * non-existence)<a name="line.229"></a> -<span class="sourceLineNo">230</span> * @param row to check<a name="line.230"></a> -<span class="sourceLineNo">231</span> * @param family column family to check<a name="line.231"></a> -<span class="sourceLineNo">232</span> * @param qualifier column qualifier to check<a name="line.232"></a> -<span class="sourceLineNo">233</span> * @param value the expected value<a name="line.233"></a> -<span class="sourceLineNo">234</span> * @param delete data to delete if check succeeds<a name="line.234"></a> -<span class="sourceLineNo">235</span> * @return true if the new delete was executed, false otherwise. The return value will be wrapped<a name="line.235"></a> -<span class="sourceLineNo">236</span> * by a {@link CompletableFuture}.<a name="line.236"></a> -<span class="sourceLineNo">237</span> */<a name="line.237"></a> -<span class="sourceLineNo">238</span> default CompletableFuture<Boolean> checkAndDelete(byte[] row, byte[] family, byte[] qualifier,<a name="line.238"></a> -<span class="sourceLineNo">239</span> byte[] value, Delete delete) {<a name="line.239"></a> -<span class="sourceLineNo">240</span> return checkAndDelete(row, family, qualifier, CompareOperator.EQUAL, value, delete);<a name="line.240"></a> -<span class="sourceLineNo">241</span> }<a name="line.241"></a> -<span class="sourceLineNo">242</span><a name="line.242"></a> -<span class="sourceLineNo">243</span> /**<a name="line.243"></a> -<span class="sourceLineNo">244</span> * Atomically checks if a row/family/qualifier value matches the expected value. If it does, it<a name="line.244"></a> -<span class="sourceLineNo">245</span> * adds the delete. If the passed value is null, the check is for the lack of column (ie:<a name="line.245"></a> -<span class="sourceLineNo">246</span> * non-existence)<a name="line.246"></a> -<span class="sourceLineNo">247</span> * @param row to check<a name="line.247"></a> -<span class="sourceLineNo">248</span> * @param family column family to check<a name="line.248"></a> -<span class="sourceLineNo">249</span> * @param qualifier column qualifier to check<a name="line.249"></a> -<span class="sourceLineNo">250</span> * @param compareOp comparison operator to use<a name="line.250"></a> -<span class="sourceLineNo">251</span> * @param value the expected value<a name="line.251"></a> -<span class="sourceLineNo">252</span> * @param delete data to delete if check succeeds<a name="line.252"></a> -<span class="sourceLineNo">253</span> * @return true if the new delete was executed, false otherwise. The return value will be wrapped<a name="line.253"></a> -<span class="sourceLineNo">254</span> * by a {@link CompletableFuture}.<a name="line.254"></a> -<span class="sourceLineNo">255</span> */<a name="line.255"></a> -<span class="sourceLineNo">256</span> CompletableFuture<Boolean> checkAndDelete(byte[] row, byte[] family, byte[] qualifier,<a name="line.256"></a> -<span class="sourceLineNo">257</span> CompareOperator compareOp, byte[] value, Delete delete);<a name="line.257"></a> -<span class="sourceLineNo">258</span><a name="line.258"></a> -<span class="sourceLineNo">259</span> /**<a name="line.259"></a> -<span class="sourceLineNo">260</span> * Performs multiple mutations atomically on a single row. Currently {@link Put} and<a name="line.260"></a> -<span class="sourceLineNo">261</span> * {@link Delete} are supported.<a name="line.261"></a> -<span class="sourceLineNo">262</span> * @param mutation object that specifies the set of mutations to perform atomically<a name="line.262"></a> -<span class="sourceLineNo">263</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.263"></a> -<span class="sourceLineNo">264</span> */<a name="line.264"></a> -<span class="sourceLineNo">265</span> CompletableFuture<Void> mutateRow(RowMutations mutation);<a name="line.265"></a> -<span class="sourceLineNo">266</span><a name="line.266"></a> -<span class="sourceLineNo">267</span> /**<a name="line.267"></a> -<span class="sourceLineNo">268</span> * Atomically checks if a row/family/qualifier value equals to the expected value. If it does, it<a name="line.268"></a> -<span class="sourceLineNo">269</span> * performs the row mutations. If the passed value is null, the check is for the lack of column<a name="line.269"></a> -<span class="sourceLineNo">270</span> * (ie: non-existence)<a name="line.270"></a> -<span class="sourceLineNo">271</span> * @param row to check<a name="line.271"></a> -<span class="sourceLineNo">272</span> * @param family column family to check<a name="line.272"></a> -<span class="sourceLineNo">273</span> * @param qualifier column qualifier to check<a name="line.273"></a> -<span class="sourceLineNo">274</span> * @param value the expected value<a name="line.274"></a> -<span class="sourceLineNo">275</span> * @param mutation mutations to perform if check succeeds<a name="line.275"></a> -<span class="sourceLineNo">276</span> * @return true if the new put was executed, false otherwise. The return value will be wrapped by<a name="line.276"></a> -<span class="sourceLineNo">277</span> * a {@link CompletableFuture}.<a name="line.277"></a> -<span class="sourceLineNo">278</span> */<a name="line.278"></a> -<span class="sourceLineNo">279</span> default CompletableFuture<Boolean> checkAndMutate(byte[] row, byte[] family, byte[] qualifier,<a name="line.279"></a> -<span class="sourceLineNo">280</span> byte[] value, RowMutations mutation) {<a name="line.280"></a> -<span class="sourceLineNo">281</span> return checkAndMutate(row, family, qualifier, CompareOperator.EQUAL, value, mutation);<a name="line.281"></a> -<span class="sourceLineNo">282</span> }<a name="line.282"></a> -<span class="sourceLineNo">283</span><a name="line.283"></a> -<span class="sourceLineNo">284</span> /**<a name="line.284"></a> -<span class="sourceLineNo">285</span> * Atomically checks if a row/family/qualifier value matches the expected value. If it does, it<a name="line.285"></a> -<span class="sourceLineNo">286</span> * performs the row mutations. If the passed value is null, the check is for the lack of column<a name="line.286"></a> -<span class="sourceLineNo">287</span> * (ie: non-existence)<a name="line.287"></a> -<span class="sourceLineNo">288</span> * @param row to check<a name="line.288"></a> -<span class="sourceLineNo">289</span> * @param family column family to check<a name="line.289"></a> -<span class="sourceLineNo">290</span> * @param qualifier column qualifier to check<a name="line.290"></a> -<span class="sourceLineNo">291</span> * @param compareOp the comparison operator<a name="line.291"></a> -<span class="sourceLineNo">292</span> * @param value the expected value<a name="line.292"></a> -<span class="sourceLineNo">293</span> * @param mutation mutations to perform if check succeeds<a name="line.293"></a> -<span class="sourceLineNo">294</span> * @return true if the new put was executed, false otherwise. The return value will be wrapped by<a name="line.294"></a> -<span class="sourceLineNo">295</span> * a {@link CompletableFuture}.<a name="line.295"></a> -<span class="sourceLineNo">296</span> */<a name="line.296"></a> -<span class="sourceLineNo">297</span> CompletableFuture<Boolean> checkAndMutate(byte[] row, byte[] family, byte[] qualifier,<a name="line.297"></a> -<span class="sourceLineNo">298</span> CompareOperator compareOp, byte[] value, RowMutations mutation);<a name="line.298"></a> -<span class="sourceLineNo">299</span><a name="line.299"></a> -<span class="sourceLineNo">300</span> /**<a name="line.300"></a> -<span class="sourceLineNo">301</span> * Return all the results that match the given scan object.<a name="line.301"></a> -<span class="sourceLineNo">302</span> * <p><a name="line.302"></a> -<span class="sourceLineNo">303</span> * Notice that usually you should use this method with a {@link Scan} object that has limit set.<a name="line.303"></a> -<span class="sourceLineNo">304</span> * For example, if you want to get the closest row after a given row, you could do this:<a name="line.304"></a> -<span class="sourceLineNo">305</span> * <p><a name="line.305"></a> -<span class="sourceLineNo">306</span> *<a name="line.306"></a> -<span class="sourceLineNo">307</span> * <pre><a name="line.307"></a> -<span class="sourceLineNo">308</span> * <code><a name="line.308"></a> -<span class="sourceLineNo">309</span> * table.scanAll(new Scan().withStartRow(row, false).setLimit(1)).thenAccept(results -> {<a name="line.309"></a> -<span class="sourceLineNo">310</span> * if (results.isEmpty()) {<a name="line.310"></a> -<span class="sourceLineNo">311</span> * System.out.println("No row after " + Bytes.toStringBinary(row));<a name="line.311"></a> -<span class="sourceLineNo">312</span> * } else {<a name="line.312"></a> -<span class="sourceLineNo">313</span> * System.out.println("The closest row after " + Bytes.toStringBinary(row) + " is "<a name="line.313"></a> -<span class="sourceLineNo">314</span> * + Bytes.toStringBinary(results.stream().findFirst().get().getRow()));<a name="line.314"></a> -<span class="sourceLineNo">315</span> * }<a name="line.315"></a> -<span class="sourceLineNo">316</span> * });<a name="line.316"></a> -<span class="sourceLineNo">317</span> * </code><a name="line.317"></a> -<span class="sourceLineNo">318</span> * </pre><a name="line.318"></a> -<span class="sourceLineNo">319</span> * <p><a name="line.319"></a> -<span class="sourceLineNo">320</span> * If your result set is very large, you should use other scan method to get a scanner or use<a name="line.320"></a> -<span class="sourceLineNo">321</span> * callback to process the results. They will do chunking to prevent OOM. The scanAll method will<a name="line.321"></a> -<span class="sourceLineNo">322</span> * fetch all the results and store them in a List and then return the list to you.<a name="line.322"></a> -<span class="sourceLineNo">323</span> * <p><a name="line.323"></a> -<span class="sourceLineNo">324</span> * The scan metrics will be collected background if you enable it but you have no way to get it.<a name="line.324"></a> -<span class="sourceLineNo">325</span> * Usually you can get scan metrics from {@code ResultScanner}, or through<a name="line.325"></a> -<span class="sourceLineNo">326</span> * {@code ScanResultConsumer.onScanMetricsCreated} but this method only returns a list of results.<a name="line.326"></a> -<span class="sourceLineNo">327</span> * So if you really care about scan metrics then you'd better use other scan methods which return<a name="line.327"></a> -<span class="sourceLineNo">328</span> * a {@code ResultScanner} or let you pass in a {@code ScanResultConsumer}. There is no<a name="line.328"></a> -<span class="sourceLineNo">329</span> * performance difference between these scan methods so do not worry.<a name="line.329"></a> -<span class="sourceLineNo">330</span> * @param scan A configured {@link Scan} object. So if you use this method to fetch a really large<a name="line.330"></a> -<span class="sourceLineNo">331</span> * result set, it is likely to cause OOM.<a name="line.331"></a> -<span class="sourceLineNo">332</span> * @return The results of this small scan operation. The return value will be wrapped by a<a name="line.332"></a> -<span class="sourceLineNo">333</span> * {@link CompletableFuture}.<a name="line.333"></a> -<span class="sourceLineNo">334</span> */<a name="line.334"></a> -<span class="sourceLineNo">335</span> CompletableFuture<List<Result>> scanAll(Scan scan);<a name="line.335"></a> -<span class="sourceLineNo">336</span><a name="line.336"></a> -<span class="sourceLineNo">337</span> /**<a name="line.337"></a> -<span class="sourceLineNo">338</span> * Test for the existence of columns in the table, as specified by the Gets.<a name="line.338"></a> -<span class="sourceLineNo">339</span> * <p><a name="line.339"></a> -<span class="sourceLineNo">340</span> * This will return a list of booleans. Each value will be true if the related Get matches one or<a name="line.340"></a> -<span class="sourceLineNo">341</span> * more keys, false if not.<a name="line.341"></a> -<span class="sourceLineNo">342</span> * <p><a name="line.342"></a> -<span class="sourceLineNo">343</span> * This is a server-side call so it prevents any data from being transferred to the client.<a name="line.343"></a> -<span class="sourceLineNo">344</span> * @param gets the Gets<a name="line.344"></a> -<span class="sourceLineNo">345</span> * @return A list of {@link CompletableFuture}s that represent the existence for each get.<a name="line.345"></a> -<span class="sourceLineNo">346</span> */<a name="line.346"></a> -<span class="sourceLineNo">347</span> default List<CompletableFuture<Boolean>> exists(List<Get> gets) {<a name="line.347"></a> -<span class="sourceLineNo">348</span> return get(toCheckExistenceOnly(gets)).stream()<a name="line.348"></a> -<span class="sourceLineNo">349</span> .<CompletableFuture<Boolean>> map(f -> f.thenApply(r -> r.getExists())).collect(toList());<a name="line.349"></a> -<span class="sourceLineNo">350</span> }<a name="line.350"></a> -<span class="sourceLineNo">351</span><a name="line.351"></a> -<span class="sourceLineNo">352</span> /**<a name="line.352"></a> -<span class="sourceLineNo">353</span> * A simple version for batch exists. It will fail if there are any failures and you will get the<a name="line.353"></a> -<span class="sourceLineNo">354</span> * whole result boolean list at once if the operation is succeeded.<a name="line.354"></a> -<span class="sourceLineNo">355</span> * @param gets the Gets<a name="line.355"></a> -<span class="sourceLineNo">356</span> * @return A {@link CompletableFuture} that wrapper the result boolean list.<a name="line.356"></a> +<span class="sourceLineNo">194</span> * Atomically checks if a row/family/qualifier value matches the expected value. If it does, it<a name="line.194"></a> +<span class="sourceLineNo">195</span> * adds the Put/Delete/RowMutations.<a name="line.195"></a> +<span class="sourceLineNo">196</span> * <p><a name="line.196"></a> +<span class="sourceLineNo">197</span> * Use the returned {@link CheckAndMutateBuilder} to construct your request and then execute it.<a name="line.197"></a> +<span class="sourceLineNo">198</span> * This is a fluent style API, the code is like:<a name="line.198"></a> +<span class="sourceLineNo">199</span> *<a name="line.199"></a> +<span class="sourceLineNo">200</span> * <pre><a name="line.200"></a> +<span class="sourceLineNo">201</span> * <code><a name="line.201"></a> +<span class="sourceLineNo">202</span> * table.checkAndMutate(row, family).qualifier(qualifier).ifNotExists().thenPut(put)<a name="line.202"></a> +<span class="sourceLineNo">203</span> * .thenAccept(succ -> {<a name="line.203"></a> +<span class="sourceLineNo">204</span> * if (succ) {<a name="line.204"></a> +<span class="sourceLineNo">205</span> * System.out.println("Check and put succeeded");<a name="line.205"></a> +<span class="sourceLineNo">206</span> * } else {<a name="line.206"></a> +<span class="sourceLineNo">207</span> * System.out.println("Check and put failed");<a name="line.207"></a> +<span class="sourceLineNo">208</span> * }<a name="line.208"></a> +<span class="sourceLineNo">209</span> * });<a name="line.209"></a> +<span class="sourceLineNo">210</span> * </code><a name="line.210"></a> +<span class="sourceLineNo">211</span> * </pre><a name="line.211"></a> +<span class="sourceLineNo">212</span> */<a name="line.212"></a> +<span class="sourceLineNo">213</span> CheckAndMutateBuilder checkAndMutate(byte[] row, byte[] family);<a name="line.213"></a> +<span class="sourceLineNo">214</span><a name="line.214"></a> +<span class="sourceLineNo">215</span> /**<a name="line.215"></a> +<span class="sourceLineNo">216</span> * A helper class for sending checkAndMutate request.<a name="line.216"></a> +<span class="sourceLineNo">217</span> */<a name="line.217"></a> +<span class="sourceLineNo">218</span> interface CheckAndMutateBuilder {<a name="line.218"></a> +<span class="sourceLineNo">219</span><a name="line.219"></a> +<span class="sourceLineNo">220</span> /**<a name="line.220"></a> +<span class="sourceLineNo">221</span> * @param qualifier column qualifier to check.<a name="line.221"></a> +<span class="sourceLineNo">222</span> */<a name="line.222"></a> +<span class="sourceLineNo">223</span> CheckAndMutateBuilder qualifier(byte[] qualifier);<a name="line.223"></a> +<span class="sourceLineNo">224</span><a name="line.224"></a> +<span class="sourceLineNo">225</span> /**<a name="line.225"></a> +<span class="sourceLineNo">226</span> * Check for lack of column.<a name="line.226"></a> +<span class="sourceLineNo">227</span> */<a name="line.227"></a> +<span class="sourceLineNo">228</span> CheckAndMutateBuilder ifNotExists();<a name="line.228"></a> +<span class="sourceLineNo">229</span><a name="line.229"></a> +<span class="sourceLineNo">230</span> default CheckAndMutateBuilder ifEquals(byte[] value) {<a name="line.230"></a> +<span class="sourceLineNo">231</span> return ifMatches(CompareOperator.EQUAL, value);<a name="line.231"></a> +<span class="sourceLineNo">232</span> }<a name="line.232"></a> +<span class="sourceLineNo">233</span><a name="line.233"></a> +<span class="sourceLineNo">234</span> /**<a name="line.234"></a> +<span class="sourceLineNo">235</span> * @param compareOp comparison operator to use<a name="line.235"></a> +<span class="sourceLineNo">236</span> * @param value the expected value<a name="line.236"></a> +<span class="sourceLineNo">237</span> */<a name="line.237"></a> +<span class="sourceLineNo">238</span> CheckAndMutateBuilder ifMatches(CompareOperator compareOp, byte[] value);<a name="line.238"></a> +<span class="sourceLineNo">239</span><a name="line.239"></a> +<span class="sourceLineNo">240</span> /**<a name="line.240"></a> +<span class="sourceLineNo">241</span> * @param put data to put if check succeeds<a name="line.241"></a> +<span class="sourceLineNo">242</span> * @return {@code true} if the new put was executed, {@code false} otherwise. The return value<a name="line.242"></a> +<span class="sourceLineNo">243</span> * will be wrapped by a {@link CompletableFuture}.<a name="line.243"></a> +<span class="sourceLineNo">244</span> */<a name="line.244"></a> +<span class="sourceLineNo">245</span> CompletableFuture<Boolean> thenPut(Put put);<a name="line.245"></a> +<span class="sourceLineNo">246</span><a name="line.246"></a> +<span class="sourceLineNo">247</span> /**<a name="line.247"></a> +<span class="sourceLineNo">248</span> * @param delete data to delete if check succeeds<a name="line.248"></a> +<span class="sourceLineNo">249</span> * @return {@code true} if the new delete was executed, {@code false} otherwise. The return<a name="line.249"></a> +<span class="sourceLineNo">250</span> * value will be wrapped by a {@link CompletableFuture}.<a name="line.250"></a> +<span class="sourceLineNo">251</span> */<a name="line.251"></a> +<span class="sourceLineNo">252</span> CompletableFuture<Boolean> thenDelete(Delete delete);<a name="line.252"></a> +<span class="sourceLineNo">253</span><a name="line.253"></a> +<span class="sourceLineNo">254</span> /**<a name="line.254"></a> +<span class="sourceLineNo">255</span> * @param mutation mutations to perform if check succeeds<a name="line.255"></a> +<span class="sourceLineNo">256</span> * @return true if the new mutation was executed, false otherwise. The return value will be<a name="line.256"></a> +<span class="sourceLineNo">257</span> * wrapped by a {@link CompletableFuture}.<a name="line.257"></a> +<span class="sourceLineNo">258</span> */<a name="line.258"></a> +<span class="sourceLineNo">259</span> CompletableFuture<Boolean> thenMutate(RowMutations mutation);<a name="line.259"></a> +<span class="sourceLineNo">260</span> }<a name="line.260"></a> +<span class="sourceLineNo">261</span><a name="line.261"></a> +<span class="sourceLineNo">262</span> /**<a name="line.262"></a> +<span class="sourceLineNo">263</span> * Performs multiple mutations atomically on a single row. Currently {@link Put} and<a name="line.263"></a> +<span class="sourceLineNo">264</span> * {@link Delete} are supported.<a name="line.264"></a> +<span class="sourceLineNo">265</span> * @param mutation object that specifies the set of mutations to perform atomically<a name="line.265"></a> +<span class="sourceLineNo">266</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.266"></a> +<span class="sourceLineNo">267</span> */<a name="line.267"></a> +<span class="sourceLineNo">268</span> CompletableFuture<Void> mutateRow(RowMutations mutation);<a name="line.268"></a> +<span class="sourceLineNo">269</span><a name="line.269"></a> +<span class="sourceLineNo">270</span> /**<a name="line.270"></a> +<span class="sourceLineNo">271</span> * Return all the results that match the given scan object.<a name="line.271"></a> +<span class="sourceLineNo">272</span> * <p><a name="line.272"></a> +<span class="sourceLineNo">273</span> * Notice that usually you should use this method with a {@link Scan} object that has limit set.<a name="line.273"></a> +<span class="sourceLineNo">274</span> * For example, if you want to get the closest row after a given row, you could do this:<a name="line.274"></a> +<span class="sourceLineNo">275</span> * <p><a name="line.275"></a> +<span class="sourceLineNo">276</span> *<a name="line.276"></a> +<span class="sourceLineNo">277</span> * <pre><a name="line.277"></a> +<span class="sourceLineNo">278</span> * <code><a name="line.278"></a> +<span class="sourceLineNo">279</span> * table.scanAll(new Scan().withStartRow(row, false).setLimit(1)).thenAccept(results -> {<a name="line.279"></a> +<span class="sourceLineNo">280</span> * if (results.isEmpty()) {<a name="line.280"></a> +<span class="sourceLineNo">281</span> * System.out.println("No row after " + Bytes.toStringBinary(row));<a name="line.281"></a> +<span class="sourceLineNo">282</span> * } else {<a name="line.282"></a> +<span class="sourceLineNo">283</span> * System.out.println("The closest row after " + Bytes.toStringBinary(row) + " is "<a name="line.283"></a> +<span class="sourceLineNo">284</span> * + Bytes.toStringBinary(results.stream().findFirst().get().getRow()));<a name="line.284"></a> +<span class="sourceLineNo">285</span> * }<a name="line.285"></a> +<span class="sourceLineNo">286</span> * });<a name="line.286"></a> +<span class="sourceLineNo">287</span> * </code><a name="line.287"></a> +<span class="sourceLineNo">288</span> * </pre><a name="line.288"></a> +<span class="sourceLineNo">289</span> * <p><a name="line.289"></a> +<span class="sourceLineNo">290</span> * If your result set is very large, you should use other scan method to get a scanner or use<a name="line.290"></a> +<span class="sourceLineNo">291</span> * callback to process the results. They will do chunking to prevent OOM. The scanAll method will<a name="line.291"></a> +<span class="sourceLineNo">292</span> * fetch all the results and store them in a List and then return the list to you.<a name="line.292"></a> +<span class="sourceLineNo">293</span> * <p><a name="line.293"></a> +<span class="sourceLineNo">294</span> * The scan metrics will be collected background if you enable it but you have no way to get it.<a name="line.294"></a> +<span class="sourceLineNo">295</span> * Usually you can get scan metrics from {@code ResultScanner}, or through<a name="line.295"></a> +<span class="sourceLineNo">296</span> * {@code ScanResultConsumer.onScanMetricsCreated} but this method only returns a list of results.<a name="line.296"></a> +<span class="sourceLineNo">297</span> * So if you really care about scan metrics then you'd better use other scan methods which return<a name="line.297"></a> +<span class="sourceLineNo">298</span> * a {@code ResultScanner} or let you pass in a {@code ScanResultConsumer}. There is no<a name="line.298"></a> +<span class="sourceLineNo">299</span> * performance difference between these scan methods so do not worry.<a name="line.299"></a> +<span class="sourceLineNo">300</span> * @param scan A configured {@link Scan} object. So if you use this method to fetch a really large<a name="line.300"></a> +<span class="sourceLineNo">301</span> * result set, it is likely to cause OOM.<a name="line.301"></a> +<span class="sourceLineNo">302</span> * @return The results of this small scan operation. The return value will be wrapped by a<a name="line.302"></a> +<span class="sourceLineNo">303</span> * {@link CompletableFuture}.<a name="line.303"></a> +<span class="sourceLineNo">304</span> */<a name="line.304"></a> +<span class="sourceLineNo">305</span> CompletableFuture<List<Result>> scanAll(Scan scan);<a name="line.305"></a> +<span class="sourceLineNo">306</span><a name="line.306"></a> +<span class="sourceLineNo">307</span> /**<a name="line.307"></a> +<span class="sourceLineNo">308</span> * Test for the existence of columns in the table, as specified by the Gets.<a name="line.308"></a> +<span class="sourceLineNo">309</span> * <p><a name="line.309"></a> +<span class="sourceLineNo">310</span> * This will return a list of booleans. Each value will be true if the related Get matches one or<a name="line.310"></a> +<span class="sourceLineNo">311</span> * more keys, false if not.<a name="line.311"></a> +<span class="sourceLineNo">312</span> * <p><a name="line.312"></a> +<span class="sourceLineNo">313</span> * This is a server-side call so it prevents any data from being transferred to the client.<a name="line.313"></a> +<span class="sourceLineNo">314</span> * @param gets the Gets<a name="line.314"></a> +<span class="sourceLineNo">315</span> * @return A list of {@link CompletableFuture}s that represent the existence for each get.<a name="line.315"></a> +<span class="sourceLineNo">316</span> */<a name="line.316"></a> +<span class="sourceLineNo">317</span> default List<CompletableFuture<Boolean>> exists(List<Get> gets) {<a name="line.317"></a> +<span class="sourceLineNo">318</span> return get(toCheckExistenceOnly(gets)).stream()<a name="line.318"></a> +<span class="sourceLineNo">319</span> .<CompletableFuture<Boolean>> map(f -> f.thenApply(r -> r.getExists())).collect(toList());<a name="line.319"></a> +<span class="sourceLineNo">320</span> }<a name="line.320"></a> +<span class="sourceLineNo">321</span><a name="line.321"></a> +<span class="sourceLineNo">322</span> /**<a name="line.322"></a> +<span class="sourceLineNo">323</span> * A simple version for batch exists. It will fail if there are any failures and you will get the<a name="line.323"></a> +<span class="sourceLineNo">324</span> * whole result boolean list at once if the operation is succeeded.<a name="line.324"></a> +<span class="sourceLineNo">325</span> * @param gets the Gets<a name="line.325"></a> +<span class="sourceLineNo">326</span> * @return A {@link CompletableFuture} that wrapper the result boolean list.<a name="line.326"></a> +<span class="sourceLineNo">327</span> */<a name="line.327"></a> +<span class="sourceLineNo">328</span> default CompletableFuture<List<Boolean>> existsAll(List<Get> gets) {<a name="line.328"></a> +<span class="sourceLineNo">329</span> return allOf(exists(gets));<a name="line.329"></a> +<span class="sourceLineNo">330</span> }<a name="line.330"></a> +<span class="sourceLineNo">331</span><a name="line.331"></a> +<span class="sourceLineNo">332</span> /**<a name="line.332"></a> +<span class="sourceLineNo">333</span> * Extracts certain cells from the given rows, in batch.<a name="line.333"></a> +<span class="sourceLineNo">334</span> * <p><a name="line.334"></a> +<span class="sourceLineNo">335</span> * Notice that you may not get all the results with this function, which means some of the<a name="line.335"></a> +<span class="sourceLineNo">336</span> * returned {@link CompletableFuture}s may succeed while some of the other returned<a name="line.336"></a> +<span class="sourceLineNo">337</span> * {@link CompletableFuture}s may fail.<a name="line.337"></a> +<span class="sourceLineNo">338</span> * @param gets The objects that specify what data to fetch and from which rows.<a name="line.338"></a> +<span class="sourceLineNo">339</span> * @return A list of {@link CompletableFuture}s that represent the result for each get.<a name="line.339"></a> +<span class="sourceLineNo">340</span> */<a name="line.340"></a> +<span class="sourceLineNo">341</span> List<CompletableFuture<Result>> get(List<Get> gets);<a name="line.341"></a> +<span class="sourceLineNo">342</span><a name="line.342"></a> +<span class="sourceLineNo">343</span> /**<a name="line.343"></a> +<span class="sourceLineNo">344</span> * A simple version for batch get. It will fail if there are any failures and you will get the<a name="line.344"></a> +<span class="sourceLineNo">345</span> * whole result list at once if the operation is succeeded.<a name="line.345"></a> +<span class="sourceLineNo">346</span> * @param gets The objects that specify what data to fetch and from which rows.<a name="line.346"></a> +<span class="sourceLineNo">347</span> * @return A {@link CompletableFuture} that wrapper the result list.<a name="line.347"></a> +<span class="sourceLineNo">348</span> */<a name="line.348"></a> +<span class="sourceLineNo">349</span> default CompletableFuture<List<Result>> getAll(List<Get> gets) {<a name="line.349"></a> +<span class="sourceLineNo">350</span> return allOf(get(gets));<a name="line.350"></a> +<span class="sourceLineNo">351</span> }<a name="line.351"></a> +<span class="sourceLineNo">352</span><a name="line.352"></a> +<span class="sourceLineNo">353</span> /**<a name="line.353"></a> +<span class="sourceLineNo">354</span> * Puts some data in the table, in batch.<a name="line.354"></a> +<span class="sourceLineNo">355</span> * @param puts The list of mutations to apply.<a name="line.355"></a> +<span class="sourceLineNo">356</span> * @return A list of {@link CompletableFuture}s that represent the result for each put.<a name="line.356"></a> <span class="sourceLineNo">357</span> */<a name="line.357"></a> -<span class="sourceLineNo">358</span> default CompletableFuture<List<Boolean>> existsAll(List<Get> gets) {<a name="line.358"></a> -<span class="sourceLineNo">359</span> return allOf(exists(gets));<a name="line.359"></a> -<span class="sourceLineNo">360</span> }<a name="line.360"></a> -<span class="sourceLineNo">361</span><a name="line.361"></a> -<span class="sourceLineNo">362</span> /**<a name="line.362"></a> -<span class="sourceLineNo">363</span> * Extracts certain cells from the given rows, in batch.<a name="line.363"></a> -<span class="sourceLineNo">364</span> * <p><a name="line.364"></a> -<span class="sourceLineNo">365</span> * Notice that you may not get all the results with this function, which means some of the<a name="line.365"></a> -<span class="sourceLineNo">366</span> * returned {@link CompletableFuture}s may succeed while some of the other returned<a name="line.366"></a> -<span class="sourceLineNo">367</span> * {@link CompletableFuture}s may fail.<a name="line.367"></a> -<span class="sourceLineNo">368</span> * @param gets The objects that specify what data to fetch and from which rows.<a name="line.368"></a> -<span class="sourceLineNo">369</span> * @return A list of {@link CompletableFuture}s that represent the result for each get.<a name="line.369"></a> -<span class="sourceLineNo">370</span> */<a name="line.370"></a> -<span class="sourceLineNo">371</span> List<CompletableFuture<Result>> get(List<Get> gets);<a name="line.371"></a> -<span class="sourceLineNo">372</span><a name="line.372"></a> -<span class="sourceLineNo">373</span> /**<a name="line.373"></a> -<span class="sourceLineNo">374</span> * A simple version for batch get. It will fail if there are any failures and you will get the<a name="line.374"></a> -<span class="sourceLineNo">375</span> * whole result list at once if the operation is succeeded.<a name="line.375"></a> -<span class="sourceLineNo">376</span> * @param gets The objects that specify what data to fetch and from which rows.<a name="line.376"></a> -<span class="sourceLineNo">377</span> * @return A {@link CompletableFuture} that wrapper the result list.<a name="line.377"></a> -<span class="sourceLineNo">378</span> */<a name="line.378"></a> -<span class="sourceLineNo">379</span> default CompletableFuture<List<Result>> getAll(List<Get> gets) {<a name="line.379"></a> -<span class="sourceLineNo">380</span> return allOf(get(gets));<a name="line.380"></a> -<span class="sourceLineNo">381</span> }<a name="line.381"></a> -<span class="sourceLineNo">382</span><a name="line.382"></a> -<span class="sourceLineNo">383</span> /**<a name="line.383"></a> -<span class="sourceLineNo">384</span> * Puts some data in the table, in batch.<a name="line.384"></a> -<span class="sourceLineNo">385</span> * @param puts The list of mutations to apply.<a name="line.385"></a> -<span class="sourceLineNo">386</span> * @return A list of {@link CompletableFuture}s that represent the result for each put.<a name="line.386"></a> -<span class="sourceLineNo">387</span> */<a name="line.387"></a> -<span class="sourceLineNo">388</span> List<CompletableFuture<Void>> put(List<Put> puts);<a name="line.388"></a> -<span class="sourceLineNo">389</span><a name="line.389"></a> -<span class="sourceLineNo">390</span> /**<a name="line.390"></a> -<span class="sourceLineNo">391</span> * A simple version of batch put. It will fail if there are any failures.<a name="line.391"></a> -<span class="sourceLineNo">392</span> * @param puts The list of mutations to apply.<a name="line.392"></a> -<span class="sourceLineNo">393</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.393"></a> -<span class="sourceLineNo">394</span> */<a name="line.394"></a> -<span class="sourceLineNo">395</span> default CompletableFuture<Void> putAll(List<Put> puts) {<a name="line.395"></a> -<span class="sourceLineNo">396</span> return allOf(put(puts)).thenApply(r -> null);<a name="line.396"></a> -<span class="sourceLineNo">397</span> }<a name="line.397"></a> -<span class="sourceLineNo">398</span><a name="line.398"></a> -<span class="sourceLineNo">399</span> /**<a name="line.399"></a> -<span class="sourceLineNo">400</span> * Deletes the specified cells/rows in bulk.<a name="line.400"></a> -<span class="sourceLineNo">401</span> * @param deletes list of things to delete.<a name="line.401"></a> -<span class="sourceLineNo">402</span> * @return A list of {@link CompletableFuture}s that represent the result for each delete.<a name="line.402"></a> -<span class="sourceLineNo">403</span> */<a name="line.403"></a> -<span class="sourceLineNo">404</span> List<CompletableFuture<Void>> delete(List<Delete> deletes);<a name="line.404"></a> -<span class="sourceLineNo">405</span><a name="line.405"></a> -<span class="sourceLineNo">406</span> /**<a name="line.406"></a> -<span class="sourceLineNo">407</span> * A simple version of batch delete. It will fail if there are any failures.<a name="line.407"></a> -<span class="sourceLineNo">408</span> * @param deletes list of things to delete.<a name="line.408"></a> -<span class="sourceLineNo">409</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.409"></a> -<span class="sourceLineNo">410</span> */<a name="line.410"></a> -<span class="sourceLineNo">411</span> default CompletableFuture<Void> deleteAll(List<Delete> deletes) {<a name="line.411"></a> -<span class="sourceLineNo">412</span> return allOf(delete(deletes)).thenApply(r -> null);<a name="line.412"></a> -<span class="sourceLineNo">413</span> }<a name="line.413"></a> -<span class="sourceLineNo">414</span><a name="line.414"></a> -<span class="sourceLineNo">415</span> /**<a name="line.415"></a> -<span class="sourceLineNo">416</span> * Method that does a batch call on Deletes, Gets, Puts, Increments and Appends. The ordering of<a name="line.416"></a> -<span class="sourceLineNo">417</span> * execution of the actions is not defined. Meaning if you do a Put and a Get in the same<a name="line.417"></a> -<span class="sourceLineNo">418</span> * {@link #batch} call, you will not necessarily be guaranteed that the Get returns what the Put<a name="line.418"></a> -<span class="sourceLineNo">419</span> * had put.<a name="line.419"></a> -<span class="sourceLineNo">420</span> * @param actions list of Get, Put, Delete, Increment, Append objects<a name="line.420"></a> -<span class="sourceLineNo">421</span> * @return A list of {@link CompletableFuture}s that represent the result for each action.<a name="line.421"></a> -<span class="sourceLineNo">422</span> */<a name="line.422"></a> -<span class="sourceLineNo">423</span> <T> List<CompletableFuture<T>> batch(List<? extends Row> actions);<a name="line.423"></a> -<span class="sourceLineNo">424</span><a name="line.424"></a> -<span class="sourceLineNo">425</span> /**<a name="line.425"></a> -<span class="sourceLineNo">426</span> * A simple version of batch. It will fail if there are any failures and you will get the whole<a name="line.426"></a> -<span class="sourceLineNo">427</span> * result list at once if the operation is succeeded.<a name="line.427"></a> -<span class="sourceLineNo">428</span> * @param actions list of Get, Put, Delete, Increment, Append objects<a name="line.428"></a> -<span class="sourceLineNo">429</span> * @return A list of the result for the actions. Wrapped by a {@link CompletableFuture}.<a name="line.429"></a> -<span class="sourceLineNo">430</span> */<a name="line.430"></a> -<span class="sourceLineNo">431</span> default <T> CompletableFuture<List<T>> batchAll(List<? extends Row> actions) {<a name="line.431"></a> -<span class="sourceLineNo">432</span> return allOf(batch(actions));<a name="line.432"></a> -<span class="sourceLineNo">433</span> }<a name="line.433"></a> -<span class="sourceLineNo">434</span>}<a name="line.434"></a> +<span class="sourceLineNo">358</span> List<CompletableFuture<Void>> put(List<Put> puts);<a name="line.358"></a> +<span class="sourceLineNo">359</span><a name="line.359"></a> +<span class="sourceLineNo">360</span> /**<a name="line.360"></a> +<span class="sourceLineNo">361</span> * A simple version of batch put. It will fail if there are any failures.<a name="line.361"></a> +<span class="sourceLineNo">362</span> * @param puts The list of mutations to apply.<a name="line.362"></a> +<span class="sourceLineNo">363</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.363"></a> +<span class="sourceLineNo">364</span> */<a name="line.364"></a> +<span class="sourceLineNo">365</span> default CompletableFuture<Void> putAll(List<Put> puts) {<a name="line.365"></a> +<span class="sourceLineNo">366</span> return allOf(put(puts)).thenApply(r -> null);<a name="line.366"></a> +<span class="sourceLineNo">367</span> }<a name="line.367"></a> +<span class="sourceLineNo">368</span><a name="line.368"></a> +<span class="sourceLineNo">369</span> /**<a name="line.369"></a> +<span class="sourceLineNo">370</span> * Deletes the specified cells/rows in bulk.<a name="line.370"></a> +<span class="sourceLineNo">371</span> * @param deletes list of things to delete.<a name="line.371"></a> +<span class="sourceLineNo">372</span> * @return A list of {@link CompletableFuture}s that represent the result for each delete.<a name="line.372"></a> +<span class="sourceLineNo">373</span> */<a name="line.373"></a> +<span class="sourceLineNo">374</span> List<CompletableFuture<Void>> delete(List<Delete> deletes);<a name="line.374"></a> +<span class="sourceLineNo">375</span><a name="line.375"></a> +<span class="sourceLineNo">376</span> /**<a name="line.376"></a> +<span class="sourceLineNo">377</span> * A simple version of batch delete. It will fail if there are any failures.<a name="line.377"></a> +<span class="sourceLineNo">378</span> * @param deletes list of things to delete.<a name="line.378"></a> +<span class="sourceLineNo">379</span> * @return A {@link CompletableFuture} that always returns null when complete normally.<a name="line.379"></a> +<span class="sourceLineNo">380</span> */<a name="line.380"></a> +<span class="sourceLineNo">381</span> default CompletableFuture<Void> deleteAll(List<Delete> deletes) {<a name="line.381"></a> +<span class="sourceLineNo">382</span> return allOf(delete(deletes)).thenApply(r -> null);<a name="line.382"></a> +<span class="sourceLineNo">383</span> }<a name="line.383"></a> +<span class="sourceLineNo">384</span><a name="line.384"></a> +<span class="sourceLineNo">385</span> /**<a name="line.385"></a> +<span class="sourceLineNo">386</span> * Method that does a batch call on Deletes, Gets, Puts, Increments and Appends. The ordering of<a name="line.386"></a> +<span class="sourceLineNo">387</span> * execution of the actions is not defined. Meaning if you do a Put and a Get in the same<a name="line.387"></a> +<span class="sourceLineNo">388</span> * {@link #batch} call, you will not necessarily be guaranteed that the Get returns what the Put<a name="line.388"></a> +<span class="sourceLineNo">389</span> * had put.<a name="line.389"></a> +<span class="sourceLineNo">390</span> * @param actions list of Get, Put, Delete, Increment, Append objects<a name="line.390"></a> +<span class="sourceLineNo">391</span> * @return A list of {@link CompletableFuture}s that represent the result for each action.<a name="line.391"></a> +<span class="sourceLineNo">392</span> */<a name="line.392"></a> +<span class="sourceLineNo">393</span> <T> List<CompletableFuture<T>> batch(List<? extends Row> actions);<a name="line.393"></a> +<span class="sourceLineNo">394</span><a name="line.394"></a> +<span class="sourceLineNo">395</span> /**<a name="line.395"></a> +<span class="sourceLineNo">396</span> * A simple version of batch. It will fail if there are any failures and you will get the whole<a name="line.396"></a> +<span class="sourceLineNo">397</span> * result list at once if the operation is succeeded.<a name="line.397"></a> +<span class="sourceLineNo">398</span> * @param actions list of Get, Put, Delete, Increment, Append objects<a name="line.398"></a> +<span class="sourceLineNo">399</span> * @return A list of the result for the actions. Wrapped by a {@link CompletableFuture}.<a name="line.399"></a> +<span class="sourceLineNo">400</span> */<a name="line.400"></a> +<span class="sourceLineNo">401</span> default <T> CompletableFuture<List<T>> batchAll(List<? extends Row> actions) {<a name="line.401"></a> +<span class="sourceLineNo">402</span> return allOf(batch(actions));<a name="line.402"></a> +<span class="sourceLineNo">403</span> }<a name="line.403"></a> +<span class="sourceLineNo">404</span>}<a name="line.404"></a>
