You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hbase.apache.org by gi...@apache.org on 2018/08/24 14:47:20 UTC

[06/51] [partial] hbase-site git commit: Published site at a452487a9b82bfd33bc10683c3f8b8ae74d58883.

http://git-wip-us.apache.org/repos/asf/hbase-site/blob/0cf79db0/devapidocs/src-html/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html
----------------------------------------------------------------------
diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html b/devapidocs/src-html/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html
index c6137d0..4ca69da 100644
--- a/devapidocs/src-html/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html
+++ b/devapidocs/src-html/org/apache/hadoop/hbase/filter/ColumnCountGetFilter.html
@@ -29,118 +29,133 @@
 <span class="sourceLineNo">021</span><a name="line.21"></a>
 <span class="sourceLineNo">022</span>import java.io.IOException;<a name="line.22"></a>
 <span class="sourceLineNo">023</span>import java.util.ArrayList;<a name="line.23"></a>
-<span class="sourceLineNo">024</span><a name="line.24"></a>
-<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.Cell;<a name="line.25"></a>
-<span class="sourceLineNo">026</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.26"></a>
-<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.exceptions.DeserializationException;<a name="line.27"></a>
-<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos;<a name="line.28"></a>
-<span class="sourceLineNo">029</span><a name="line.29"></a>
-<span class="sourceLineNo">030</span>import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;<a name="line.30"></a>
-<span class="sourceLineNo">031</span>import org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;<a name="line.31"></a>
-<span class="sourceLineNo">032</span><a name="line.32"></a>
-<span class="sourceLineNo">033</span>/**<a name="line.33"></a>
-<span class="sourceLineNo">034</span> * Simple filter that returns first N columns on row only.<a name="line.34"></a>
-<span class="sourceLineNo">035</span> * This filter was written to test filters in Get and as soon as it gets<a name="line.35"></a>
-<span class="sourceLineNo">036</span> * its quota of columns, {@link #filterAllRemaining()} returns true.  This<a name="line.36"></a>
-<span class="sourceLineNo">037</span> * makes this filter unsuitable as a Scan filter.<a name="line.37"></a>
-<span class="sourceLineNo">038</span> */<a name="line.38"></a>
-<span class="sourceLineNo">039</span>@InterfaceAudience.Public<a name="line.39"></a>
-<span class="sourceLineNo">040</span>public class ColumnCountGetFilter extends FilterBase {<a name="line.40"></a>
-<span class="sourceLineNo">041</span>  private int limit = 0;<a name="line.41"></a>
-<span class="sourceLineNo">042</span>  private int count = 0;<a name="line.42"></a>
-<span class="sourceLineNo">043</span><a name="line.43"></a>
-<span class="sourceLineNo">044</span>  public ColumnCountGetFilter(final int n) {<a name="line.44"></a>
-<span class="sourceLineNo">045</span>    Preconditions.checkArgument(n &gt;= 0, "limit be positive %s", n);<a name="line.45"></a>
-<span class="sourceLineNo">046</span>    this.limit = n;<a name="line.46"></a>
-<span class="sourceLineNo">047</span>  }<a name="line.47"></a>
-<span class="sourceLineNo">048</span><a name="line.48"></a>
-<span class="sourceLineNo">049</span>  public int getLimit() {<a name="line.49"></a>
-<span class="sourceLineNo">050</span>    return limit;<a name="line.50"></a>
-<span class="sourceLineNo">051</span>  }<a name="line.51"></a>
-<span class="sourceLineNo">052</span><a name="line.52"></a>
-<span class="sourceLineNo">053</span>  @Override<a name="line.53"></a>
-<span class="sourceLineNo">054</span>  public boolean filterRowKey(Cell cell) throws IOException {<a name="line.54"></a>
-<span class="sourceLineNo">055</span>    // Impl in FilterBase might do unnecessary copy for Off heap backed Cells.<a name="line.55"></a>
-<span class="sourceLineNo">056</span>    if (filterAllRemaining()) return true;<a name="line.56"></a>
-<span class="sourceLineNo">057</span>    return false;<a name="line.57"></a>
-<span class="sourceLineNo">058</span>  }<a name="line.58"></a>
-<span class="sourceLineNo">059</span><a name="line.59"></a>
-<span class="sourceLineNo">060</span>  @Override<a name="line.60"></a>
-<span class="sourceLineNo">061</span>  public boolean filterAllRemaining() {<a name="line.61"></a>
-<span class="sourceLineNo">062</span>    return this.count &gt; this.limit;<a name="line.62"></a>
-<span class="sourceLineNo">063</span>  }<a name="line.63"></a>
-<span class="sourceLineNo">064</span><a name="line.64"></a>
-<span class="sourceLineNo">065</span>  @Deprecated<a name="line.65"></a>
-<span class="sourceLineNo">066</span>  @Override<a name="line.66"></a>
-<span class="sourceLineNo">067</span>  public ReturnCode filterKeyValue(final Cell c) {<a name="line.67"></a>
-<span class="sourceLineNo">068</span>    return filterCell(c);<a name="line.68"></a>
-<span class="sourceLineNo">069</span>  }<a name="line.69"></a>
-<span class="sourceLineNo">070</span><a name="line.70"></a>
-<span class="sourceLineNo">071</span>  @Override<a name="line.71"></a>
-<span class="sourceLineNo">072</span>  public ReturnCode filterCell(final Cell c) {<a name="line.72"></a>
-<span class="sourceLineNo">073</span>    this.count++;<a name="line.73"></a>
-<span class="sourceLineNo">074</span>    return filterAllRemaining() ? ReturnCode.NEXT_COL : ReturnCode.INCLUDE_AND_NEXT_COL;<a name="line.74"></a>
-<span class="sourceLineNo">075</span>  }<a name="line.75"></a>
-<span class="sourceLineNo">076</span><a name="line.76"></a>
-<span class="sourceLineNo">077</span>  @Override<a name="line.77"></a>
-<span class="sourceLineNo">078</span>  public void reset() {<a name="line.78"></a>
-<span class="sourceLineNo">079</span>    this.count = 0;<a name="line.79"></a>
-<span class="sourceLineNo">080</span>  }<a name="line.80"></a>
-<span class="sourceLineNo">081</span><a name="line.81"></a>
-<span class="sourceLineNo">082</span>  public static Filter createFilterFromArguments(ArrayList&lt;byte []&gt; filterArguments) {<a name="line.82"></a>
-<span class="sourceLineNo">083</span>    Preconditions.checkArgument(filterArguments.size() == 1,<a name="line.83"></a>
-<span class="sourceLineNo">084</span>                                "Expected 1 but got: %s", filterArguments.size());<a name="line.84"></a>
-<span class="sourceLineNo">085</span>    int limit = ParseFilter.convertByteArrayToInt(filterArguments.get(0));<a name="line.85"></a>
-<span class="sourceLineNo">086</span>    return new ColumnCountGetFilter(limit);<a name="line.86"></a>
-<span class="sourceLineNo">087</span>  }<a name="line.87"></a>
-<span class="sourceLineNo">088</span><a name="line.88"></a>
-<span class="sourceLineNo">089</span>  /**<a name="line.89"></a>
-<span class="sourceLineNo">090</span>   * @return The filter serialized using pb<a name="line.90"></a>
-<span class="sourceLineNo">091</span>   */<a name="line.91"></a>
-<span class="sourceLineNo">092</span>  @Override<a name="line.92"></a>
-<span class="sourceLineNo">093</span>  public byte [] toByteArray() {<a name="line.93"></a>
-<span class="sourceLineNo">094</span>    FilterProtos.ColumnCountGetFilter.Builder builder =<a name="line.94"></a>
-<span class="sourceLineNo">095</span>      FilterProtos.ColumnCountGetFilter.newBuilder();<a name="line.95"></a>
-<span class="sourceLineNo">096</span>    builder.setLimit(this.limit);<a name="line.96"></a>
-<span class="sourceLineNo">097</span>    return builder.build().toByteArray();<a name="line.97"></a>
-<span class="sourceLineNo">098</span>  }<a name="line.98"></a>
-<span class="sourceLineNo">099</span><a name="line.99"></a>
-<span class="sourceLineNo">100</span>  /**<a name="line.100"></a>
-<span class="sourceLineNo">101</span>   * @param pbBytes A pb serialized {@link ColumnCountGetFilter} instance<a name="line.101"></a>
-<span class="sourceLineNo">102</span>   * @return An instance of {@link ColumnCountGetFilter} made from &lt;code&gt;bytes&lt;/code&gt;<a name="line.102"></a>
-<span class="sourceLineNo">103</span>   * @throws org.apache.hadoop.hbase.exceptions.DeserializationException<a name="line.103"></a>
-<span class="sourceLineNo">104</span>   * @see #toByteArray<a name="line.104"></a>
-<span class="sourceLineNo">105</span>   */<a name="line.105"></a>
-<span class="sourceLineNo">106</span>  public static ColumnCountGetFilter parseFrom(final byte [] pbBytes)<a name="line.106"></a>
-<span class="sourceLineNo">107</span>  throws DeserializationException {<a name="line.107"></a>
-<span class="sourceLineNo">108</span>    FilterProtos.ColumnCountGetFilter proto;<a name="line.108"></a>
-<span class="sourceLineNo">109</span>    try {<a name="line.109"></a>
-<span class="sourceLineNo">110</span>      proto = FilterProtos.ColumnCountGetFilter.parseFrom(pbBytes);<a name="line.110"></a>
-<span class="sourceLineNo">111</span>    } catch (InvalidProtocolBufferException e) {<a name="line.111"></a>
-<span class="sourceLineNo">112</span>      throw new DeserializationException(e);<a name="line.112"></a>
-<span class="sourceLineNo">113</span>    }<a name="line.113"></a>
-<span class="sourceLineNo">114</span>    return new ColumnCountGetFilter(proto.getLimit());<a name="line.114"></a>
-<span class="sourceLineNo">115</span>  }<a name="line.115"></a>
-<span class="sourceLineNo">116</span><a name="line.116"></a>
-<span class="sourceLineNo">117</span>  /**<a name="line.117"></a>
-<span class="sourceLineNo">118</span>   * @param o the other filter to compare with<a name="line.118"></a>
-<span class="sourceLineNo">119</span>   * @return true if and only if the fields of the filter that are serialized<a name="line.119"></a>
-<span class="sourceLineNo">120</span>   * are equal to the corresponding fields in other.  Used for testing.<a name="line.120"></a>
-<span class="sourceLineNo">121</span>   */<a name="line.121"></a>
-<span class="sourceLineNo">122</span>  @Override<a name="line.122"></a>
-<span class="sourceLineNo">123</span>  boolean areSerializedFieldsEqual(Filter o) {<a name="line.123"></a>
-<span class="sourceLineNo">124</span>    if (o == this) return true;<a name="line.124"></a>
-<span class="sourceLineNo">125</span>    if (!(o instanceof ColumnCountGetFilter)) return false;<a name="line.125"></a>
-<span class="sourceLineNo">126</span><a name="line.126"></a>
-<span class="sourceLineNo">127</span>    ColumnCountGetFilter other = (ColumnCountGetFilter)o;<a name="line.127"></a>
-<span class="sourceLineNo">128</span>    return this.getLimit() == other.getLimit();<a name="line.128"></a>
-<span class="sourceLineNo">129</span>  }<a name="line.129"></a>
-<span class="sourceLineNo">130</span><a name="line.130"></a>
-<span class="sourceLineNo">131</span>  @Override<a name="line.131"></a>
-<span class="sourceLineNo">132</span>  public String toString() {<a name="line.132"></a>
-<span class="sourceLineNo">133</span>    return this.getClass().getSimpleName() + " " + this.limit;<a name="line.133"></a>
-<span class="sourceLineNo">134</span>  }<a name="line.134"></a>
-<span class="sourceLineNo">135</span>}<a name="line.135"></a>
+<span class="sourceLineNo">024</span>import java.util.Objects;<a name="line.24"></a>
+<span class="sourceLineNo">025</span><a name="line.25"></a>
+<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.Cell;<a name="line.26"></a>
+<span class="sourceLineNo">027</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.27"></a>
+<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.exceptions.DeserializationException;<a name="line.28"></a>
+<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos;<a name="line.29"></a>
+<span class="sourceLineNo">030</span><a name="line.30"></a>
+<span class="sourceLineNo">031</span>import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;<a name="line.31"></a>
+<span class="sourceLineNo">032</span>import org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;<a name="line.32"></a>
+<span class="sourceLineNo">033</span><a name="line.33"></a>
+<span class="sourceLineNo">034</span>/**<a name="line.34"></a>
+<span class="sourceLineNo">035</span> * Simple filter that returns first N columns on row only.<a name="line.35"></a>
+<span class="sourceLineNo">036</span> * This filter was written to test filters in Get and as soon as it gets<a name="line.36"></a>
+<span class="sourceLineNo">037</span> * its quota of columns, {@link #filterAllRemaining()} returns true.  This<a name="line.37"></a>
+<span class="sourceLineNo">038</span> * makes this filter unsuitable as a Scan filter.<a name="line.38"></a>
+<span class="sourceLineNo">039</span> */<a name="line.39"></a>
+<span class="sourceLineNo">040</span>@InterfaceAudience.Public<a name="line.40"></a>
+<span class="sourceLineNo">041</span>public class ColumnCountGetFilter extends FilterBase {<a name="line.41"></a>
+<span class="sourceLineNo">042</span>  private int limit = 0;<a name="line.42"></a>
+<span class="sourceLineNo">043</span>  private int count = 0;<a name="line.43"></a>
+<span class="sourceLineNo">044</span><a name="line.44"></a>
+<span class="sourceLineNo">045</span>  public ColumnCountGetFilter(final int n) {<a name="line.45"></a>
+<span class="sourceLineNo">046</span>    Preconditions.checkArgument(n &gt;= 0, "limit be positive %s", n);<a name="line.46"></a>
+<span class="sourceLineNo">047</span>    this.limit = n;<a name="line.47"></a>
+<span class="sourceLineNo">048</span>  }<a name="line.48"></a>
+<span class="sourceLineNo">049</span><a name="line.49"></a>
+<span class="sourceLineNo">050</span>  public int getLimit() {<a name="line.50"></a>
+<span class="sourceLineNo">051</span>    return limit;<a name="line.51"></a>
+<span class="sourceLineNo">052</span>  }<a name="line.52"></a>
+<span class="sourceLineNo">053</span><a name="line.53"></a>
+<span class="sourceLineNo">054</span>  @Override<a name="line.54"></a>
+<span class="sourceLineNo">055</span>  public boolean filterRowKey(Cell cell) throws IOException {<a name="line.55"></a>
+<span class="sourceLineNo">056</span>    // Impl in FilterBase might do unnecessary copy for Off heap backed Cells.<a name="line.56"></a>
+<span class="sourceLineNo">057</span>    if (filterAllRemaining()) return true;<a name="line.57"></a>
+<span class="sourceLineNo">058</span>    return false;<a name="line.58"></a>
+<span class="sourceLineNo">059</span>  }<a name="line.59"></a>
+<span class="sourceLineNo">060</span><a name="line.60"></a>
+<span class="sourceLineNo">061</span>  @Override<a name="line.61"></a>
+<span class="sourceLineNo">062</span>  public boolean filterAllRemaining() {<a name="line.62"></a>
+<span class="sourceLineNo">063</span>    return this.count &gt; this.limit;<a name="line.63"></a>
+<span class="sourceLineNo">064</span>  }<a name="line.64"></a>
+<span class="sourceLineNo">065</span><a name="line.65"></a>
+<span class="sourceLineNo">066</span>  @Deprecated<a name="line.66"></a>
+<span class="sourceLineNo">067</span>  @Override<a name="line.67"></a>
+<span class="sourceLineNo">068</span>  public ReturnCode filterKeyValue(final Cell c) {<a name="line.68"></a>
+<span class="sourceLineNo">069</span>    return filterCell(c);<a name="line.69"></a>
+<span class="sourceLineNo">070</span>  }<a name="line.70"></a>
+<span class="sourceLineNo">071</span><a name="line.71"></a>
+<span class="sourceLineNo">072</span>  @Override<a name="line.72"></a>
+<span class="sourceLineNo">073</span>  public ReturnCode filterCell(final Cell c) {<a name="line.73"></a>
+<span class="sourceLineNo">074</span>    this.count++;<a name="line.74"></a>
+<span class="sourceLineNo">075</span>    return filterAllRemaining() ? ReturnCode.NEXT_COL : ReturnCode.INCLUDE_AND_NEXT_COL;<a name="line.75"></a>
+<span class="sourceLineNo">076</span>  }<a name="line.76"></a>
+<span class="sourceLineNo">077</span><a name="line.77"></a>
+<span class="sourceLineNo">078</span>  @Override<a name="line.78"></a>
+<span class="sourceLineNo">079</span>  public void reset() {<a name="line.79"></a>
+<span class="sourceLineNo">080</span>    this.count = 0;<a name="line.80"></a>
+<span class="sourceLineNo">081</span>  }<a name="line.81"></a>
+<span class="sourceLineNo">082</span><a name="line.82"></a>
+<span class="sourceLineNo">083</span>  public static Filter createFilterFromArguments(ArrayList&lt;byte []&gt; filterArguments) {<a name="line.83"></a>
+<span class="sourceLineNo">084</span>    Preconditions.checkArgument(filterArguments.size() == 1,<a name="line.84"></a>
+<span class="sourceLineNo">085</span>                                "Expected 1 but got: %s", filterArguments.size());<a name="line.85"></a>
+<span class="sourceLineNo">086</span>    int limit = ParseFilter.convertByteArrayToInt(filterArguments.get(0));<a name="line.86"></a>
+<span class="sourceLineNo">087</span>    return new ColumnCountGetFilter(limit);<a name="line.87"></a>
+<span class="sourceLineNo">088</span>  }<a name="line.88"></a>
+<span class="sourceLineNo">089</span><a name="line.89"></a>
+<span class="sourceLineNo">090</span>  /**<a name="line.90"></a>
+<span class="sourceLineNo">091</span>   * @return The filter serialized using pb<a name="line.91"></a>
+<span class="sourceLineNo">092</span>   */<a name="line.92"></a>
+<span class="sourceLineNo">093</span>  @Override<a name="line.93"></a>
+<span class="sourceLineNo">094</span>  public byte [] toByteArray() {<a name="line.94"></a>
+<span class="sourceLineNo">095</span>    FilterProtos.ColumnCountGetFilter.Builder builder =<a name="line.95"></a>
+<span class="sourceLineNo">096</span>      FilterProtos.ColumnCountGetFilter.newBuilder();<a name="line.96"></a>
+<span class="sourceLineNo">097</span>    builder.setLimit(this.limit);<a name="line.97"></a>
+<span class="sourceLineNo">098</span>    return builder.build().toByteArray();<a name="line.98"></a>
+<span class="sourceLineNo">099</span>  }<a name="line.99"></a>
+<span class="sourceLineNo">100</span><a name="line.100"></a>
+<span class="sourceLineNo">101</span>  /**<a name="line.101"></a>
+<span class="sourceLineNo">102</span>   * @param pbBytes A pb serialized {@link ColumnCountGetFilter} instance<a name="line.102"></a>
+<span class="sourceLineNo">103</span>   * @return An instance of {@link ColumnCountGetFilter} made from &lt;code&gt;bytes&lt;/code&gt;<a name="line.103"></a>
+<span class="sourceLineNo">104</span>   * @throws org.apache.hadoop.hbase.exceptions.DeserializationException<a name="line.104"></a>
+<span class="sourceLineNo">105</span>   * @see #toByteArray<a name="line.105"></a>
+<span class="sourceLineNo">106</span>   */<a name="line.106"></a>
+<span class="sourceLineNo">107</span>  public static ColumnCountGetFilter parseFrom(final byte [] pbBytes)<a name="line.107"></a>
+<span class="sourceLineNo">108</span>  throws DeserializationException {<a name="line.108"></a>
+<span class="sourceLineNo">109</span>    FilterProtos.ColumnCountGetFilter proto;<a name="line.109"></a>
+<span class="sourceLineNo">110</span>    try {<a name="line.110"></a>
+<span class="sourceLineNo">111</span>      proto = FilterProtos.ColumnCountGetFilter.parseFrom(pbBytes);<a name="line.111"></a>
+<span class="sourceLineNo">112</span>    } catch (InvalidProtocolBufferException e) {<a name="line.112"></a>
+<span class="sourceLineNo">113</span>      throw new DeserializationException(e);<a name="line.113"></a>
+<span class="sourceLineNo">114</span>    }<a name="line.114"></a>
+<span class="sourceLineNo">115</span>    return new ColumnCountGetFilter(proto.getLimit());<a name="line.115"></a>
+<span class="sourceLineNo">116</span>  }<a name="line.116"></a>
+<span class="sourceLineNo">117</span><a name="line.117"></a>
+<span class="sourceLineNo">118</span>  /**<a name="line.118"></a>
+<span class="sourceLineNo">119</span>   * @param o the other filter to compare with<a name="line.119"></a>
+<span class="sourceLineNo">120</span>   * @return true if and only if the fields of the filter that are serialized<a name="line.120"></a>
+<span class="sourceLineNo">121</span>   * are equal to the corresponding fields in other.  Used for testing.<a name="line.121"></a>
+<span class="sourceLineNo">122</span>   */<a name="line.122"></a>
+<span class="sourceLineNo">123</span>  @Override<a name="line.123"></a>
+<span class="sourceLineNo">124</span>  boolean areSerializedFieldsEqual(Filter o) {<a name="line.124"></a>
+<span class="sourceLineNo">125</span>    if (o == this) return true;<a name="line.125"></a>
+<span class="sourceLineNo">126</span>    if (!(o instanceof ColumnCountGetFilter)) return false;<a name="line.126"></a>
+<span class="sourceLineNo">127</span><a name="line.127"></a>
+<span class="sourceLineNo">128</span>    ColumnCountGetFilter other = (ColumnCountGetFilter)o;<a name="line.128"></a>
+<span class="sourceLineNo">129</span>    return this.getLimit() == other.getLimit();<a name="line.129"></a>
+<span class="sourceLineNo">130</span>  }<a name="line.130"></a>
+<span class="sourceLineNo">131</span><a name="line.131"></a>
+<span class="sourceLineNo">132</span>  @Override<a name="line.132"></a>
+<span class="sourceLineNo">133</span>  public String toString() {<a name="line.133"></a>
+<span class="sourceLineNo">134</span>    return this.getClass().getSimpleName() + " " + this.limit;<a name="line.134"></a>
+<span class="sourceLineNo">135</span>  }<a name="line.135"></a>
+<span class="sourceLineNo">136</span><a name="line.136"></a>
+<span class="sourceLineNo">137</span>  @Override<a name="line.137"></a>
+<span class="sourceLineNo">138</span>  public boolean equals(Object obj) {<a name="line.138"></a>
+<span class="sourceLineNo">139</span>    if (obj == null || (!(obj instanceof ColumnCountGetFilter))) {<a name="line.139"></a>
+<span class="sourceLineNo">140</span>      return false;<a name="line.140"></a>
+<span class="sourceLineNo">141</span>    }<a name="line.141"></a>
+<span class="sourceLineNo">142</span>    ColumnCountGetFilter f = (ColumnCountGetFilter) obj;<a name="line.142"></a>
+<span class="sourceLineNo">143</span>    return this.areSerializedFieldsEqual(f);<a name="line.143"></a>
+<span class="sourceLineNo">144</span>  }<a name="line.144"></a>
+<span class="sourceLineNo">145</span><a name="line.145"></a>
+<span class="sourceLineNo">146</span>  @Override<a name="line.146"></a>
+<span class="sourceLineNo">147</span>  public int hashCode() {<a name="line.147"></a>
+<span class="sourceLineNo">148</span>    return Objects.hash(this.limit);<a name="line.148"></a>
+<span class="sourceLineNo">149</span>  }<a name="line.149"></a>
+<span class="sourceLineNo">150</span>}<a name="line.150"></a>
 
 
 

http://git-wip-us.apache.org/repos/asf/hbase-site/blob/0cf79db0/devapidocs/src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html
----------------------------------------------------------------------
diff --git a/devapidocs/src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html b/devapidocs/src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html
index 4fc026d..0b46d9f 100644
--- a/devapidocs/src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html
+++ b/devapidocs/src-html/org/apache/hadoop/hbase/filter/ColumnPaginationFilter.html
@@ -28,217 +28,232 @@
 <span class="sourceLineNo">020</span><a name="line.20"></a>
 <span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
 <span class="sourceLineNo">022</span>import java.util.ArrayList;<a name="line.22"></a>
-<span class="sourceLineNo">023</span><a name="line.23"></a>
-<span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.Cell;<a name="line.24"></a>
-<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.CellUtil;<a name="line.25"></a>
-<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.PrivateCellUtil;<a name="line.26"></a>
-<span class="sourceLineNo">027</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.27"></a>
-<span class="sourceLineNo">028</span>import org.apache.hadoop.hbase.exceptions.DeserializationException;<a name="line.28"></a>
-<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos;<a name="line.29"></a>
-<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.30"></a>
-<span class="sourceLineNo">031</span><a name="line.31"></a>
-<span class="sourceLineNo">032</span>import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;<a name="line.32"></a>
-<span class="sourceLineNo">033</span>import org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;<a name="line.33"></a>
-<span class="sourceLineNo">034</span>import org.apache.hbase.thirdparty.com.google.protobuf.UnsafeByteOperations;<a name="line.34"></a>
-<span class="sourceLineNo">035</span><a name="line.35"></a>
-<span class="sourceLineNo">036</span>/**<a name="line.36"></a>
-<span class="sourceLineNo">037</span> * A filter, based on the ColumnCountGetFilter, takes two arguments: limit and offset.<a name="line.37"></a>
-<span class="sourceLineNo">038</span> * This filter can be used for row-based indexing, where references to other tables are stored across many columns,<a name="line.38"></a>
-<span class="sourceLineNo">039</span> * in order to efficient lookups and paginated results for end users. Only most recent versions are considered<a name="line.39"></a>
-<span class="sourceLineNo">040</span> * for pagination.<a name="line.40"></a>
-<span class="sourceLineNo">041</span> */<a name="line.41"></a>
-<span class="sourceLineNo">042</span>@InterfaceAudience.Public<a name="line.42"></a>
-<span class="sourceLineNo">043</span>public class ColumnPaginationFilter extends FilterBase {<a name="line.43"></a>
-<span class="sourceLineNo">044</span><a name="line.44"></a>
-<span class="sourceLineNo">045</span>  private int limit = 0;<a name="line.45"></a>
-<span class="sourceLineNo">046</span>  private int offset = -1;<a name="line.46"></a>
-<span class="sourceLineNo">047</span>  private byte[] columnOffset = null;<a name="line.47"></a>
-<span class="sourceLineNo">048</span>  private int count = 0;<a name="line.48"></a>
-<span class="sourceLineNo">049</span><a name="line.49"></a>
-<span class="sourceLineNo">050</span>  /**<a name="line.50"></a>
-<span class="sourceLineNo">051</span>   * Initializes filter with an integer offset and limit. The offset is arrived at<a name="line.51"></a>
-<span class="sourceLineNo">052</span>   * scanning sequentially and skipping entries. @limit number of columns are<a name="line.52"></a>
-<span class="sourceLineNo">053</span>   * then retrieved. If multiple column families are involved, the columns may be spread<a name="line.53"></a>
-<span class="sourceLineNo">054</span>   * across them.<a name="line.54"></a>
-<span class="sourceLineNo">055</span>   *<a name="line.55"></a>
-<span class="sourceLineNo">056</span>   * @param limit Max number of columns to return.<a name="line.56"></a>
-<span class="sourceLineNo">057</span>   * @param offset The integer offset where to start pagination.<a name="line.57"></a>
-<span class="sourceLineNo">058</span>   */<a name="line.58"></a>
-<span class="sourceLineNo">059</span>  public ColumnPaginationFilter(final int limit, final int offset)<a name="line.59"></a>
-<span class="sourceLineNo">060</span>  {<a name="line.60"></a>
-<span class="sourceLineNo">061</span>    Preconditions.checkArgument(limit &gt;= 0, "limit must be positive %s", limit);<a name="line.61"></a>
-<span class="sourceLineNo">062</span>    Preconditions.checkArgument(offset &gt;= 0, "offset must be positive %s", offset);<a name="line.62"></a>
-<span class="sourceLineNo">063</span>    this.limit = limit;<a name="line.63"></a>
-<span class="sourceLineNo">064</span>    this.offset = offset;<a name="line.64"></a>
-<span class="sourceLineNo">065</span>  }<a name="line.65"></a>
-<span class="sourceLineNo">066</span><a name="line.66"></a>
-<span class="sourceLineNo">067</span>  /**<a name="line.67"></a>
-<span class="sourceLineNo">068</span>   * Initializes filter with a string/bookmark based offset and limit. The offset is arrived<a name="line.68"></a>
-<span class="sourceLineNo">069</span>   * at, by seeking to it using scanner hints. If multiple column families are involved,<a name="line.69"></a>
-<span class="sourceLineNo">070</span>   * pagination starts at the first column family which contains @columnOffset. Columns are<a name="line.70"></a>
-<span class="sourceLineNo">071</span>   * then retrieved sequentially upto @limit number of columns which maybe spread across<a name="line.71"></a>
-<span class="sourceLineNo">072</span>   * multiple column families, depending on how the scan is setup.<a name="line.72"></a>
-<span class="sourceLineNo">073</span>   *<a name="line.73"></a>
-<span class="sourceLineNo">074</span>   * @param limit Max number of columns to return.<a name="line.74"></a>
-<span class="sourceLineNo">075</span>   * @param columnOffset The string/bookmark offset on where to start pagination.<a name="line.75"></a>
-<span class="sourceLineNo">076</span>   */<a name="line.76"></a>
-<span class="sourceLineNo">077</span>  public ColumnPaginationFilter(final int limit, final byte[] columnOffset) {<a name="line.77"></a>
-<span class="sourceLineNo">078</span>    Preconditions.checkArgument(limit &gt;= 0, "limit must be positive %s", limit);<a name="line.78"></a>
-<span class="sourceLineNo">079</span>    Preconditions.checkArgument(columnOffset != null,<a name="line.79"></a>
-<span class="sourceLineNo">080</span>                                "columnOffset must be non-null %s",<a name="line.80"></a>
-<span class="sourceLineNo">081</span>                                columnOffset);<a name="line.81"></a>
-<span class="sourceLineNo">082</span>    this.limit = limit;<a name="line.82"></a>
-<span class="sourceLineNo">083</span>    this.columnOffset = columnOffset;<a name="line.83"></a>
-<span class="sourceLineNo">084</span>  }<a name="line.84"></a>
-<span class="sourceLineNo">085</span><a name="line.85"></a>
-<span class="sourceLineNo">086</span>  /**<a name="line.86"></a>
-<span class="sourceLineNo">087</span>   * @return limit<a name="line.87"></a>
-<span class="sourceLineNo">088</span>   */<a name="line.88"></a>
-<span class="sourceLineNo">089</span>  public int getLimit() {<a name="line.89"></a>
-<span class="sourceLineNo">090</span>    return limit;<a name="line.90"></a>
-<span class="sourceLineNo">091</span>  }<a name="line.91"></a>
-<span class="sourceLineNo">092</span><a name="line.92"></a>
-<span class="sourceLineNo">093</span>  /**<a name="line.93"></a>
-<span class="sourceLineNo">094</span>   * @return offset<a name="line.94"></a>
-<span class="sourceLineNo">095</span>   */<a name="line.95"></a>
-<span class="sourceLineNo">096</span>  public int getOffset() {<a name="line.96"></a>
-<span class="sourceLineNo">097</span>    return offset;<a name="line.97"></a>
-<span class="sourceLineNo">098</span>  }<a name="line.98"></a>
-<span class="sourceLineNo">099</span><a name="line.99"></a>
-<span class="sourceLineNo">100</span>  /**<a name="line.100"></a>
-<span class="sourceLineNo">101</span>   * @return columnOffset<a name="line.101"></a>
-<span class="sourceLineNo">102</span>   */<a name="line.102"></a>
-<span class="sourceLineNo">103</span>  public byte[] getColumnOffset() {<a name="line.103"></a>
-<span class="sourceLineNo">104</span>    return columnOffset;<a name="line.104"></a>
-<span class="sourceLineNo">105</span>  }<a name="line.105"></a>
-<span class="sourceLineNo">106</span><a name="line.106"></a>
-<span class="sourceLineNo">107</span>  @Override<a name="line.107"></a>
-<span class="sourceLineNo">108</span>  public boolean filterRowKey(Cell cell) throws IOException {<a name="line.108"></a>
-<span class="sourceLineNo">109</span>    // Impl in FilterBase might do unnecessary copy for Off heap backed Cells.<a name="line.109"></a>
-<span class="sourceLineNo">110</span>    return false;<a name="line.110"></a>
-<span class="sourceLineNo">111</span>  }<a name="line.111"></a>
-<span class="sourceLineNo">112</span><a name="line.112"></a>
-<span class="sourceLineNo">113</span>  @Override<a name="line.113"></a>
-<span class="sourceLineNo">114</span>  @Deprecated<a name="line.114"></a>
-<span class="sourceLineNo">115</span>  public ReturnCode filterKeyValue(final Cell c) {<a name="line.115"></a>
-<span class="sourceLineNo">116</span>    return filterCell(c);<a name="line.116"></a>
-<span class="sourceLineNo">117</span>  }<a name="line.117"></a>
-<span class="sourceLineNo">118</span><a name="line.118"></a>
-<span class="sourceLineNo">119</span>  @Override<a name="line.119"></a>
-<span class="sourceLineNo">120</span>  public ReturnCode filterCell(final Cell c)<a name="line.120"></a>
-<span class="sourceLineNo">121</span>  {<a name="line.121"></a>
-<span class="sourceLineNo">122</span>    if (columnOffset != null) {<a name="line.122"></a>
-<span class="sourceLineNo">123</span>      if (count &gt;= limit) {<a name="line.123"></a>
-<span class="sourceLineNo">124</span>        return ReturnCode.NEXT_ROW;<a name="line.124"></a>
-<span class="sourceLineNo">125</span>      }<a name="line.125"></a>
-<span class="sourceLineNo">126</span>      int cmp = 0;<a name="line.126"></a>
-<span class="sourceLineNo">127</span>      // Only compare if no KV's have been seen so far.<a name="line.127"></a>
-<span class="sourceLineNo">128</span>      if (count == 0) {<a name="line.128"></a>
-<span class="sourceLineNo">129</span>        cmp = CellUtil.compareQualifiers(c, this.columnOffset, 0, this.columnOffset.length);<a name="line.129"></a>
-<span class="sourceLineNo">130</span>      }<a name="line.130"></a>
-<span class="sourceLineNo">131</span>      if (cmp &lt; 0) {<a name="line.131"></a>
-<span class="sourceLineNo">132</span>        return ReturnCode.SEEK_NEXT_USING_HINT;<a name="line.132"></a>
-<span class="sourceLineNo">133</span>      } else {<a name="line.133"></a>
-<span class="sourceLineNo">134</span>        count++;<a name="line.134"></a>
-<span class="sourceLineNo">135</span>        return ReturnCode.INCLUDE_AND_NEXT_COL;<a name="line.135"></a>
-<span class="sourceLineNo">136</span>      }<a name="line.136"></a>
-<span class="sourceLineNo">137</span>    } else {<a name="line.137"></a>
-<span class="sourceLineNo">138</span>      if (count &gt;= offset + limit) {<a name="line.138"></a>
-<span class="sourceLineNo">139</span>        return ReturnCode.NEXT_ROW;<a name="line.139"></a>
-<span class="sourceLineNo">140</span>      }<a name="line.140"></a>
-<span class="sourceLineNo">141</span><a name="line.141"></a>
-<span class="sourceLineNo">142</span>      ReturnCode code = count &lt; offset ? ReturnCode.NEXT_COL :<a name="line.142"></a>
-<span class="sourceLineNo">143</span>                                         ReturnCode.INCLUDE_AND_NEXT_COL;<a name="line.143"></a>
-<span class="sourceLineNo">144</span>      count++;<a name="line.144"></a>
-<span class="sourceLineNo">145</span>      return code;<a name="line.145"></a>
-<span class="sourceLineNo">146</span>    }<a name="line.146"></a>
-<span class="sourceLineNo">147</span>  }<a name="line.147"></a>
-<span class="sourceLineNo">148</span><a name="line.148"></a>
-<span class="sourceLineNo">149</span>  @Override<a name="line.149"></a>
-<span class="sourceLineNo">150</span>  public Cell getNextCellHint(Cell cell) {<a name="line.150"></a>
-<span class="sourceLineNo">151</span>    return PrivateCellUtil.createFirstOnRowCol(cell, columnOffset, 0, columnOffset.length);<a name="line.151"></a>
-<span class="sourceLineNo">152</span>  }<a name="line.152"></a>
-<span class="sourceLineNo">153</span><a name="line.153"></a>
-<span class="sourceLineNo">154</span>  @Override<a name="line.154"></a>
-<span class="sourceLineNo">155</span>  public void reset()<a name="line.155"></a>
-<span class="sourceLineNo">156</span>  {<a name="line.156"></a>
-<span class="sourceLineNo">157</span>    this.count = 0;<a name="line.157"></a>
-<span class="sourceLineNo">158</span>  }<a name="line.158"></a>
-<span class="sourceLineNo">159</span><a name="line.159"></a>
-<span class="sourceLineNo">160</span>  public static Filter createFilterFromArguments(ArrayList&lt;byte []&gt; filterArguments) {<a name="line.160"></a>
-<span class="sourceLineNo">161</span>    Preconditions.checkArgument(filterArguments.size() == 2,<a name="line.161"></a>
-<span class="sourceLineNo">162</span>                                "Expected 2 but got: %s", filterArguments.size());<a name="line.162"></a>
-<span class="sourceLineNo">163</span>    int limit = ParseFilter.convertByteArrayToInt(filterArguments.get(0));<a name="line.163"></a>
-<span class="sourceLineNo">164</span>    int offset = ParseFilter.convertByteArrayToInt(filterArguments.get(1));<a name="line.164"></a>
-<span class="sourceLineNo">165</span>    return new ColumnPaginationFilter(limit, offset);<a name="line.165"></a>
-<span class="sourceLineNo">166</span>  }<a name="line.166"></a>
-<span class="sourceLineNo">167</span><a name="line.167"></a>
-<span class="sourceLineNo">168</span>  /**<a name="line.168"></a>
-<span class="sourceLineNo">169</span>   * @return The filter serialized using pb<a name="line.169"></a>
-<span class="sourceLineNo">170</span>   */<a name="line.170"></a>
-<span class="sourceLineNo">171</span>  @Override<a name="line.171"></a>
-<span class="sourceLineNo">172</span>  public byte [] toByteArray() {<a name="line.172"></a>
-<span class="sourceLineNo">173</span>    FilterProtos.ColumnPaginationFilter.Builder builder =<a name="line.173"></a>
-<span class="sourceLineNo">174</span>      FilterProtos.ColumnPaginationFilter.newBuilder();<a name="line.174"></a>
-<span class="sourceLineNo">175</span>    builder.setLimit(this.limit);<a name="line.175"></a>
-<span class="sourceLineNo">176</span>    if (this.offset &gt;= 0) {<a name="line.176"></a>
-<span class="sourceLineNo">177</span>      builder.setOffset(this.offset);<a name="line.177"></a>
-<span class="sourceLineNo">178</span>    }<a name="line.178"></a>
-<span class="sourceLineNo">179</span>    if (this.columnOffset != null) {<a name="line.179"></a>
-<span class="sourceLineNo">180</span>      builder.setColumnOffset(UnsafeByteOperations.unsafeWrap(this.columnOffset));<a name="line.180"></a>
-<span class="sourceLineNo">181</span>    }<a name="line.181"></a>
-<span class="sourceLineNo">182</span>    return builder.build().toByteArray();<a name="line.182"></a>
-<span class="sourceLineNo">183</span>  }<a name="line.183"></a>
-<span class="sourceLineNo">184</span><a name="line.184"></a>
-<span class="sourceLineNo">185</span>  /**<a name="line.185"></a>
-<span class="sourceLineNo">186</span>   * @param pbBytes A pb serialized {@link ColumnPaginationFilter} instance<a name="line.186"></a>
-<span class="sourceLineNo">187</span>   * @return An instance of {@link ColumnPaginationFilter} made from &lt;code&gt;bytes&lt;/code&gt;<a name="line.187"></a>
-<span class="sourceLineNo">188</span>   * @throws DeserializationException<a name="line.188"></a>
-<span class="sourceLineNo">189</span>   * @see #toByteArray<a name="line.189"></a>
-<span class="sourceLineNo">190</span>   */<a name="line.190"></a>
-<span class="sourceLineNo">191</span>  public static ColumnPaginationFilter parseFrom(final byte [] pbBytes)<a name="line.191"></a>
-<span class="sourceLineNo">192</span>  throws DeserializationException {<a name="line.192"></a>
-<span class="sourceLineNo">193</span>    FilterProtos.ColumnPaginationFilter proto;<a name="line.193"></a>
-<span class="sourceLineNo">194</span>    try {<a name="line.194"></a>
-<span class="sourceLineNo">195</span>      proto = FilterProtos.ColumnPaginationFilter.parseFrom(pbBytes);<a name="line.195"></a>
-<span class="sourceLineNo">196</span>    } catch (InvalidProtocolBufferException e) {<a name="line.196"></a>
-<span class="sourceLineNo">197</span>      throw new DeserializationException(e);<a name="line.197"></a>
-<span class="sourceLineNo">198</span>    }<a name="line.198"></a>
-<span class="sourceLineNo">199</span>    if (proto.hasColumnOffset()) {<a name="line.199"></a>
-<span class="sourceLineNo">200</span>      return new ColumnPaginationFilter(proto.getLimit(),<a name="line.200"></a>
-<span class="sourceLineNo">201</span>                                        proto.getColumnOffset().toByteArray());<a name="line.201"></a>
-<span class="sourceLineNo">202</span>    }<a name="line.202"></a>
-<span class="sourceLineNo">203</span>    return new ColumnPaginationFilter(proto.getLimit(),proto.getOffset());<a name="line.203"></a>
-<span class="sourceLineNo">204</span>  }<a name="line.204"></a>
-<span class="sourceLineNo">205</span><a name="line.205"></a>
-<span class="sourceLineNo">206</span>  /**<a name="line.206"></a>
-<span class="sourceLineNo">207</span>   * @param o the other filter to compare with<a name="line.207"></a>
-<span class="sourceLineNo">208</span>   * @return true if and only if the fields of the filter that are serialized<a name="line.208"></a>
-<span class="sourceLineNo">209</span>   * are equal to the corresponding fields in other.  Used for testing.<a name="line.209"></a>
-<span class="sourceLineNo">210</span>   */<a name="line.210"></a>
-<span class="sourceLineNo">211</span>  @Override<a name="line.211"></a>
-<span class="sourceLineNo">212</span>  boolean areSerializedFieldsEqual(Filter o) {<a name="line.212"></a>
-<span class="sourceLineNo">213</span>    if (o == this) return true;<a name="line.213"></a>
-<span class="sourceLineNo">214</span>    if (!(o instanceof ColumnPaginationFilter)) return false;<a name="line.214"></a>
-<span class="sourceLineNo">215</span><a name="line.215"></a>
-<span class="sourceLineNo">216</span>    ColumnPaginationFilter other = (ColumnPaginationFilter)o;<a name="line.216"></a>
-<span class="sourceLineNo">217</span>    if (this.columnOffset != null) {<a name="line.217"></a>
-<span class="sourceLineNo">218</span>      return this.getLimit() == other.getLimit() &amp;&amp;<a name="line.218"></a>
-<span class="sourceLineNo">219</span>          Bytes.equals(this.getColumnOffset(), other.getColumnOffset());<a name="line.219"></a>
-<span class="sourceLineNo">220</span>    }<a name="line.220"></a>
-<span class="sourceLineNo">221</span>    return this.getLimit() == other.getLimit() &amp;&amp; this.getOffset() == other.getOffset();<a name="line.221"></a>
-<span class="sourceLineNo">222</span>  }<a name="line.222"></a>
-<span class="sourceLineNo">223</span><a name="line.223"></a>
-<span class="sourceLineNo">224</span>  @Override<a name="line.224"></a>
-<span class="sourceLineNo">225</span>  public String toString() {<a name="line.225"></a>
-<span class="sourceLineNo">226</span>    if (this.columnOffset != null) {<a name="line.226"></a>
-<span class="sourceLineNo">227</span>      return (this.getClass().getSimpleName() + "(" + this.limit + ", " +<a name="line.227"></a>
-<span class="sourceLineNo">228</span>          Bytes.toStringBinary(this.columnOffset) + ")");<a name="line.228"></a>
-<span class="sourceLineNo">229</span>    }<a name="line.229"></a>
-<span class="sourceLineNo">230</span>    return String.format("%s (%d, %d)", this.getClass().getSimpleName(),<a name="line.230"></a>
-<span class="sourceLineNo">231</span>        this.limit, this.offset);<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">023</span>import java.util.Objects;<a name="line.23"></a>
+<span class="sourceLineNo">024</span><a name="line.24"></a>
+<span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.Cell;<a name="line.25"></a>
+<span class="sourceLineNo">026</span>import org.apache.hadoop.hbase.CellUtil;<a name="line.26"></a>
+<span class="sourceLineNo">027</span>import org.apache.hadoop.hbase.PrivateCellUtil;<a name="line.27"></a>
+<span class="sourceLineNo">028</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.28"></a>
+<span class="sourceLineNo">029</span>import org.apache.hadoop.hbase.exceptions.DeserializationException;<a name="line.29"></a>
+<span class="sourceLineNo">030</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.FilterProtos;<a name="line.30"></a>
+<span class="sourceLineNo">031</span>import org.apache.hadoop.hbase.util.Bytes;<a name="line.31"></a>
+<span class="sourceLineNo">032</span><a name="line.32"></a>
+<span class="sourceLineNo">033</span>import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;<a name="line.33"></a>
+<span class="sourceLineNo">034</span>import org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;<a name="line.34"></a>
+<span class="sourceLineNo">035</span>import org.apache.hbase.thirdparty.com.google.protobuf.UnsafeByteOperations;<a name="line.35"></a>
+<span class="sourceLineNo">036</span><a name="line.36"></a>
+<span class="sourceLineNo">037</span>/**<a name="line.37"></a>
+<span class="sourceLineNo">038</span> * A filter, based on the ColumnCountGetFilter, takes two arguments: limit and offset.<a name="line.38"></a>
+<span class="sourceLineNo">039</span> * This filter can be used for row-based indexing, where references to other tables are stored across many columns,<a name="line.39"></a>
+<span class="sourceLineNo">040</span> * in order to efficient lookups and paginated results for end users. Only most recent versions are considered<a name="line.40"></a>
+<span class="sourceLineNo">041</span> * for pagination.<a name="line.41"></a>
+<span class="sourceLineNo">042</span> */<a name="line.42"></a>
+<span class="sourceLineNo">043</span>@InterfaceAudience.Public<a name="line.43"></a>
+<span class="sourceLineNo">044</span>public class ColumnPaginationFilter extends FilterBase {<a name="line.44"></a>
+<span class="sourceLineNo">045</span><a name="line.45"></a>
+<span class="sourceLineNo">046</span>  private int limit = 0;<a name="line.46"></a>
+<span class="sourceLineNo">047</span>  private int offset = -1;<a name="line.47"></a>
+<span class="sourceLineNo">048</span>  private byte[] columnOffset = null;<a name="line.48"></a>
+<span class="sourceLineNo">049</span>  private int count = 0;<a name="line.49"></a>
+<span class="sourceLineNo">050</span><a name="line.50"></a>
+<span class="sourceLineNo">051</span>  /**<a name="line.51"></a>
+<span class="sourceLineNo">052</span>   * Initializes filter with an integer offset and limit. The offset is arrived at<a name="line.52"></a>
+<span class="sourceLineNo">053</span>   * scanning sequentially and skipping entries. @limit number of columns are<a name="line.53"></a>
+<span class="sourceLineNo">054</span>   * then retrieved. If multiple column families are involved, the columns may be spread<a name="line.54"></a>
+<span class="sourceLineNo">055</span>   * across them.<a name="line.55"></a>
+<span class="sourceLineNo">056</span>   *<a name="line.56"></a>
+<span class="sourceLineNo">057</span>   * @param limit Max number of columns to return.<a name="line.57"></a>
+<span class="sourceLineNo">058</span>   * @param offset The integer offset where to start pagination.<a name="line.58"></a>
+<span class="sourceLineNo">059</span>   */<a name="line.59"></a>
+<span class="sourceLineNo">060</span>  public ColumnPaginationFilter(final int limit, final int offset)<a name="line.60"></a>
+<span class="sourceLineNo">061</span>  {<a name="line.61"></a>
+<span class="sourceLineNo">062</span>    Preconditions.checkArgument(limit &gt;= 0, "limit must be positive %s", limit);<a name="line.62"></a>
+<span class="sourceLineNo">063</span>    Preconditions.checkArgument(offset &gt;= 0, "offset must be positive %s", offset);<a name="line.63"></a>
+<span class="sourceLineNo">064</span>    this.limit = limit;<a name="line.64"></a>
+<span class="sourceLineNo">065</span>    this.offset = offset;<a name="line.65"></a>
+<span class="sourceLineNo">066</span>  }<a name="line.66"></a>
+<span class="sourceLineNo">067</span><a name="line.67"></a>
+<span class="sourceLineNo">068</span>  /**<a name="line.68"></a>
+<span class="sourceLineNo">069</span>   * Initializes filter with a string/bookmark based offset and limit. The offset is arrived<a name="line.69"></a>
+<span class="sourceLineNo">070</span>   * at, by seeking to it using scanner hints. If multiple column families are involved,<a name="line.70"></a>
+<span class="sourceLineNo">071</span>   * pagination starts at the first column family which contains @columnOffset. Columns are<a name="line.71"></a>
+<span class="sourceLineNo">072</span>   * then retrieved sequentially upto @limit number of columns which maybe spread across<a name="line.72"></a>
+<span class="sourceLineNo">073</span>   * multiple column families, depending on how the scan is setup.<a name="line.73"></a>
+<span class="sourceLineNo">074</span>   *<a name="line.74"></a>
+<span class="sourceLineNo">075</span>   * @param limit Max number of columns to return.<a name="line.75"></a>
+<span class="sourceLineNo">076</span>   * @param columnOffset The string/bookmark offset on where to start pagination.<a name="line.76"></a>
+<span class="sourceLineNo">077</span>   */<a name="line.77"></a>
+<span class="sourceLineNo">078</span>  public ColumnPaginationFilter(final int limit, final byte[] columnOffset) {<a name="line.78"></a>
+<span class="sourceLineNo">079</span>    Preconditions.checkArgument(limit &gt;= 0, "limit must be positive %s", limit);<a name="line.79"></a>
+<span class="sourceLineNo">080</span>    Preconditions.checkArgument(columnOffset != null,<a name="line.80"></a>
+<span class="sourceLineNo">081</span>                                "columnOffset must be non-null %s",<a name="line.81"></a>
+<span class="sourceLineNo">082</span>                                columnOffset);<a name="line.82"></a>
+<span class="sourceLineNo">083</span>    this.limit = limit;<a name="line.83"></a>
+<span class="sourceLineNo">084</span>    this.columnOffset = columnOffset;<a name="line.84"></a>
+<span class="sourceLineNo">085</span>  }<a name="line.85"></a>
+<span class="sourceLineNo">086</span><a name="line.86"></a>
+<span class="sourceLineNo">087</span>  /**<a name="line.87"></a>
+<span class="sourceLineNo">088</span>   * @return limit<a name="line.88"></a>
+<span class="sourceLineNo">089</span>   */<a name="line.89"></a>
+<span class="sourceLineNo">090</span>  public int getLimit() {<a name="line.90"></a>
+<span class="sourceLineNo">091</span>    return limit;<a name="line.91"></a>
+<span class="sourceLineNo">092</span>  }<a name="line.92"></a>
+<span class="sourceLineNo">093</span><a name="line.93"></a>
+<span class="sourceLineNo">094</span>  /**<a name="line.94"></a>
+<span class="sourceLineNo">095</span>   * @return offset<a name="line.95"></a>
+<span class="sourceLineNo">096</span>   */<a name="line.96"></a>
+<span class="sourceLineNo">097</span>  public int getOffset() {<a name="line.97"></a>
+<span class="sourceLineNo">098</span>    return offset;<a name="line.98"></a>
+<span class="sourceLineNo">099</span>  }<a name="line.99"></a>
+<span class="sourceLineNo">100</span><a name="line.100"></a>
+<span class="sourceLineNo">101</span>  /**<a name="line.101"></a>
+<span class="sourceLineNo">102</span>   * @return columnOffset<a name="line.102"></a>
+<span class="sourceLineNo">103</span>   */<a name="line.103"></a>
+<span class="sourceLineNo">104</span>  public byte[] getColumnOffset() {<a name="line.104"></a>
+<span class="sourceLineNo">105</span>    return columnOffset;<a name="line.105"></a>
+<span class="sourceLineNo">106</span>  }<a name="line.106"></a>
+<span class="sourceLineNo">107</span><a name="line.107"></a>
+<span class="sourceLineNo">108</span>  @Override<a name="line.108"></a>
+<span class="sourceLineNo">109</span>  public boolean filterRowKey(Cell cell) throws IOException {<a name="line.109"></a>
+<span class="sourceLineNo">110</span>    // Impl in FilterBase might do unnecessary copy for Off heap backed Cells.<a name="line.110"></a>
+<span class="sourceLineNo">111</span>    return false;<a name="line.111"></a>
+<span class="sourceLineNo">112</span>  }<a name="line.112"></a>
+<span class="sourceLineNo">113</span><a name="line.113"></a>
+<span class="sourceLineNo">114</span>  @Override<a name="line.114"></a>
+<span class="sourceLineNo">115</span>  @Deprecated<a name="line.115"></a>
+<span class="sourceLineNo">116</span>  public ReturnCode filterKeyValue(final Cell c) {<a name="line.116"></a>
+<span class="sourceLineNo">117</span>    return filterCell(c);<a name="line.117"></a>
+<span class="sourceLineNo">118</span>  }<a name="line.118"></a>
+<span class="sourceLineNo">119</span><a name="line.119"></a>
+<span class="sourceLineNo">120</span>  @Override<a name="line.120"></a>
+<span class="sourceLineNo">121</span>  public ReturnCode filterCell(final Cell c)<a name="line.121"></a>
+<span class="sourceLineNo">122</span>  {<a name="line.122"></a>
+<span class="sourceLineNo">123</span>    if (columnOffset != null) {<a name="line.123"></a>
+<span class="sourceLineNo">124</span>      if (count &gt;= limit) {<a name="line.124"></a>
+<span class="sourceLineNo">125</span>        return ReturnCode.NEXT_ROW;<a name="line.125"></a>
+<span class="sourceLineNo">126</span>      }<a name="line.126"></a>
+<span class="sourceLineNo">127</span>      int cmp = 0;<a name="line.127"></a>
+<span class="sourceLineNo">128</span>      // Only compare if no KV's have been seen so far.<a name="line.128"></a>
+<span class="sourceLineNo">129</span>      if (count == 0) {<a name="line.129"></a>
+<span class="sourceLineNo">130</span>        cmp = CellUtil.compareQualifiers(c, this.columnOffset, 0, this.columnOffset.length);<a name="line.130"></a>
+<span class="sourceLineNo">131</span>      }<a name="line.131"></a>
+<span class="sourceLineNo">132</span>      if (cmp &lt; 0) {<a name="line.132"></a>
+<span class="sourceLineNo">133</span>        return ReturnCode.SEEK_NEXT_USING_HINT;<a name="line.133"></a>
+<span class="sourceLineNo">134</span>      } else {<a name="line.134"></a>
+<span class="sourceLineNo">135</span>        count++;<a name="line.135"></a>
+<span class="sourceLineNo">136</span>        return ReturnCode.INCLUDE_AND_NEXT_COL;<a name="line.136"></a>
+<span class="sourceLineNo">137</span>      }<a name="line.137"></a>
+<span class="sourceLineNo">138</span>    } else {<a name="line.138"></a>
+<span class="sourceLineNo">139</span>      if (count &gt;= offset + limit) {<a name="line.139"></a>
+<span class="sourceLineNo">140</span>        return ReturnCode.NEXT_ROW;<a name="line.140"></a>
+<span class="sourceLineNo">141</span>      }<a name="line.141"></a>
+<span class="sourceLineNo">142</span><a name="line.142"></a>
+<span class="sourceLineNo">143</span>      ReturnCode code = count &lt; offset ? ReturnCode.NEXT_COL :<a name="line.143"></a>
+<span class="sourceLineNo">144</span>                                         ReturnCode.INCLUDE_AND_NEXT_COL;<a name="line.144"></a>
+<span class="sourceLineNo">145</span>      count++;<a name="line.145"></a>
+<span class="sourceLineNo">146</span>      return code;<a name="line.146"></a>
+<span class="sourceLineNo">147</span>    }<a name="line.147"></a>
+<span class="sourceLineNo">148</span>  }<a name="line.148"></a>
+<span class="sourceLineNo">149</span><a name="line.149"></a>
+<span class="sourceLineNo">150</span>  @Override<a name="line.150"></a>
+<span class="sourceLineNo">151</span>  public Cell getNextCellHint(Cell cell) {<a name="line.151"></a>
+<span class="sourceLineNo">152</span>    return PrivateCellUtil.createFirstOnRowCol(cell, columnOffset, 0, columnOffset.length);<a name="line.152"></a>
+<span class="sourceLineNo">153</span>  }<a name="line.153"></a>
+<span class="sourceLineNo">154</span><a name="line.154"></a>
+<span class="sourceLineNo">155</span>  @Override<a name="line.155"></a>
+<span class="sourceLineNo">156</span>  public void reset()<a name="line.156"></a>
+<span class="sourceLineNo">157</span>  {<a name="line.157"></a>
+<span class="sourceLineNo">158</span>    this.count = 0;<a name="line.158"></a>
+<span class="sourceLineNo">159</span>  }<a name="line.159"></a>
+<span class="sourceLineNo">160</span><a name="line.160"></a>
+<span class="sourceLineNo">161</span>  public static Filter createFilterFromArguments(ArrayList&lt;byte []&gt; filterArguments) {<a name="line.161"></a>
+<span class="sourceLineNo">162</span>    Preconditions.checkArgument(filterArguments.size() == 2,<a name="line.162"></a>
+<span class="sourceLineNo">163</span>                                "Expected 2 but got: %s", filterArguments.size());<a name="line.163"></a>
+<span class="sourceLineNo">164</span>    int limit = ParseFilter.convertByteArrayToInt(filterArguments.get(0));<a name="line.164"></a>
+<span class="sourceLineNo">165</span>    int offset = ParseFilter.convertByteArrayToInt(filterArguments.get(1));<a name="line.165"></a>
+<span class="sourceLineNo">166</span>    return new ColumnPaginationFilter(limit, offset);<a name="line.166"></a>
+<span class="sourceLineNo">167</span>  }<a name="line.167"></a>
+<span class="sourceLineNo">168</span><a name="line.168"></a>
+<span class="sourceLineNo">169</span>  /**<a name="line.169"></a>
+<span class="sourceLineNo">170</span>   * @return The filter serialized using pb<a name="line.170"></a>
+<span class="sourceLineNo">171</span>   */<a name="line.171"></a>
+<span class="sourceLineNo">172</span>  @Override<a name="line.172"></a>
+<span class="sourceLineNo">173</span>  public byte [] toByteArray() {<a name="line.173"></a>
+<span class="sourceLineNo">174</span>    FilterProtos.ColumnPaginationFilter.Builder builder =<a name="line.174"></a>
+<span class="sourceLineNo">175</span>      FilterProtos.ColumnPaginationFilter.newBuilder();<a name="line.175"></a>
+<span class="sourceLineNo">176</span>    builder.setLimit(this.limit);<a name="line.176"></a>
+<span class="sourceLineNo">177</span>    if (this.offset &gt;= 0) {<a name="line.177"></a>
+<span class="sourceLineNo">178</span>      builder.setOffset(this.offset);<a name="line.178"></a>
+<span class="sourceLineNo">179</span>    }<a name="line.179"></a>
+<span class="sourceLineNo">180</span>    if (this.columnOffset != null) {<a name="line.180"></a>
+<span class="sourceLineNo">181</span>      builder.setColumnOffset(UnsafeByteOperations.unsafeWrap(this.columnOffset));<a name="line.181"></a>
+<span class="sourceLineNo">182</span>    }<a name="line.182"></a>
+<span class="sourceLineNo">183</span>    return builder.build().toByteArray();<a name="line.183"></a>
+<span class="sourceLineNo">184</span>  }<a name="line.184"></a>
+<span class="sourceLineNo">185</span><a name="line.185"></a>
+<span class="sourceLineNo">186</span>  /**<a name="line.186"></a>
+<span class="sourceLineNo">187</span>   * @param pbBytes A pb serialized {@link ColumnPaginationFilter} instance<a name="line.187"></a>
+<span class="sourceLineNo">188</span>   * @return An instance of {@link ColumnPaginationFilter} made from &lt;code&gt;bytes&lt;/code&gt;<a name="line.188"></a>
+<span class="sourceLineNo">189</span>   * @throws DeserializationException<a name="line.189"></a>
+<span class="sourceLineNo">190</span>   * @see #toByteArray<a name="line.190"></a>
+<span class="sourceLineNo">191</span>   */<a name="line.191"></a>
+<span class="sourceLineNo">192</span>  public static ColumnPaginationFilter parseFrom(final byte [] pbBytes)<a name="line.192"></a>
+<span class="sourceLineNo">193</span>  throws DeserializationException {<a name="line.193"></a>
+<span class="sourceLineNo">194</span>    FilterProtos.ColumnPaginationFilter proto;<a name="line.194"></a>
+<span class="sourceLineNo">195</span>    try {<a name="line.195"></a>
+<span class="sourceLineNo">196</span>      proto = FilterProtos.ColumnPaginationFilter.parseFrom(pbBytes);<a name="line.196"></a>
+<span class="sourceLineNo">197</span>    } catch (InvalidProtocolBufferException e) {<a name="line.197"></a>
+<span class="sourceLineNo">198</span>      throw new DeserializationException(e);<a name="line.198"></a>
+<span class="sourceLineNo">199</span>    }<a name="line.199"></a>
+<span class="sourceLineNo">200</span>    if (proto.hasColumnOffset()) {<a name="line.200"></a>
+<span class="sourceLineNo">201</span>      return new ColumnPaginationFilter(proto.getLimit(),<a name="line.201"></a>
+<span class="sourceLineNo">202</span>                                        proto.getColumnOffset().toByteArray());<a name="line.202"></a>
+<span class="sourceLineNo">203</span>    }<a name="line.203"></a>
+<span class="sourceLineNo">204</span>    return new ColumnPaginationFilter(proto.getLimit(),proto.getOffset());<a name="line.204"></a>
+<span class="sourceLineNo">205</span>  }<a name="line.205"></a>
+<span class="sourceLineNo">206</span><a name="line.206"></a>
+<span class="sourceLineNo">207</span>  /**<a name="line.207"></a>
+<span class="sourceLineNo">208</span>   * @param o the other filter to compare with<a name="line.208"></a>
+<span class="sourceLineNo">209</span>   * @return true if and only if the fields of the filter that are serialized<a name="line.209"></a>
+<span class="sourceLineNo">210</span>   * are equal to the corresponding fields in other.  Used for testing.<a name="line.210"></a>
+<span class="sourceLineNo">211</span>   */<a name="line.211"></a>
+<span class="sourceLineNo">212</span>  @Override<a name="line.212"></a>
+<span class="sourceLineNo">213</span>  boolean areSerializedFieldsEqual(Filter o) {<a name="line.213"></a>
+<span class="sourceLineNo">214</span>    if (o == this) return true;<a name="line.214"></a>
+<span class="sourceLineNo">215</span>    if (!(o instanceof ColumnPaginationFilter)) return false;<a name="line.215"></a>
+<span class="sourceLineNo">216</span><a name="line.216"></a>
+<span class="sourceLineNo">217</span>    ColumnPaginationFilter other = (ColumnPaginationFilter)o;<a name="line.217"></a>
+<span class="sourceLineNo">218</span>    if (this.columnOffset != null) {<a name="line.218"></a>
+<span class="sourceLineNo">219</span>      return this.getLimit() == other.getLimit() &amp;&amp;<a name="line.219"></a>
+<span class="sourceLineNo">220</span>          Bytes.equals(this.getColumnOffset(), other.getColumnOffset());<a name="line.220"></a>
+<span class="sourceLineNo">221</span>    }<a name="line.221"></a>
+<span class="sourceLineNo">222</span>    return this.getLimit() == other.getLimit() &amp;&amp; this.getOffset() == other.getOffset();<a name="line.222"></a>
+<span class="sourceLineNo">223</span>  }<a name="line.223"></a>
+<span class="sourceLineNo">224</span><a name="line.224"></a>
+<span class="sourceLineNo">225</span>  @Override<a name="line.225"></a>
+<span class="sourceLineNo">226</span>  public String toString() {<a name="line.226"></a>
+<span class="sourceLineNo">227</span>    if (this.columnOffset != null) {<a name="line.227"></a>
+<span class="sourceLineNo">228</span>      return (this.getClass().getSimpleName() + "(" + this.limit + ", " +<a name="line.228"></a>
+<span class="sourceLineNo">229</span>          Bytes.toStringBinary(this.columnOffset) + ")");<a name="line.229"></a>
+<span class="sourceLineNo">230</span>    }<a name="line.230"></a>
+<span class="sourceLineNo">231</span>    return String.format("%s (%d, %d)", this.getClass().getSimpleName(),<a name="line.231"></a>
+<span class="sourceLineNo">232</span>        this.limit, this.offset);<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>  @Override<a name="line.235"></a>
+<span class="sourceLineNo">236</span>  public boolean equals(Object obj) {<a name="line.236"></a>
+<span class="sourceLineNo">237</span>    if (obj == null || (!(obj instanceof ColumnPaginationFilter))) {<a name="line.237"></a>
+<span class="sourceLineNo">238</span>      return false;<a name="line.238"></a>
+<span class="sourceLineNo">239</span>    }<a name="line.239"></a>
+<span class="sourceLineNo">240</span>    ColumnPaginationFilter f = (ColumnPaginationFilter) obj;<a name="line.240"></a>
+<span class="sourceLineNo">241</span>    return this.areSerializedFieldsEqual(f);<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>  @Override<a name="line.244"></a>
+<span class="sourceLineNo">245</span>  public int hashCode() {<a name="line.245"></a>
+<span class="sourceLineNo">246</span>    return Objects.hash(this.limit, this.offset);<a name="line.246"></a>
+<span class="sourceLineNo">247</span>  }<a name="line.247"></a>
+<span class="sourceLineNo">248</span>}<a name="line.248"></a>