http://git-wip-us.apache.org/repos/asf/hbase-site/blob/96e5e102/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.ProgressFields.html
----------------------------------------------------------------------
diff --git
a/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.ProgressFields.html
b/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.ProgressFields.html
new file mode 100644
index 0000000..03a0b2a
--- /dev/null
+++
b/devapidocs/src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.ProgressFields.html
@@ -0,0 +1,830 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html lang="en">
+<head>
+<title>Source code</title>
+<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css"
title="Style">
+</head>
+<body>
+<div class="sourceContainer">
+<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a>
+<span class="sourceLineNo">002</span> * Licensed to the Apache Software
Foundation (ASF) under one<a name="line.2"></a>
+<span class="sourceLineNo">003</span> * or more contributor license
agreements. See the NOTICE file<a name="line.3"></a>
+<span class="sourceLineNo">004</span> * distributed with this work for
additional information<a name="line.4"></a>
+<span class="sourceLineNo">005</span> * regarding copyright ownership. The
ASF licenses this file<a name="line.5"></a>
+<span class="sourceLineNo">006</span> * to you under the Apache License,
Version 2.0 (the<a name="line.6"></a>
+<span class="sourceLineNo">007</span> * "License"); you may not use this file
except in compliance<a name="line.7"></a>
+<span class="sourceLineNo">008</span> * with the License. You may obtain a
copy of the License at<a name="line.8"></a>
+<span class="sourceLineNo">009</span> *<a name="line.9"></a>
+<span class="sourceLineNo">010</span> *
http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
+<span class="sourceLineNo">011</span> *<a name="line.11"></a>
+<span class="sourceLineNo">012</span> * Unless required by applicable law or
agreed to in writing, software<a name="line.12"></a>
+<span class="sourceLineNo">013</span> * distributed under the License is
distributed on an "AS IS" BASIS,<a name="line.13"></a>
+<span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF
ANY KIND, either express or implied.<a name="line.14"></a>
+<span class="sourceLineNo">015</span> * See the License for the specific
language governing permissions and<a name="line.15"></a>
+<span class="sourceLineNo">016</span> * limitations under the License.<a
name="line.16"></a>
+<span class="sourceLineNo">017</span> */<a name="line.17"></a>
+<span class="sourceLineNo">018</span>package
org.apache.hadoop.hbase.regionserver;<a name="line.18"></a>
+<span class="sourceLineNo">019</span><a name="line.19"></a>
+<span class="sourceLineNo">020</span>import java.util.List;<a
name="line.20"></a>
+<span class="sourceLineNo">021</span><a name="line.21"></a>
+<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.Cell;<a
name="line.22"></a>
+<span class="sourceLineNo">023</span>import
org.apache.hadoop.hbase.HBaseInterfaceAudience;<a name="line.23"></a>
+<span class="sourceLineNo">024</span>import
org.apache.yetus.audience.InterfaceAudience;<a name="line.24"></a>
+<span class="sourceLineNo">025</span>import
org.apache.yetus.audience.InterfaceStability;<a name="line.25"></a>
+<span class="sourceLineNo">026</span>import
org.apache.hadoop.hbase.client.metrics.ServerSideScanMetrics;<a
name="line.26"></a>
+<span class="sourceLineNo">027</span><a name="line.27"></a>
+<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
+<span class="sourceLineNo">029</span> * ScannerContext instances encapsulate
limit tracking AND progress towards those limits during<a name="line.29"></a>
+<span class="sourceLineNo">030</span> * invocations of {@link
InternalScanner#next(java.util.List)} and<a name="line.30"></a>
+<span class="sourceLineNo">031</span> * {@link
RegionScanner#next(java.util.List)}.<a name="line.31"></a>
+<span class="sourceLineNo">032</span> * <p><a name="line.32"></a>
+<span class="sourceLineNo">033</span> * A ScannerContext instance should be
updated periodically throughout execution whenever progress<a
name="line.33"></a>
+<span class="sourceLineNo">034</span> * towards a limit has been made. Each
limit can be checked via the appropriate checkLimit method.<a
name="line.34"></a>
+<span class="sourceLineNo">035</span> * <p><a name="line.35"></a>
+<span class="sourceLineNo">036</span> * Once a limit has been reached, the
scan will stop. The invoker of<a name="line.36"></a>
+<span class="sourceLineNo">037</span> * {@link
InternalScanner#next(java.util.List)} or {@link
RegionScanner#next(java.util.List)} can<a name="line.37"></a>
+<span class="sourceLineNo">038</span> * use the appropriate check*Limit
methods to see exactly which limits have been reached.<a name="line.38"></a>
+<span class="sourceLineNo">039</span> * Alternatively, {@link
#checkAnyLimitReached(LimitScope)} is provided to see if ANY limit was<a
name="line.39"></a>
+<span class="sourceLineNo">040</span> * reached<a name="line.40"></a>
+<span class="sourceLineNo">041</span> * <p><a name="line.41"></a>
+<span class="sourceLineNo">042</span> * {@link NoLimitScannerContext#NO_LIMIT}
is an immutable static definition that can be used<a name="line.42"></a>
+<span class="sourceLineNo">043</span> * whenever a {@link ScannerContext} is
needed but limits do not need to be enforced.<a name="line.43"></a>
+<span class="sourceLineNo">044</span> * <p><a name="line.44"></a>
+<span class="sourceLineNo">045</span> * NOTE: It is important that this class
only ever expose setter methods that can be safely skipped<a name="line.45"></a>
+<span class="sourceLineNo">046</span> * when limits should be NOT enforced.
This is because of the necessary immutability of the class<a name="line.46"></a>
+<span class="sourceLineNo">047</span> * {@link NoLimitScannerContext}. If a
setter cannot be safely skipped, the immutable nature of<a name="line.47"></a>
+<span class="sourceLineNo">048</span> * {@link NoLimitScannerContext} will
lead to incorrect behavior.<a name="line.48"></a>
+<span class="sourceLineNo">049</span> */<a name="line.49"></a>
+<span
class="sourceLineNo">050</span>@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)<a
name="line.50"></a>
+<span class="sourceLineNo">051</span>@InterfaceStability.Evolving<a
name="line.51"></a>
+<span class="sourceLineNo">052</span>public class ScannerContext {<a
name="line.52"></a>
+<span class="sourceLineNo">053</span><a name="line.53"></a>
+<span class="sourceLineNo">054</span> LimitFields limits;<a
name="line.54"></a>
+<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
+<span class="sourceLineNo">056</span> * A different set of progress fields.
Only include batch, dataSize and heapSize. Compare to<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * LimitFields, ProgressFields doesn't
contain time field. As we save a deadline in LimitFields,<a name="line.57"></a>
+<span class="sourceLineNo">058</span> * so use {@link
System#currentTimeMillis()} directly when check time limit.<a
name="line.58"></a>
+<span class="sourceLineNo">059</span> */<a name="line.59"></a>
+<span class="sourceLineNo">060</span> ProgressFields progress;<a
name="line.60"></a>
+<span class="sourceLineNo">061</span><a name="line.61"></a>
+<span class="sourceLineNo">062</span> /**<a name="line.62"></a>
+<span class="sourceLineNo">063</span> * The state of the scanner after the
invocation of {@link InternalScanner#next(java.util.List)}<a name="line.63"></a>
+<span class="sourceLineNo">064</span> * or {@link
RegionScanner#next(java.util.List)}.<a name="line.64"></a>
+<span class="sourceLineNo">065</span> */<a name="line.65"></a>
+<span class="sourceLineNo">066</span> NextState scannerState;<a
name="line.66"></a>
+<span class="sourceLineNo">067</span> private static final NextState
DEFAULT_STATE = NextState.MORE_VALUES;<a name="line.67"></a>
+<span class="sourceLineNo">068</span><a name="line.68"></a>
+<span class="sourceLineNo">069</span> /**<a name="line.69"></a>
+<span class="sourceLineNo">070</span> * Used as an indication to invocations
of {@link InternalScanner#next(java.util.List)} and<a name="line.70"></a>
+<span class="sourceLineNo">071</span> * {@link
RegionScanner#next(java.util.List)} that, if true, the progress tracked within
this<a name="line.71"></a>
+<span class="sourceLineNo">072</span> * {@link ScannerContext} instance
should be considered while evaluating the limits. Useful for<a
name="line.72"></a>
+<span class="sourceLineNo">073</span> * enforcing a set of limits across
multiple calls (i.e. the limit may not be reached in a single<a
name="line.73"></a>
+<span class="sourceLineNo">074</span> * invocation, but any progress made
should be considered in future invocations)<a name="line.74"></a>
+<span class="sourceLineNo">075</span> * <p><a name="line.75"></a>
+<span class="sourceLineNo">076</span> * Defaulting this value to false means
that, by default, any tracked progress will be wiped clean<a name="line.76"></a>
+<span class="sourceLineNo">077</span> * on invocations to {@link
InternalScanner#next(java.util.List)} and<a name="line.77"></a>
+<span class="sourceLineNo">078</span> * {@link
RegionScanner#next(java.util.List)} and the call will be treated as though no
progress<a name="line.78"></a>
+<span class="sourceLineNo">079</span> * has been made towards the limits so
far.<a name="line.79"></a>
+<span class="sourceLineNo">080</span> * <p><a name="line.80"></a>
+<span class="sourceLineNo">081</span> * This is an important mechanism.
Users of Internal/Region scanners expect that they can define<a
name="line.81"></a>
+<span class="sourceLineNo">082</span> * some limits and then repeatedly
invoke {@link InternalScanner#next(List)} or<a name="line.82"></a>
+<span class="sourceLineNo">083</span> * {@link RegionScanner#next(List)}
where each invocation respects these limits separately.<a name="line.83"></a>
+<span class="sourceLineNo">084</span> * <p><a name="line.84"></a>
+<span class="sourceLineNo">085</span> * For example: <pre> {@code<a
name="line.85"></a>
+<span class="sourceLineNo">086</span> * ScannerContext context = new
ScannerContext.newBuilder().setBatchLimit(5).build();<a name="line.86"></a>
+<span class="sourceLineNo">087</span> * RegionScanner scanner = ...<a
name="line.87"></a>
+<span class="sourceLineNo">088</span> * List<Cell> results = new
ArrayList<Cell>();<a name="line.88"></a>
+<span class="sourceLineNo">089</span> * while(scanner.next(results,
context)) {<a name="line.89"></a>
+<span class="sourceLineNo">090</span> * // Do something with a batch of 5
cells<a name="line.90"></a>
+<span class="sourceLineNo">091</span> * }<a name="line.91"></a>
+<span class="sourceLineNo">092</span> * }</pre> However, in the case
of RPCs, the server wants to be able to define a set of<a name="line.92"></a>
+<span class="sourceLineNo">093</span> * limits for a particular RPC request
and have those limits respected across multiple<a name="line.93"></a>
+<span class="sourceLineNo">094</span> * invocations. This means that the
progress made towards the limits in earlier calls will be<a name="line.94"></a>
+<span class="sourceLineNo">095</span> * saved and considered in future
invocations<a name="line.95"></a>
+<span class="sourceLineNo">096</span> */<a name="line.96"></a>
+<span class="sourceLineNo">097</span> boolean keepProgress;<a
name="line.97"></a>
+<span class="sourceLineNo">098</span> private static boolean
DEFAULT_KEEP_PROGRESS = false;<a name="line.98"></a>
+<span class="sourceLineNo">099</span><a name="line.99"></a>
+<span class="sourceLineNo">100</span> private Cell lastPeekedCell = null;<a
name="line.100"></a>
+<span class="sourceLineNo">101</span><a name="line.101"></a>
+<span class="sourceLineNo">102</span> /**<a name="line.102"></a>
+<span class="sourceLineNo">103</span> * Tracks the relevant server side
metrics during scans. null when metrics should not be tracked<a
name="line.103"></a>
+<span class="sourceLineNo">104</span> */<a name="line.104"></a>
+<span class="sourceLineNo">105</span> final ServerSideScanMetrics metrics;<a
name="line.105"></a>
+<span class="sourceLineNo">106</span><a name="line.106"></a>
+<span class="sourceLineNo">107</span> ScannerContext(boolean keepProgress,
LimitFields limitsToCopy, boolean trackMetrics) {<a name="line.107"></a>
+<span class="sourceLineNo">108</span> this.limits = new LimitFields();<a
name="line.108"></a>
+<span class="sourceLineNo">109</span> if (limitsToCopy != null) {<a
name="line.109"></a>
+<span class="sourceLineNo">110</span> this.limits.copy(limitsToCopy);<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> // Progress fields are initialized to
0<a name="line.113"></a>
+<span class="sourceLineNo">114</span> progress = new ProgressFields(0, 0,
0);<a name="line.114"></a>
+<span class="sourceLineNo">115</span><a name="line.115"></a>
+<span class="sourceLineNo">116</span> this.keepProgress = keepProgress;<a
name="line.116"></a>
+<span class="sourceLineNo">117</span> this.scannerState = DEFAULT_STATE;<a
name="line.117"></a>
+<span class="sourceLineNo">118</span> this.metrics = trackMetrics ? new
ServerSideScanMetrics() : null;<a name="line.118"></a>
+<span class="sourceLineNo">119</span> }<a name="line.119"></a>
+<span class="sourceLineNo">120</span><a name="line.120"></a>
+<span class="sourceLineNo">121</span> boolean isTrackingMetrics() {<a
name="line.121"></a>
+<span class="sourceLineNo">122</span> return this.metrics != null;<a
name="line.122"></a>
+<span class="sourceLineNo">123</span> }<a name="line.123"></a>
+<span class="sourceLineNo">124</span><a name="line.124"></a>
+<span class="sourceLineNo">125</span> /**<a name="line.125"></a>
+<span class="sourceLineNo">126</span> * Get the metrics instance. Should
only be called after a call to {@link #isTrackingMetrics()}<a
name="line.126"></a>
+<span class="sourceLineNo">127</span> * has been made to confirm that
metrics are indeed being tracked.<a name="line.127"></a>
+<span class="sourceLineNo">128</span> * @return {@link
ServerSideScanMetrics} instance that is tracking metrics for this scan<a
name="line.128"></a>
+<span class="sourceLineNo">129</span> */<a name="line.129"></a>
+<span class="sourceLineNo">130</span> ServerSideScanMetrics getMetrics() {<a
name="line.130"></a>
+<span class="sourceLineNo">131</span> assert isTrackingMetrics();<a
name="line.131"></a>
+<span class="sourceLineNo">132</span> return this.metrics;<a
name="line.132"></a>
+<span class="sourceLineNo">133</span> }<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">136</span> * @return true if the progress tracked
so far in this instance will be considered during an<a name="line.136"></a>
+<span class="sourceLineNo">137</span> * invocation of {@link
InternalScanner#next(java.util.List)} or<a name="line.137"></a>
+<span class="sourceLineNo">138</span> * {@link
RegionScanner#next(java.util.List)}. false when the progress tracked so far<a
name="line.138"></a>
+<span class="sourceLineNo">139</span> * should not be considered and
should instead be wiped away via {@link #clearProgress()}<a name="line.139"></a>
+<span class="sourceLineNo">140</span> */<a name="line.140"></a>
+<span class="sourceLineNo">141</span> boolean getKeepProgress() {<a
name="line.141"></a>
+<span class="sourceLineNo">142</span> return keepProgress;<a
name="line.142"></a>
+<span class="sourceLineNo">143</span> }<a name="line.143"></a>
+<span class="sourceLineNo">144</span><a name="line.144"></a>
+<span class="sourceLineNo">145</span> void setKeepProgress(boolean
keepProgress) {<a name="line.145"></a>
+<span class="sourceLineNo">146</span> this.keepProgress = keepProgress;<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> * Progress towards the batch limit has
been made. Increment internal tracking of batch progress<a name="line.150"></a>
+<span class="sourceLineNo">151</span> */<a name="line.151"></a>
+<span class="sourceLineNo">152</span> void incrementBatchProgress(int batch)
{<a name="line.152"></a>
+<span class="sourceLineNo">153</span> int currentBatch =
progress.getBatch();<a name="line.153"></a>
+<span class="sourceLineNo">154</span> progress.setBatch(currentBatch +
batch);<a name="line.154"></a>
+<span class="sourceLineNo">155</span> }<a name="line.155"></a>
+<span class="sourceLineNo">156</span><a name="line.156"></a>
+<span class="sourceLineNo">157</span> /**<a name="line.157"></a>
+<span class="sourceLineNo">158</span> * Progress towards the size limit has
been made. Increment internal tracking of size progress<a name="line.158"></a>
+<span class="sourceLineNo">159</span> */<a name="line.159"></a>
+<span class="sourceLineNo">160</span> void incrementSizeProgress(long
dataSize, long heapSize) {<a name="line.160"></a>
+<span class="sourceLineNo">161</span> long curDataSize =
progress.getDataSize();<a name="line.161"></a>
+<span class="sourceLineNo">162</span> progress.setDataSize(curDataSize +
dataSize);<a name="line.162"></a>
+<span class="sourceLineNo">163</span> long curHeapSize =
progress.getHeapSize();<a name="line.163"></a>
+<span class="sourceLineNo">164</span> progress.setHeapSize(curHeapSize +
heapSize);<a name="line.164"></a>
+<span class="sourceLineNo">165</span> }<a name="line.165"></a>
+<span class="sourceLineNo">166</span><a name="line.166"></a>
+<span class="sourceLineNo">167</span> int getBatchProgress() {<a
name="line.167"></a>
+<span class="sourceLineNo">168</span> return progress.getBatch();<a
name="line.168"></a>
+<span class="sourceLineNo">169</span> }<a name="line.169"></a>
+<span class="sourceLineNo">170</span><a name="line.170"></a>
+<span class="sourceLineNo">171</span> long getDataSizeProgress() {<a
name="line.171"></a>
+<span class="sourceLineNo">172</span> return progress.getDataSize();<a
name="line.172"></a>
+<span class="sourceLineNo">173</span> }<a name="line.173"></a>
+<span class="sourceLineNo">174</span><a name="line.174"></a>
+<span class="sourceLineNo">175</span> long getHeapSizeProgress() {<a
name="line.175"></a>
+<span class="sourceLineNo">176</span> return progress.getHeapSize();<a
name="line.176"></a>
+<span class="sourceLineNo">177</span> }<a name="line.177"></a>
+<span class="sourceLineNo">178</span><a name="line.178"></a>
+<span class="sourceLineNo">179</span> void setProgress(int batchProgress,
long sizeProgress, long heapSizeProgress) {<a name="line.179"></a>
+<span class="sourceLineNo">180</span> setBatchProgress(batchProgress);<a
name="line.180"></a>
+<span class="sourceLineNo">181</span> setSizeProgress(sizeProgress,
heapSizeProgress);<a name="line.181"></a>
+<span class="sourceLineNo">182</span> }<a name="line.182"></a>
+<span class="sourceLineNo">183</span><a name="line.183"></a>
+<span class="sourceLineNo">184</span> void setSizeProgress(long
dataSizeProgress, long heapSizeProgress) {<a name="line.184"></a>
+<span class="sourceLineNo">185</span>
progress.setDataSize(dataSizeProgress);<a name="line.185"></a>
+<span class="sourceLineNo">186</span>
progress.setHeapSize(heapSizeProgress);<a name="line.186"></a>
+<span class="sourceLineNo">187</span> }<a name="line.187"></a>
+<span class="sourceLineNo">188</span><a name="line.188"></a>
+<span class="sourceLineNo">189</span> void setBatchProgress(int
batchProgress) {<a name="line.189"></a>
+<span class="sourceLineNo">190</span> progress.setBatch(batchProgress);<a
name="line.190"></a>
+<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> * Clear away any progress that has
been made so far. All progress fields are reset to initial<a
name="line.194"></a>
+<span class="sourceLineNo">195</span> * values<a name="line.195"></a>
+<span class="sourceLineNo">196</span> */<a name="line.196"></a>
+<span class="sourceLineNo">197</span> void clearProgress() {<a
name="line.197"></a>
+<span class="sourceLineNo">198</span> progress.setFields(0, 0, 0);<a
name="line.198"></a>
+<span class="sourceLineNo">199</span> }<a name="line.199"></a>
+<span class="sourceLineNo">200</span><a name="line.200"></a>
+<span class="sourceLineNo">201</span> /**<a name="line.201"></a>
+<span class="sourceLineNo">202</span> * Note that this is not a typical
setter. This setter returns the {@link NextState} that was<a
name="line.202"></a>
+<span class="sourceLineNo">203</span> * passed in so that methods can be
invoked against the new state. Furthermore, this pattern<a name="line.203"></a>
+<span class="sourceLineNo">204</span> * allows the {@link
NoLimitScannerContext} to cleanly override this setter and simply return the<a
name="line.204"></a>
+<span class="sourceLineNo">205</span> * new state, thus preserving the
immutability of {@link NoLimitScannerContext}<a name="line.205"></a>
+<span class="sourceLineNo">206</span> * @param state<a name="line.206"></a>
+<span class="sourceLineNo">207</span> * @return The state that was passed
in.<a name="line.207"></a>
+<span class="sourceLineNo">208</span> */<a name="line.208"></a>
+<span class="sourceLineNo">209</span> NextState setScannerState(NextState
state) {<a name="line.209"></a>
+<span class="sourceLineNo">210</span> if (!NextState.isValidState(state))
{<a name="line.210"></a>
+<span class="sourceLineNo">211</span> throw new
IllegalArgumentException("Cannot set to invalid state: " + state);<a
name="line.211"></a>
+<span class="sourceLineNo">212</span> }<a name="line.212"></a>
+<span class="sourceLineNo">213</span><a name="line.213"></a>
+<span class="sourceLineNo">214</span> this.scannerState = state;<a
name="line.214"></a>
+<span class="sourceLineNo">215</span> return state;<a name="line.215"></a>
+<span class="sourceLineNo">216</span> }<a name="line.216"></a>
+<span class="sourceLineNo">217</span><a name="line.217"></a>
+<span class="sourceLineNo">218</span> /**<a name="line.218"></a>
+<span class="sourceLineNo">219</span> * @return true when we have more cells
for the current row. This usually because we have reached<a name="line.219"></a>
+<span class="sourceLineNo">220</span> * a limit in the middle of a
row<a name="line.220"></a>
+<span class="sourceLineNo">221</span> */<a name="line.221"></a>
+<span class="sourceLineNo">222</span> boolean mayHaveMoreCellsInRow() {<a
name="line.222"></a>
+<span class="sourceLineNo">223</span> return scannerState ==
NextState.SIZE_LIMIT_REACHED_MID_ROW ||<a name="line.223"></a>
+<span class="sourceLineNo">224</span> scannerState ==
NextState.TIME_LIMIT_REACHED_MID_ROW ||<a name="line.224"></a>
+<span class="sourceLineNo">225</span> scannerState ==
NextState.BATCH_LIMIT_REACHED;<a name="line.225"></a>
+<span class="sourceLineNo">226</span> }<a name="line.226"></a>
+<span class="sourceLineNo">227</span><a name="line.227"></a>
+<span class="sourceLineNo">228</span> /**<a name="line.228"></a>
+<span class="sourceLineNo">229</span> * @param checkerScope<a
name="line.229"></a>
+<span class="sourceLineNo">230</span> * @return true if the batch limit can
be enforced in the checker's scope<a name="line.230"></a>
+<span class="sourceLineNo">231</span> */<a name="line.231"></a>
+<span class="sourceLineNo">232</span> boolean hasBatchLimit(LimitScope
checkerScope) {<a name="line.232"></a>
+<span class="sourceLineNo">233</span> return
limits.canEnforceBatchLimitFromScope(checkerScope) && limits.getBatch()
> 0;<a name="line.233"></a>
+<span class="sourceLineNo">234</span> }<a name="line.234"></a>
+<span class="sourceLineNo">235</span><a name="line.235"></a>
+<span class="sourceLineNo">236</span> /**<a name="line.236"></a>
+<span class="sourceLineNo">237</span> * @param checkerScope<a
name="line.237"></a>
+<span class="sourceLineNo">238</span> * @return true if the size limit can
be enforced in the checker's scope<a name="line.238"></a>
+<span class="sourceLineNo">239</span> */<a name="line.239"></a>
+<span class="sourceLineNo">240</span> boolean hasSizeLimit(LimitScope
checkerScope) {<a name="line.240"></a>
+<span class="sourceLineNo">241</span> return
limits.canEnforceSizeLimitFromScope(checkerScope)<a name="line.241"></a>
+<span class="sourceLineNo">242</span> && (limits.getDataSize()
> 0 || limits.getHeapSize() > 0);<a name="line.242"></a>
+<span class="sourceLineNo">243</span> }<a name="line.243"></a>
+<span class="sourceLineNo">244</span><a name="line.244"></a>
+<span class="sourceLineNo">245</span> /**<a name="line.245"></a>
+<span class="sourceLineNo">246</span> * @param checkerScope<a
name="line.246"></a>
+<span class="sourceLineNo">247</span> * @return true if the time limit can
be enforced in the checker's scope<a name="line.247"></a>
+<span class="sourceLineNo">248</span> */<a name="line.248"></a>
+<span class="sourceLineNo">249</span> boolean hasTimeLimit(LimitScope
checkerScope) {<a name="line.249"></a>
+<span class="sourceLineNo">250</span> return
limits.canEnforceTimeLimitFromScope(checkerScope) && limits.getTime()
> 0;<a name="line.250"></a>
+<span class="sourceLineNo">251</span> }<a name="line.251"></a>
+<span class="sourceLineNo">252</span><a name="line.252"></a>
+<span class="sourceLineNo">253</span> /**<a name="line.253"></a>
+<span class="sourceLineNo">254</span> * @param checkerScope<a
name="line.254"></a>
+<span class="sourceLineNo">255</span> * @return true if any limit can be
enforced within the checker's scope<a name="line.255"></a>
+<span class="sourceLineNo">256</span> */<a name="line.256"></a>
+<span class="sourceLineNo">257</span> boolean hasAnyLimit(LimitScope
checkerScope) {<a name="line.257"></a>
+<span class="sourceLineNo">258</span> return hasBatchLimit(checkerScope) ||
hasSizeLimit(checkerScope) || hasTimeLimit(checkerScope);<a name="line.258"></a>
+<span class="sourceLineNo">259</span> }<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> * @param scope The scope in which the
size limit will be enforced<a name="line.262"></a>
+<span class="sourceLineNo">263</span> */<a name="line.263"></a>
+<span class="sourceLineNo">264</span> void setSizeLimitScope(LimitScope
scope) {<a name="line.264"></a>
+<span class="sourceLineNo">265</span> limits.setSizeScope(scope);<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> /**<a name="line.268"></a>
+<span class="sourceLineNo">269</span> * @param scope The scope in which the
time limit will be enforced<a name="line.269"></a>
+<span class="sourceLineNo">270</span> */<a name="line.270"></a>
+<span class="sourceLineNo">271</span> void setTimeLimitScope(LimitScope
scope) {<a name="line.271"></a>
+<span class="sourceLineNo">272</span> limits.setTimeScope(scope);<a
name="line.272"></a>
+<span class="sourceLineNo">273</span> }<a name="line.273"></a>
+<span class="sourceLineNo">274</span><a name="line.274"></a>
+<span class="sourceLineNo">275</span> int getBatchLimit() {<a
name="line.275"></a>
+<span class="sourceLineNo">276</span> return limits.getBatch();<a
name="line.276"></a>
+<span class="sourceLineNo">277</span> }<a name="line.277"></a>
+<span class="sourceLineNo">278</span><a name="line.278"></a>
+<span class="sourceLineNo">279</span> long getDataSizeLimit() {<a
name="line.279"></a>
+<span class="sourceLineNo">280</span> return limits.getDataSize();<a
name="line.280"></a>
+<span class="sourceLineNo">281</span> }<a name="line.281"></a>
+<span class="sourceLineNo">282</span><a name="line.282"></a>
+<span class="sourceLineNo">283</span> long getTimeLimit() {<a
name="line.283"></a>
+<span class="sourceLineNo">284</span> return limits.getTime();<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> /**<a name="line.287"></a>
+<span class="sourceLineNo">288</span> * @param checkerScope The scope that
the limit is being checked from<a name="line.288"></a>
+<span class="sourceLineNo">289</span> * @return true when the limit is
enforceable from the checker's scope and it has been reached<a
name="line.289"></a>
+<span class="sourceLineNo">290</span> */<a name="line.290"></a>
+<span class="sourceLineNo">291</span> boolean checkBatchLimit(LimitScope
checkerScope) {<a name="line.291"></a>
+<span class="sourceLineNo">292</span> return hasBatchLimit(checkerScope)
&& progress.getBatch() >= limits.getBatch();<a name="line.292"></a>
+<span class="sourceLineNo">293</span> }<a name="line.293"></a>
+<span class="sourceLineNo">294</span><a name="line.294"></a>
+<span class="sourceLineNo">295</span> /**<a name="line.295"></a>
+<span class="sourceLineNo">296</span> * @param checkerScope The scope that
the limit is being checked from<a name="line.296"></a>
+<span class="sourceLineNo">297</span> * @return true when the limit is
enforceable from the checker's scope and it has been reached<a
name="line.297"></a>
+<span class="sourceLineNo">298</span> */<a name="line.298"></a>
+<span class="sourceLineNo">299</span> boolean checkSizeLimit(LimitScope
checkerScope) {<a name="line.299"></a>
+<span class="sourceLineNo">300</span> return hasSizeLimit(checkerScope)
&& (progress.getDataSize() >= limits.getDataSize()<a
name="line.300"></a>
+<span class="sourceLineNo">301</span> || progress.getHeapSize() >=
limits.getHeapSize());<a name="line.301"></a>
+<span class="sourceLineNo">302</span> }<a name="line.302"></a>
+<span class="sourceLineNo">303</span><a name="line.303"></a>
+<span class="sourceLineNo">304</span> /**<a name="line.304"></a>
+<span class="sourceLineNo">305</span> * @param checkerScope The scope that
the limit is being checked from. The time limit is always<a name="line.305"></a>
+<span class="sourceLineNo">306</span> * checked against {@link
System#currentTimeMillis()}<a name="line.306"></a>
+<span class="sourceLineNo">307</span> * @return true when the limit is
enforceable from the checker's scope and it has been reached<a
name="line.307"></a>
+<span class="sourceLineNo">308</span> */<a name="line.308"></a>
+<span class="sourceLineNo">309</span> boolean checkTimeLimit(LimitScope
checkerScope) {<a name="line.309"></a>
+<span class="sourceLineNo">310</span> return hasTimeLimit(checkerScope)
&& (System.currentTimeMillis() >= limits.getTime());<a
name="line.310"></a>
+<span class="sourceLineNo">311</span> }<a name="line.311"></a>
+<span class="sourceLineNo">312</span><a name="line.312"></a>
+<span class="sourceLineNo">313</span> /**<a name="line.313"></a>
+<span class="sourceLineNo">314</span> * @param checkerScope The scope that
the limits are being checked from<a name="line.314"></a>
+<span class="sourceLineNo">315</span> * @return true when some limit is
enforceable from the checker's scope and it has been reached<a
name="line.315"></a>
+<span class="sourceLineNo">316</span> */<a name="line.316"></a>
+<span class="sourceLineNo">317</span> boolean checkAnyLimitReached(LimitScope
checkerScope) {<a name="line.317"></a>
+<span class="sourceLineNo">318</span> return checkSizeLimit(checkerScope)
|| checkBatchLimit(checkerScope)<a name="line.318"></a>
+<span class="sourceLineNo">319</span> ||
checkTimeLimit(checkerScope);<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> Cell getLastPeekedCell() {<a
name="line.322"></a>
+<span class="sourceLineNo">323</span> return lastPeekedCell;<a
name="line.323"></a>
+<span class="sourceLineNo">324</span> }<a name="line.324"></a>
+<span class="sourceLineNo">325</span><a name="line.325"></a>
+<span class="sourceLineNo">326</span> void setLastPeekedCell(Cell
lastPeekedCell) {<a name="line.326"></a>
+<span class="sourceLineNo">327</span> this.lastPeekedCell =
lastPeekedCell;<a name="line.327"></a>
+<span class="sourceLineNo">328</span> }<a name="line.328"></a>
+<span class="sourceLineNo">329</span><a name="line.329"></a>
+<span class="sourceLineNo">330</span> @Override<a name="line.330"></a>
+<span class="sourceLineNo">331</span> public String toString() {<a
name="line.331"></a>
+<span class="sourceLineNo">332</span> StringBuilder sb = new
StringBuilder();<a name="line.332"></a>
+<span class="sourceLineNo">333</span> sb.append("{");<a name="line.333"></a>
+<span class="sourceLineNo">334</span><a name="line.334"></a>
+<span class="sourceLineNo">335</span> sb.append("limits:");<a
name="line.335"></a>
+<span class="sourceLineNo">336</span> sb.append(limits);<a
name="line.336"></a>
+<span class="sourceLineNo">337</span><a name="line.337"></a>
+<span class="sourceLineNo">338</span> sb.append(", progress:");<a
name="line.338"></a>
+<span class="sourceLineNo">339</span> sb.append(progress);<a
name="line.339"></a>
+<span class="sourceLineNo">340</span><a name="line.340"></a>
+<span class="sourceLineNo">341</span> sb.append(", keepProgress:");<a
name="line.341"></a>
+<span class="sourceLineNo">342</span> sb.append(keepProgress);<a
name="line.342"></a>
+<span class="sourceLineNo">343</span><a name="line.343"></a>
+<span class="sourceLineNo">344</span> sb.append(", state:");<a
name="line.344"></a>
+<span class="sourceLineNo">345</span> sb.append(scannerState);<a
name="line.345"></a>
+<span class="sourceLineNo">346</span><a name="line.346"></a>
+<span class="sourceLineNo">347</span> sb.append("}");<a name="line.347"></a>
+<span class="sourceLineNo">348</span> return sb.toString();<a
name="line.348"></a>
+<span class="sourceLineNo">349</span> }<a name="line.349"></a>
+<span class="sourceLineNo">350</span><a name="line.350"></a>
+<span class="sourceLineNo">351</span> public static Builder newBuilder() {<a
name="line.351"></a>
+<span class="sourceLineNo">352</span> return new Builder();<a
name="line.352"></a>
+<span class="sourceLineNo">353</span> }<a name="line.353"></a>
+<span class="sourceLineNo">354</span><a name="line.354"></a>
+<span class="sourceLineNo">355</span> public static Builder
newBuilder(boolean keepProgress) {<a name="line.355"></a>
+<span class="sourceLineNo">356</span> return new Builder(keepProgress);<a
name="line.356"></a>
+<span class="sourceLineNo">357</span> }<a name="line.357"></a>
+<span class="sourceLineNo">358</span><a name="line.358"></a>
+<span class="sourceLineNo">359</span> public static final class Builder {<a
name="line.359"></a>
+<span class="sourceLineNo">360</span> boolean keepProgress =
DEFAULT_KEEP_PROGRESS;<a name="line.360"></a>
+<span class="sourceLineNo">361</span> boolean trackMetrics = false;<a
name="line.361"></a>
+<span class="sourceLineNo">362</span> LimitFields limits = new
LimitFields();<a name="line.362"></a>
+<span class="sourceLineNo">363</span><a name="line.363"></a>
+<span class="sourceLineNo">364</span> private Builder() {<a
name="line.364"></a>
+<span class="sourceLineNo">365</span> }<a name="line.365"></a>
+<span class="sourceLineNo">366</span><a name="line.366"></a>
+<span class="sourceLineNo">367</span> private Builder(boolean keepProgress)
{<a name="line.367"></a>
+<span class="sourceLineNo">368</span> this.keepProgress = keepProgress;<a
name="line.368"></a>
+<span class="sourceLineNo">369</span> }<a name="line.369"></a>
+<span class="sourceLineNo">370</span><a name="line.370"></a>
+<span class="sourceLineNo">371</span> public Builder
setKeepProgress(boolean keepProgress) {<a name="line.371"></a>
+<span class="sourceLineNo">372</span> this.keepProgress = keepProgress;<a
name="line.372"></a>
+<span class="sourceLineNo">373</span> return this;<a name="line.373"></a>
+<span class="sourceLineNo">374</span> }<a name="line.374"></a>
+<span class="sourceLineNo">375</span><a name="line.375"></a>
+<span class="sourceLineNo">376</span> public Builder
setTrackMetrics(boolean trackMetrics) {<a name="line.376"></a>
+<span class="sourceLineNo">377</span> this.trackMetrics = trackMetrics;<a
name="line.377"></a>
+<span class="sourceLineNo">378</span> return this;<a name="line.378"></a>
+<span class="sourceLineNo">379</span> }<a name="line.379"></a>
+<span class="sourceLineNo">380</span><a name="line.380"></a>
+<span class="sourceLineNo">381</span> public Builder
setSizeLimit(LimitScope sizeScope, long dataSizeLimit, long heapSizeLimit) {<a
name="line.381"></a>
+<span class="sourceLineNo">382</span>
limits.setDataSize(dataSizeLimit);<a name="line.382"></a>
+<span class="sourceLineNo">383</span>
limits.setHeapSize(heapSizeLimit);<a name="line.383"></a>
+<span class="sourceLineNo">384</span> limits.setSizeScope(sizeScope);<a
name="line.384"></a>
+<span class="sourceLineNo">385</span> return this;<a name="line.385"></a>
+<span class="sourceLineNo">386</span> }<a name="line.386"></a>
+<span class="sourceLineNo">387</span><a name="line.387"></a>
+<span class="sourceLineNo">388</span> public Builder
setTimeLimit(LimitScope timeScope, long timeLimit) {<a name="line.388"></a>
+<span class="sourceLineNo">389</span> limits.setTime(timeLimit);<a
name="line.389"></a>
+<span class="sourceLineNo">390</span> limits.setTimeScope(timeScope);<a
name="line.390"></a>
+<span class="sourceLineNo">391</span> return this;<a name="line.391"></a>
+<span class="sourceLineNo">392</span> }<a name="line.392"></a>
+<span class="sourceLineNo">393</span><a name="line.393"></a>
+<span class="sourceLineNo">394</span> public Builder setBatchLimit(int
batchLimit) {<a name="line.394"></a>
+<span class="sourceLineNo">395</span> limits.setBatch(batchLimit);<a
name="line.395"></a>
+<span class="sourceLineNo">396</span> return this;<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> public ScannerContext build() {<a
name="line.399"></a>
+<span class="sourceLineNo">400</span> return new
ScannerContext(keepProgress, limits, trackMetrics);<a name="line.400"></a>
+<span class="sourceLineNo">401</span> }<a name="line.401"></a>
+<span class="sourceLineNo">402</span> }<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>
+<span class="sourceLineNo">405</span> * The possible states a scanner may be
in following a call to {@link InternalScanner#next(List)}<a name="line.405"></a>
+<span class="sourceLineNo">406</span> */<a name="line.406"></a>
+<span class="sourceLineNo">407</span> public enum NextState {<a
name="line.407"></a>
+<span class="sourceLineNo">408</span> MORE_VALUES(true, false),<a
name="line.408"></a>
+<span class="sourceLineNo">409</span> NO_MORE_VALUES(false, false),<a
name="line.409"></a>
+<span class="sourceLineNo">410</span> SIZE_LIMIT_REACHED(true, true),<a
name="line.410"></a>
+<span class="sourceLineNo">411</span><a name="line.411"></a>
+<span class="sourceLineNo">412</span> /**<a name="line.412"></a>
+<span class="sourceLineNo">413</span> * Special case of size limit reached
to indicate that the size limit was reached in the middle<a name="line.413"></a>
+<span class="sourceLineNo">414</span> * of a row and thus a partial
results was formed<a name="line.414"></a>
+<span class="sourceLineNo">415</span> */<a name="line.415"></a>
+<span class="sourceLineNo">416</span> SIZE_LIMIT_REACHED_MID_ROW(true,
true),<a name="line.416"></a>
+<span class="sourceLineNo">417</span> TIME_LIMIT_REACHED(true, true),<a
name="line.417"></a>
+<span class="sourceLineNo">418</span><a name="line.418"></a>
+<span class="sourceLineNo">419</span> /**<a name="line.419"></a>
+<span class="sourceLineNo">420</span> * Special case of time limit reached
to indicate that the time limit was reached in the middle<a name="line.420"></a>
+<span class="sourceLineNo">421</span> * of a row and thus a partial
results was formed<a name="line.421"></a>
+<span class="sourceLineNo">422</span> */<a name="line.422"></a>
+<span class="sourceLineNo">423</span> TIME_LIMIT_REACHED_MID_ROW(true,
true),<a name="line.423"></a>
+<span class="sourceLineNo">424</span> BATCH_LIMIT_REACHED(true, true);<a
name="line.424"></a>
+<span class="sourceLineNo">425</span><a name="line.425"></a>
+<span class="sourceLineNo">426</span> private final boolean moreValues;<a
name="line.426"></a>
+<span class="sourceLineNo">427</span> private final boolean limitReached;<a
name="line.427"></a>
+<span class="sourceLineNo">428</span><a name="line.428"></a>
+<span class="sourceLineNo">429</span> private NextState(boolean moreValues,
boolean limitReached) {<a name="line.429"></a>
+<span class="sourceLineNo">430</span> this.moreValues = moreValues;<a
name="line.430"></a>
+<span class="sourceLineNo">431</span> this.limitReached = limitReached;<a
name="line.431"></a>
+<span class="sourceLineNo">432</span> }<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">435</span> * @return true when the state
indicates that more values may follow those that have been<a
name="line.435"></a>
+<span class="sourceLineNo">436</span> * returned<a
name="line.436"></a>
+<span class="sourceLineNo">437</span> */<a name="line.437"></a>
+<span class="sourceLineNo">438</span> public boolean hasMoreValues() {<a
name="line.438"></a>
+<span class="sourceLineNo">439</span> return this.moreValues;<a
name="line.439"></a>
+<span class="sourceLineNo">440</span> }<a name="line.440"></a>
+<span class="sourceLineNo">441</span><a name="line.441"></a>
+<span class="sourceLineNo">442</span> /**<a name="line.442"></a>
+<span class="sourceLineNo">443</span> * @return true when the state
indicates that a limit has been reached and scan should stop<a
name="line.443"></a>
+<span class="sourceLineNo">444</span> */<a name="line.444"></a>
+<span class="sourceLineNo">445</span> public boolean limitReached() {<a
name="line.445"></a>
+<span class="sourceLineNo">446</span> return this.limitReached;<a
name="line.446"></a>
+<span class="sourceLineNo">447</span> }<a name="line.447"></a>
+<span class="sourceLineNo">448</span><a name="line.448"></a>
+<span class="sourceLineNo">449</span> public static boolean
isValidState(NextState state) {<a name="line.449"></a>
+<span class="sourceLineNo">450</span> return state != null;<a
name="line.450"></a>
+<span class="sourceLineNo">451</span> }<a name="line.451"></a>
+<span class="sourceLineNo">452</span><a name="line.452"></a>
+<span class="sourceLineNo">453</span> public static boolean
hasMoreValues(NextState state) {<a name="line.453"></a>
+<span class="sourceLineNo">454</span> return isValidState(state)
&& state.hasMoreValues();<a name="line.454"></a>
+<span class="sourceLineNo">455</span> }<a name="line.455"></a>
+<span class="sourceLineNo">456</span> }<a name="line.456"></a>
+<span class="sourceLineNo">457</span><a name="line.457"></a>
+<span class="sourceLineNo">458</span> /**<a name="line.458"></a>
+<span class="sourceLineNo">459</span> * The various scopes where a limit can
be enforced. Used to differentiate when a limit should be<a name="line.459"></a>
+<span class="sourceLineNo">460</span> * enforced or not.<a
name="line.460"></a>
+<span class="sourceLineNo">461</span> */<a name="line.461"></a>
+<span class="sourceLineNo">462</span> public enum LimitScope {<a
name="line.462"></a>
+<span class="sourceLineNo">463</span> /**<a name="line.463"></a>
+<span class="sourceLineNo">464</span> * Enforcing a limit between rows
means that the limit will not be considered until all the<a name="line.464"></a>
+<span class="sourceLineNo">465</span> * cells for a particular row have
been retrieved<a name="line.465"></a>
+<span class="sourceLineNo">466</span> */<a name="line.466"></a>
+<span class="sourceLineNo">467</span> BETWEEN_ROWS(0),<a
name="line.467"></a>
+<span class="sourceLineNo">468</span><a name="line.468"></a>
+<span class="sourceLineNo">469</span> /**<a name="line.469"></a>
+<span class="sourceLineNo">470</span> * Enforcing a limit between cells
means that the limit will be considered after each full cell<a
name="line.470"></a>
+<span class="sourceLineNo">471</span> * has been retrieved<a
name="line.471"></a>
+<span class="sourceLineNo">472</span> */<a name="line.472"></a>
+<span class="sourceLineNo">473</span> BETWEEN_CELLS(1);<a
name="line.473"></a>
+<span class="sourceLineNo">474</span><a name="line.474"></a>
+<span class="sourceLineNo">475</span> /**<a name="line.475"></a>
+<span class="sourceLineNo">476</span> * When enforcing a limit, we must
check that the scope is appropriate for enforcement.<a name="line.476"></a>
+<span class="sourceLineNo">477</span> * <p><a name="line.477"></a>
+<span class="sourceLineNo">478</span> * To communicate this concept, each
scope has a depth. A limit will be enforced if the depth of<a
name="line.478"></a>
+<span class="sourceLineNo">479</span> * the checker's scope is less than
or equal to the limit's scope. This means that when checking<a
name="line.479"></a>
+<span class="sourceLineNo">480</span> * limits, the checker must know
their own scope (i.e. are they checking the limits between<a
name="line.480"></a>
+<span class="sourceLineNo">481</span> * rows, between cells, etc...)<a
name="line.481"></a>
+<span class="sourceLineNo">482</span> */<a name="line.482"></a>
+<span class="sourceLineNo">483</span> final int depth;<a
name="line.483"></a>
+<span class="sourceLineNo">484</span><a name="line.484"></a>
+<span class="sourceLineNo">485</span> LimitScope(int depth) {<a
name="line.485"></a>
+<span class="sourceLineNo">486</span> this.depth = depth;<a
name="line.486"></a>
+<span class="sourceLineNo">487</span> }<a name="line.487"></a>
+<span class="sourceLineNo">488</span><a name="line.488"></a>
+<span class="sourceLineNo">489</span> final int depth() {<a
name="line.489"></a>
+<span class="sourceLineNo">490</span> return depth;<a name="line.490"></a>
+<span class="sourceLineNo">491</span> }<a name="line.491"></a>
+<span class="sourceLineNo">492</span><a name="line.492"></a>
+<span class="sourceLineNo">493</span> /**<a name="line.493"></a>
+<span class="sourceLineNo">494</span> * @param checkerScope The scope in
which the limit is being checked<a name="line.494"></a>
+<span class="sourceLineNo">495</span> * @return true when the checker is
in a scope that indicates the limit can be enforced. Limits<a
name="line.495"></a>
+<span class="sourceLineNo">496</span> * can be enforced from
"higher or equal" scopes (i.e. the checker's scope is at a<a
name="line.496"></a>
+<span class="sourceLineNo">497</span> * lesser depth than the
limit)<a name="line.497"></a>
+<span class="sourceLineNo">498</span> */<a name="line.498"></a>
+<span class="sourceLineNo">499</span> boolean
canEnforceLimitFromScope(LimitScope checkerScope) {<a name="line.499"></a>
+<span class="sourceLineNo">500</span> return checkerScope != null
&& checkerScope.depth() <= depth;<a name="line.500"></a>
+<span class="sourceLineNo">501</span> }<a name="line.501"></a>
+<span class="sourceLineNo">502</span> }<a name="line.502"></a>
+<span class="sourceLineNo">503</span><a name="line.503"></a>
+<span class="sourceLineNo">504</span> /**<a name="line.504"></a>
+<span class="sourceLineNo">505</span> * The different fields that can be
used as limits in calls to<a name="line.505"></a>
+<span class="sourceLineNo">506</span> * {@link
InternalScanner#next(java.util.List)} and {@link
RegionScanner#next(java.util.List)}<a name="line.506"></a>
+<span class="sourceLineNo">507</span> */<a name="line.507"></a>
+<span class="sourceLineNo">508</span> private static class LimitFields {<a
name="line.508"></a>
+<span class="sourceLineNo">509</span> /**<a name="line.509"></a>
+<span class="sourceLineNo">510</span> * Default values of the limit
fields. Defined such that if a field does NOT change from its<a
name="line.510"></a>
+<span class="sourceLineNo">511</span> * default, it will not be enforced<a
name="line.511"></a>
+<span class="sourceLineNo">512</span> */<a name="line.512"></a>
+<span class="sourceLineNo">513</span> private static int DEFAULT_BATCH =
-1;<a name="line.513"></a>
+<span class="sourceLineNo">514</span> private static long DEFAULT_SIZE =
-1L;<a name="line.514"></a>
+<span class="sourceLineNo">515</span> private static long DEFAULT_TIME =
-1L;<a name="line.515"></a>
+<span class="sourceLineNo">516</span><a name="line.516"></a>
+<span class="sourceLineNo">517</span> /**<a name="line.517"></a>
+<span class="sourceLineNo">518</span> * Default scope that is assigned to
a limit if a scope is not specified.<a name="line.518"></a>
+<span class="sourceLineNo">519</span> */<a name="line.519"></a>
+<span class="sourceLineNo">520</span> private static final LimitScope
DEFAULT_SCOPE = LimitScope.BETWEEN_ROWS;<a name="line.520"></a>
+<span class="sourceLineNo">521</span><a name="line.521"></a>
+<span class="sourceLineNo">522</span> // The batch limit will always be
enforced between cells, thus, there isn't a field to hold the<a
name="line.522"></a>
+<span class="sourceLineNo">523</span> // batch scope<a name="line.523"></a>
+<span class="sourceLineNo">524</span> int batch = DEFAULT_BATCH;<a
name="line.524"></a>
+<span class="sourceLineNo">525</span><a name="line.525"></a>
+<span class="sourceLineNo">526</span> LimitScope sizeScope =
DEFAULT_SCOPE;<a name="line.526"></a>
+<span class="sourceLineNo">527</span> // The sum of cell data sizes(key +
value). The Cell data might be in on heap or off heap area.<a
name="line.527"></a>
+<span class="sourceLineNo">528</span> long dataSize = DEFAULT_SIZE;<a
name="line.528"></a>
+<span class="sourceLineNo">529</span> // The sum of heap space occupied by
all tracked cells. This includes Cell POJO's overhead as<a name="line.529"></a>
+<span class="sourceLineNo">530</span> // such AND data cells of Cells which
are in on heap area.<a name="line.530"></a>
+<span class="sourceLineNo">531</span> long heapSize = DEFAULT_SIZE;<a
name="line.531"></a>
+<span class="sourceLineNo">532</span><a name="line.532"></a>
+<span class="sourceLineNo">533</span> LimitScope timeScope =
DEFAULT_SCOPE;<a name="line.533"></a>
+<span class="sourceLineNo">534</span> long time = DEFAULT_TIME;<a
name="line.534"></a>
+<span class="sourceLineNo">535</span><a name="line.535"></a>
+<span class="sourceLineNo">536</span> /**<a name="line.536"></a>
+<span class="sourceLineNo">537</span> * Fields keep their default
values.<a name="line.537"></a>
+<span class="sourceLineNo">538</span> */<a name="line.538"></a>
+<span class="sourceLineNo">539</span> LimitFields() {<a name="line.539"></a>
+<span class="sourceLineNo">540</span> }<a name="line.540"></a>
+<span class="sourceLineNo">541</span><a name="line.541"></a>
+<span class="sourceLineNo">542</span> LimitFields(int batch, LimitScope
sizeScope, long size, long heapSize, LimitScope timeScope,<a
name="line.542"></a>
+<span class="sourceLineNo">543</span> long time) {<a
name="line.543"></a>
+<span class="sourceLineNo">544</span> setFields(batch, sizeScope, size,
heapSize, timeScope, time);<a name="line.544"></a>
+<span class="sourceLineNo">545</span> }<a name="line.545"></a>
+<span class="sourceLineNo">546</span><a name="line.546"></a>
+<span class="sourceLineNo">547</span> void copy(LimitFields limitsToCopy)
{<a name="line.547"></a>
+<span class="sourceLineNo">548</span> if (limitsToCopy != null) {<a
name="line.548"></a>
+<span class="sourceLineNo">549</span>
setFields(limitsToCopy.getBatch(), limitsToCopy.getSizeScope(),
limitsToCopy.getDataSize(),<a name="line.549"></a>
+<span class="sourceLineNo">550</span> limitsToCopy.getHeapSize(),
limitsToCopy.getTimeScope(), limitsToCopy.getTime());<a name="line.550"></a>
+<span class="sourceLineNo">551</span> }<a name="line.551"></a>
+<span class="sourceLineNo">552</span> }<a name="line.552"></a>
+<span class="sourceLineNo">553</span><a name="line.553"></a>
+<span class="sourceLineNo">554</span> /**<a name="line.554"></a>
+<span class="sourceLineNo">555</span> * Set all fields together.<a
name="line.555"></a>
+<span class="sourceLineNo">556</span> * @param batch<a name="line.556"></a>
+<span class="sourceLineNo">557</span> * @param sizeScope<a
name="line.557"></a>
+<span class="sourceLineNo">558</span> * @param dataSize<a
name="line.558"></a>
+<span class="sourceLineNo">559</span> */<a name="line.559"></a>
+<span class="sourceLineNo">560</span> void setFields(int batch, LimitScope
sizeScope, long dataSize, long heapSize,<a name="line.560"></a>
+<span class="sourceLineNo">561</span> LimitScope timeScope, long time)
{<a name="line.561"></a>
+<span class="sourceLineNo">562</span> setBatch(batch);<a
name="line.562"></a>
+<span class="sourceLineNo">563</span> setSizeScope(sizeScope);<a
name="line.563"></a>
+<span class="sourceLineNo">564</span> setDataSize(dataSize);<a
name="line.564"></a>
+<span class="sourceLineNo">565</span> setHeapSize(heapSize);<a
name="line.565"></a>
+<span class="sourceLineNo">566</span> setTimeScope(timeScope);<a
name="line.566"></a>
+<span class="sourceLineNo">567</span> setTime(time);<a
name="line.567"></a>
+<span class="sourceLineNo">568</span> }<a name="line.568"></a>
+<span class="sourceLineNo">569</span><a name="line.569"></a>
+<span class="sourceLineNo">570</span> int getBatch() {<a
name="line.570"></a>
+<span class="sourceLineNo">571</span> return this.batch;<a
name="line.571"></a>
+<span class="sourceLineNo">572</span> }<a name="line.572"></a>
+<span class="sourceLineNo">573</span><a name="line.573"></a>
+<span class="sourceLineNo">574</span> void setBatch(int batch) {<a
name="line.574"></a>
+<span class="sourceLineNo">575</span> this.batch = batch;<a
name="line.575"></a>
+<span class="sourceLineNo">576</span> }<a name="line.576"></a>
+<span class="sourceLineNo">577</span><a name="line.577"></a>
+<span class="sourceLineNo">578</span> /**<a name="line.578"></a>
+<span class="sourceLineNo">579</span> * @param checkerScope<a
name="line.579"></a>
+<span class="sourceLineNo">580</span> * @return true when the limit can be
enforced from the scope of the checker<a name="line.580"></a>
+<span class="sourceLineNo">581</span> */<a name="line.581"></a>
+<span class="sourceLineNo">582</span> boolean
canEnforceBatchLimitFromScope(LimitScope checkerScope) {<a name="line.582"></a>
+<span class="sourceLineNo">583</span> return
LimitScope.BETWEEN_CELLS.canEnforceLimitFromScope(checkerScope);<a
name="line.583"></a>
+<span class="sourceLineNo">584</span> }<a name="line.584"></a>
+<span class="sourceLineNo">585</span><a name="line.585"></a>
+<span class="sourceLineNo">586</span> long getDataSize() {<a
name="line.586"></a>
+<span class="sourceLineNo">587</span> return this.dataSize;<a
name="line.587"></a>
+<span class="sourceLineNo">588</span> }<a name="line.588"></a>
+<span class="sourceLineNo">589</span><a name="line.589"></a>
+<span class="sourceLineNo">590</span> long getHeapSize() {<a
name="line.590"></a>
+<span class="sourceLineNo">591</span> return this.heapSize;<a
name="line.591"></a>
+<span class="sourceLineNo">592</span> }<a name="line.592"></a>
+<span class="sourceLineNo">593</span><a name="line.593"></a>
+<span class="sourceLineNo">594</span> void setDataSize(long dataSize) {<a
name="line.594"></a>
+<span class="sourceLineNo">595</span> this.dataSize = dataSize;<a
name="line.595"></a>
+<span class="sourceLineNo">596</span> }<a name="line.596"></a>
+<span class="sourceLineNo">597</span><a name="line.597"></a>
+<span class="sourceLineNo">598</span> void setHeapSize(long heapSize) {<a
name="line.598"></a>
+<span class="sourceLineNo">599</span> this.heapSize = heapSize;<a
name="line.599"></a>
+<span class="sourceLineNo">600</span> }<a name="line.600"></a>
+<span class="sourceLineNo">601</span><a name="line.601"></a>
+<span class="sourceLineNo">602</span> /**<a name="line.602"></a>
+<span class="sourceLineNo">603</span> * @return {@link LimitScope}
indicating scope in which the size limit is enforced<a name="line.603"></a>
+<span class="sourceLineNo">604</span> */<a name="line.604"></a>
+<span class="sourceLineNo">605</span> LimitScope getSizeScope() {<a
name="line.605"></a>
+<span class="sourceLineNo">606</span> return this.sizeScope;<a
name="line.606"></a>
+<span class="sourceLineNo">607</span> }<a name="line.607"></a>
+<span class="sourceLineNo">608</span><a name="line.608"></a>
+<span class="sourceLineNo">609</span> /**<a name="line.609"></a>
+<span class="sourceLineNo">610</span> * Change the scope in which the size
limit is enforced<a name="line.610"></a>
+<span class="sourceLineNo">611</span> */<a name="line.611"></a>
+<span class="sourceLineNo">612</span> void setSizeScope(LimitScope scope)
{<a name="line.612"></a>
+<span class="sourceLineNo">613</span> this.sizeScope = scope;<a
name="line.613"></a>
+<span class="sourceLineNo">614</span> }<a name="line.614"></a>
+<span class="sourceLineNo">615</span><a name="line.615"></a>
+<span class="sourceLineNo">616</span> /**<a name="line.616"></a>
+<span class="sourceLineNo">617</span> * @param checkerScope<a
name="line.617"></a>
+<span class="sourceLineNo">618</span> * @return true when the limit can be
enforced from the scope of the checker<a name="line.618"></a>
+<span class="sourceLineNo">619</span> */<a name="line.619"></a>
+<span class="sourceLineNo">620</span> boolean
canEnforceSizeLimitFromScope(LimitScope checkerScope) {<a name="line.620"></a>
+<span class="sourceLineNo">621</span> return
this.sizeScope.canEnforceLimitFromScope(checkerScope);<a name="line.621"></a>
+<span class="sourceLineNo">622</span> }<a name="line.622"></a>
+<span class="sourceLineNo">623</span><a name="line.623"></a>
+<span class="sourceLineNo">624</span> long getTime() {<a
name="line.624"></a>
+<span class="sourceLineNo">625</span> return this.time;<a
name="line.625"></a>
+<span class="sourceLineNo">626</span> }<a name="line.626"></a>
+<span class="sourceLineNo">627</span><a name="line.627"></a>
+<span class="sourceLineNo">628</span> void setTime(long time) {<a
name="line.628"></a>
+<span class="sourceLineNo">629</span> this.time = time;<a
name="line.629"></a>
+<span class="sourceLineNo">630</span> }<a name="line.630"></a>
+<span class="sourceLineNo">631</span><a name="line.631"></a>
+<span class="sourceLineNo">632</span> /**<a name="line.632"></a>
+<span class="sourceLineNo">633</span> * @return {@link LimitScope}
indicating scope in which the time limit is enforced<a name="line.633"></a>
+<span class="sourceLineNo">634</span> */<a name="line.634"></a>
+<span class="sourceLineNo">635</span> LimitScope getTimeScope() {<a
name="line.635"></a>
+<span class="sourceLineNo">636</span> return this.timeScope;<a
name="line.636"></a>
+<span class="sourceLineNo">637</span> }<a name="line.637"></a>
+<span class="sourceLineNo">638</span><a name="line.638"></a>
+<span class="sourceLineNo">639</span> /**<a name="line.639"></a>
+<span class="sourceLineNo">640</span> * Change the scope in which the time
limit is enforced<a name="line.640"></a>
+<span class="sourceLineNo">641</span> */<a name="line.641"></a>
+<span class="sourceLineNo">642</span> void setTimeScope(LimitScope scope)
{<a name="line.642"></a>
+<span class="sourceLineNo">643</span> this.timeScope = scope;<a
name="line.643"></a>
+<span class="sourceLineNo">644</span> }<a name="line.644"></a>
+<span class="sourceLineNo">645</span><a name="line.645"></a>
+<span class="sourceLineNo">646</span> /**<a name="line.646"></a>
+<span class="sourceLineNo">647</span> * @param checkerScope<a
name="line.647"></a>
+<span class="sourceLineNo">648</span> * @return true when the limit can be
enforced from the scope of the checker<a name="line.648"></a>
+<span class="sourceLineNo">649</span> */<a name="line.649"></a>
+<span class="sourceLineNo">650</span> boolean
canEnforceTimeLimitFromScope(LimitScope checkerScope) {<a name="line.650"></a>
+<span class="sourceLineNo">651</span> return
this.timeScope.canEnforceLimitFromScope(checkerScope);<a name="line.651"></a>
+<span class="sourceLineNo">652</span> }<a name="line.652"></a>
+<span class="sourceLineNo">653</span><a name="line.653"></a>
+<span class="sourceLineNo">654</span> @Override<a name="line.654"></a>
+<span class="sourceLineNo">655</span> public String toString() {<a
name="line.655"></a>
+<span class="sourceLineNo">656</span> StringBuilder sb = new
StringBuilder();<a name="line.656"></a>
+<span class="sourceLineNo">657</span> sb.append("{");<a
name="line.657"></a>
+<span class="sourceLineNo">658</span><a name="line.658"></a>
+<span class="sourceLineNo">659</span> sb.append("batch:");<a
name="line.659"></a>
+<span class="sourceLineNo">660</span> sb.append(batch);<a
name="line.660"></a>
+<span class="sourceLineNo">661</span><a name="line.661"></a>
+<span class="sourceLineNo">662</span> sb.append(", dataSize:");<a
name="line.662"></a>
+<span class="sourceLineNo">663</span> sb.append(dataSize);<a
name="line.663"></a>
+<span class="sourceLineNo">664</span><a name="line.664"></a>
+<span class="sourceLineNo">665</span> sb.append(", heapSize:");<a
name="line.665"></a>
+<span class="sourceLineNo">666</span> sb.append(heapSize);<a
name="line.666"></a>
+<span class="sourceLineNo">667</span><a name="line.667"></a>
+<span class="sourceLineNo">668</span> sb.append(", sizeScope:");<a
name="line.668"></a>
+<span class="sourceLineNo">669</span> sb.append(sizeScope);<a
name="line.669"></a>
+<span class="sourceLineNo">670</span><a name="line.670"></a>
+<span class="sourceLineNo">671</span> sb.append(", time:");<a
name="line.671"></a>
+<span class="sourceLineNo">672</span> sb.append(time);<a
name="line.672"></a>
+<span class="sourceLineNo">673</span><a name="line.673"></a>
+<span class="sourceLineNo">674</span> sb.append(", timeScope:");<a
name="line.674"></a>
+<span class="sourceLineNo">675</span> sb.append(timeScope);<a
name="line.675"></a>
+<span class="sourceLineNo">676</span><a name="line.676"></a>
+<span class="sourceLineNo">677</span> sb.append("}");<a
name="line.677"></a>
+<span class="sourceLineNo">678</span> return sb.toString();<a
name="line.678"></a>
+<span class="sourceLineNo">679</span> }<a name="line.679"></a>
+<span class="sourceLineNo">680</span> }<a name="line.680"></a>
+<span class="sourceLineNo">681</span><a name="line.681"></a>
+<span class="sourceLineNo">682</span> private static class ProgressFields {<a
name="line.682"></a>
+<span class="sourceLineNo">683</span><a name="line.683"></a>
+<span class="sourceLineNo">684</span> private static int DEFAULT_BATCH =
-1;<a name="line.684"></a>
+<span class="sourceLineNo">685</span> private static long DEFAULT_SIZE =
-1L;<a name="line.685"></a>
+<span class="sourceLineNo">686</span><a name="line.686"></a>
+<span class="sourceLineNo">687</span> // The batch limit will always be
enforced between cells, thus, there isn't a field to hold the<a
name="line.687"></a>
+<span class="sourceLineNo">688</span> // batch scope<a name="line.688"></a>
+<span class="sourceLineNo">689</span> int batch = DEFAULT_BATCH;<a
name="line.689"></a>
+<span class="sourceLineNo">690</span><a name="line.690"></a>
+<span class="sourceLineNo">691</span> // The sum of cell data sizes(key +
value). The Cell data might be in on heap or off heap area.<a
name="line.691"></a>
+<span class="sourceLineNo">692</span> long dataSize = DEFAULT_SIZE;<a
name="line.692"></a>
+<span class="sourceLineNo">693</span> // The sum of heap space occupied by
all tracked cells. This includes Cell POJO's overhead as<a name="line.693"></a>
+<span class="sourceLineNo">694</span> // such AND data cells of Cells which
are in on heap area.<a name="line.694"></a>
+<span class="sourceLineNo">695</span> long heapSize = DEFAULT_SIZE;<a
name="line.695"></a>
+<span class="sourceLineNo">696</span><a name="line.696"></a>
+<span class="sourceLineNo">697</span> /**<a name="line.697"></a>
+<span class="sourceLineNo">698</span> * Fields keep their default
values.<a name="line.698"></a>
+<span class="sourceLineNo">699</span> */<a name="line.699"></a>
+<span class="sourceLineNo">700</span> ProgressFields() {<a
name="line.700"></a>
+<span class="sourceLineNo">701</span> }<a name="line.701"></a>
+<span class="sourceLineNo">702</span><a name="line.702"></a>
+<span class="sourceLineNo">703</span> ProgressFields(int batch, long size,
long heapSize) {<a name="line.703"></a>
+<span class="sourceLineNo">704</span> setFields(batch, size, heapSize);<a
name="line.704"></a>
+<span class="sourceLineNo">705</span> }<a name="line.705"></a>
+<span class="sourceLineNo">706</span><a name="line.706"></a>
+<span class="sourceLineNo">707</span> /**<a name="line.707"></a>
+<span class="sourceLineNo">708</span> * Set all fields together.<a
name="line.708"></a>
+<span class="sourceLineNo">709</span> */<a name="line.709"></a>
+<span class="sourceLineNo">710</span> void setFields(int batch, long
dataSize, long heapSize) {<a name="line.710"></a>
+<span class="sourceLineNo">711</span> setBatch(batch);<a
name="line.711"></a>
+<span class="sourceLineNo">712</span> setDataSize(dataSize);<a
name="line.712"></a>
+<span class="sourceLineNo">713</span> setHeapSize(heapSize);<a
name="line.713"></a>
+<span class="sourceLineNo">714</span> }<a name="line.714"></a>
+<span class="sourceLineNo">715</span><a name="line.715"></a>
+<span class="sourceLineNo">716</span> int getBatch() {<a
name="line.716"></a>
+<span class="sourceLineNo">717</span> return this.batch;<a
name="line.717"></a>
+<span class="sourceLineNo">718</span> }<a name="line.718"></a>
+<span class="sourceLineNo">719</span><a name="line.719"></a>
+<span class="sourceLineNo">720</span> void setBatch(int batch) {<a
name="line.720"></a>
+<span class="sourceLineNo">721</span> this.batch = batch;<a
name="line.721"></a>
+<span class="sourceLineNo">722</span> }<a name="line.722"></a>
+<span class="sourceLineNo">723</span><a name="line.723"></a>
+<span class="sourceLineNo">724</span> long getDataSize() {<a
name="line.724"></a>
+<span class="sourceLineNo">725</span> return this.dataSize;<a
name="line.725"></a>
+<span class="sourceLineNo">726</span> }<a name="line.726"></a>
+<span class="sourceLineNo">727</span><a name="line.727"></a>
+<span class="sourceLineNo">728</span> long getHeapSize() {<a
name="line.728"></a>
+<span class="sourceLineNo">729</span> return this.heapSize;<a
name="line.729"></a>
+<span class="sourceLineNo">730</span> }<a name="line.730"></a>
+<span class="sourceLineNo">731</span><a name="line.731"></a>
+<span class="sourceLineNo">732</span> void setDataSize(long dataSize) {<a
name="line.732"></a>
+<span class="sourceLineNo">733</span> this.dataSize = dataSize;<a
name="line.733"></a>
+<span class="sourceLineNo">734</span> }<a name="line.734"></a>
+<span class="sourceLineNo">735</span><a name="line.735"></a>
+<span class="sourceLineNo">736</span> void setHeapSize(long heapSize) {<a
name="line.736"></a>
+<span class="sourceLineNo">737</span> this.heapSize = heapSize;<a
name="line.737"></a>
+<span class="sourceLineNo">738</span> }<a name="line.738"></a>
+<span class="sourceLineNo">739</span><a name="line.739"></a>
+<span class="sourceLineNo">740</span> @Override<a name="line.740"></a>
+<span class="sourceLineNo">741</span> public String toString() {<a
name="line.741"></a>
+<span class="sourceLineNo">742</span> StringBuilder sb = new
StringBuilder();<a name="line.742"></a>
+<span class="sourceLineNo">743</span> sb.append("{");<a
name="line.743"></a>
+<span class="sourceLineNo">744</span><a name="line.744"></a>
+<span class="sourceLineNo">745</span> sb.append("batch:");<a
name="line.745"></a>
+<span class="sourceLineNo">746</span> sb.append(batch);<a
name="line.746"></a>
+<span class="sourceLineNo">747</span><a name="line.747"></a>
+<span class="sourceLineNo">748</span> sb.append(", dataSize:");<a
name="line.748"></a>
+<span class="sourceLineNo">749</span> sb.append(dataSize);<a
name="line.749"></a>
+<span class="sourceLineNo">750</span><a name="line.750"></a>
+<span class="sourceLineNo">751</span> sb.append(", heapSize:");<a
name="line.751"></a>
+<span class="sourceLineNo">752</span> sb.append(heapSize);<a
name="line.752"></a>
+<span class="sourceLineNo">753</span><a name="line.753"></a>
+<span class="sourceLineNo">754</span> sb.append("}");<a
name="line.754"></a>
+<span class="sourceLineNo">755</span> return sb.toString();<a
name="line.755"></a>
+<span class="sourceLineNo">756</span> }<a name="line.756"></a>
+<span class="sourceLineNo">757</span> }<a name="line.757"></a>
+<span class="sourceLineNo">758</span>}<a name="line.758"></a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</pre>
+</div>
+</body>
+</html>
