devapidocs/src-html/org/apache/hadoop/hbase/regionserver/NoLimitScannerContext.html - hbase-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>Source code</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta name="description" content="source: package: org.apache.hadoop.hbase.regionserver, class: NoLimitScannerContext">
 <meta name="generator" content="javadoc/SourceToHTMLConverter">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
 </head>
 <body class="source-page">
 <main role="main">
 <div class="source-container">
 <pre><span class="source-line-no">001</span><span id="line-1">/*</span>
 <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
 <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements.  See the NOTICE file</span>
 <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
 <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership.  The ASF licenses this file</span>
 <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
 <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
 <span class="source-line-no">008</span><span id="line-8"> * with the License.  You may obtain a copy of the License at</span>
 <span class="source-line-no">009</span><span id="line-9"> *</span>
 <span class="source-line-no">010</span><span id="line-10"> *     http://www.apache.org/licenses/LICENSE-2.0</span>
 <span class="source-line-no">011</span><span id="line-11"> *</span>
 <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
 <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
 <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
 <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
 <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
 <span class="source-line-no">017</span><span id="line-17"> */</span>
 <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.regionserver;</span>
 <span class="source-line-no">019</span><span id="line-19"></span>
 <span class="source-line-no">020</span><span id="line-20">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span>
 <span class="source-line-no">021</span><span id="line-21">import org.apache.yetus.audience.InterfaceAudience;</span>
 <span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceStability;</span>
 <span class="source-line-no">023</span><span id="line-23"></span>
 <span class="source-line-no">024</span><span id="line-24">/**</span>
 <span class="source-line-no">025</span><span id="line-25"> * This is a special {@link ScannerContext} subclass that is designed to be used globally when</span>
 <span class="source-line-no">026</span><span id="line-26"> * limits should not be enforced during invocations of {@link InternalScanner#next(java.util.List)}</span>
 <span class="source-line-no">027</span><span id="line-27"> * or {@link RegionScanner#next(java.util.List)}.</span>
 <span class="source-line-no">028</span><span id="line-28"> * &lt;p&gt;</span>
 <span class="source-line-no">029</span><span id="line-29"> * Instances of {@link NoLimitScannerContext} are immutable after construction. Any attempt to</span>
 <span class="source-line-no">030</span><span id="line-30"> * change the limits or progress of a {@link NoLimitScannerContext} will fail silently. The net</span>
 <span class="source-line-no">031</span><span id="line-31"> * effect is that all limit checks will return false, thus indicating that a limit has not been</span>
 <span class="source-line-no">032</span><span id="line-32"> * reached.</span>
 <span class="source-line-no">033</span><span id="line-33"> */</span>
 <span class="source-line-no">034</span><span id="line-34">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)</span>
 <span class="source-line-no">035</span><span id="line-35">@InterfaceStability.Evolving</span>
 <span class="source-line-no">036</span><span id="line-36">public class NoLimitScannerContext extends ScannerContext {</span>
 <span class="source-line-no">037</span><span id="line-37"></span>
 <span class="source-line-no">038</span><span id="line-38">  public NoLimitScannerContext() {</span>
 <span class="source-line-no">039</span><span id="line-39">    super(false, null, false);</span>
 <span class="source-line-no">040</span><span id="line-40">  }</span>
 <span class="source-line-no">041</span><span id="line-41"></span>
 <span class="source-line-no">042</span><span id="line-42">  /**</span>
 <span class="source-line-no">043</span><span id="line-43">   * Use this instance whenever limits do not need to be enforced.</span>
 <span class="source-line-no">044</span><span id="line-44">   */</span>
 <span class="source-line-no">045</span><span id="line-45">  private static final ScannerContext NO_LIMIT = new NoLimitScannerContext();</span>
 <span class="source-line-no">046</span><span id="line-46"></span>
 <span class="source-line-no">047</span><span id="line-47">  /**</span>
 <span class="source-line-no">048</span><span id="line-48">   * Returns the static, immutable instance of {@link NoLimitScannerContext} to be used whenever</span>
 <span class="source-line-no">049</span><span id="line-49">   * limits should not be enforced</span>
 <span class="source-line-no">050</span><span id="line-50">   */</span>
 <span class="source-line-no">051</span><span id="line-51">  @edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "MS_EXPOSE_REP",</span>
 <span class="source-line-no">052</span><span id="line-52">      justification = "singleton pattern")</span>
 <span class="source-line-no">053</span><span id="line-53">  public static final ScannerContext getInstance() {</span>
 <span class="source-line-no">054</span><span id="line-54">    return NO_LIMIT;</span>
 <span class="source-line-no">055</span><span id="line-55">  }</span>
 <span class="source-line-no">056</span><span id="line-56"></span>
 <span class="source-line-no">057</span><span id="line-57">  @Override</span>
 <span class="source-line-no">058</span><span id="line-58">  void setKeepProgress(boolean keepProgress) {</span>
 <span class="source-line-no">059</span><span id="line-59">    // Do nothing. NoLimitScannerContext instances are immutable post-construction</span>
 <span class="source-line-no">060</span><span id="line-60">  }</span>
 <span class="source-line-no">061</span><span id="line-61"></span>
 <span class="source-line-no">062</span><span id="line-62">  @Override</span>
 <span class="source-line-no">063</span><span id="line-63">  void setBatchProgress(int batchProgress) {</span>
 <span class="source-line-no">064</span><span id="line-64">    // Do nothing. NoLimitScannerContext instances are immutable post-construction</span>
 <span class="source-line-no">065</span><span id="line-65">  }</span>
 <span class="source-line-no">066</span><span id="line-66"></span>
 <span class="source-line-no">067</span><span id="line-67">  @Override</span>
 <span class="source-line-no">068</span><span id="line-68">  void setSizeProgress(long sizeProgress, long heapSizeProgress) {</span>
 <span class="source-line-no">069</span><span id="line-69">    // Do nothing. NoLimitScannerContext instances are immutable post-construction</span>
 <span class="source-line-no">070</span><span id="line-70">  }</span>
 <span class="source-line-no">071</span><span id="line-71"></span>
 <span class="source-line-no">072</span><span id="line-72">  @Override</span>
 <span class="source-line-no">073</span><span id="line-73">  void setProgress(int batchProgress, long sizeProgress, long heapSizeProgress) {</span>
 <span class="source-line-no">074</span><span id="line-74">    // Do nothing. NoLimitScannerContext instances are immutable post-construction</span>
 <span class="source-line-no">075</span><span id="line-75">  }</span>
 <span class="source-line-no">076</span><span id="line-76"></span>
 <span class="source-line-no">077</span><span id="line-77">  @Override</span>
 <span class="source-line-no">078</span><span id="line-78">  void clearProgress() {</span>
 <span class="source-line-no">079</span><span id="line-79">    // Do nothing. NoLimitScannerContext instances are immutable post-construction</span>
 <span class="source-line-no">080</span><span id="line-80">  }</span>
 <span class="source-line-no">081</span><span id="line-81"></span>
 <span class="source-line-no">082</span><span id="line-82">  @Override</span>
 <span class="source-line-no">083</span><span id="line-83">  void setSizeLimitScope(LimitScope scope) {</span>
 <span class="source-line-no">084</span><span id="line-84">    // Do nothing. NoLimitScannerContext instances are immutable post-construction</span>
 <span class="source-line-no">085</span><span id="line-85">  }</span>
 <span class="source-line-no">086</span><span id="line-86"></span>
 <span class="source-line-no">087</span><span id="line-87">  @Override</span>
 <span class="source-line-no">088</span><span id="line-88">  void setTimeLimitScope(LimitScope scope) {</span>
 <span class="source-line-no">089</span><span id="line-89">    // Do nothing. NoLimitScannerContext instances are immutable post-construction</span>
 <span class="source-line-no">090</span><span id="line-90">  }</span>
 <span class="source-line-no">091</span><span id="line-91"></span>
 <span class="source-line-no">092</span><span id="line-92">  @Override</span>
 <span class="source-line-no">093</span><span id="line-93">  NextState setScannerState(NextState state) {</span>
 <span class="source-line-no">094</span><span id="line-94">    // Do nothing. NoLimitScannerContext instances are immutable post-construction</span>
 <span class="source-line-no">095</span><span id="line-95">    return state;</span>
 <span class="source-line-no">096</span><span id="line-96">  }</span>
 <span class="source-line-no">097</span><span id="line-97"></span>
 <span class="source-line-no">098</span><span id="line-98">  @Override</span>
 <span class="source-line-no">099</span><span id="line-99">  boolean checkBatchLimit(LimitScope checkerScope) {</span>
 <span class="source-line-no">100</span><span id="line-100">    // No limits can be specified, thus return false to indicate no limit has been reached.</span>
 <span class="source-line-no">101</span><span id="line-101">    return false;</span>
 <span class="source-line-no">102</span><span id="line-102">  }</span>
 <span class="source-line-no">103</span><span id="line-103"></span>
 <span class="source-line-no">104</span><span id="line-104">  @Override</span>
 <span class="source-line-no">105</span><span id="line-105">  boolean checkSizeLimit(LimitScope checkerScope) {</span>
 <span class="source-line-no">106</span><span id="line-106">    // No limits can be specified, thus return false to indicate no limit has been reached.</span>
 <span class="source-line-no">107</span><span id="line-107">    return false;</span>
 <span class="source-line-no">108</span><span id="line-108">  }</span>
 <span class="source-line-no">109</span><span id="line-109"></span>
 <span class="source-line-no">110</span><span id="line-110">  @Override</span>
 <span class="source-line-no">111</span><span id="line-111">  boolean checkTimeLimit(LimitScope checkerScope) {</span>
 <span class="source-line-no">112</span><span id="line-112">    // No limits can be specified, thus return false to indicate no limit has been reached.</span>
 <span class="source-line-no">113</span><span id="line-113">    return false;</span>
 <span class="source-line-no">114</span><span id="line-114">  }</span>
 <span class="source-line-no">115</span><span id="line-115"></span>
 <span class="source-line-no">116</span><span id="line-116">  @Override</span>
 <span class="source-line-no">117</span><span id="line-117">  boolean checkAnyLimitReached(LimitScope checkerScope) {</span>
 <span class="source-line-no">118</span><span id="line-118">    return false;</span>
 <span class="source-line-no">119</span><span id="line-119">  }</span>
 <span class="source-line-no">120</span><span id="line-120">}</span>


 </pre>
 </div>
 </main>
 </body>
 </html>
	<!DOCTYPE HTML>
	<html lang="en">
	<head>
	<!-- Generated by javadoc (17) -->
	<title>Source code</title>
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<meta name="description" content="source: package: org.apache.hadoop.hbase.regionserver, class: NoLimitScannerContext">
	<meta name="generator" content="javadoc/SourceToHTMLConverter">
	<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
	</head>
	<body class="source-page">
	<main role="main">
	<div class="source-container">
	<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
	<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
	<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
	<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
	<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
	<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
	<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
	<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
	<span class="source-line-no">009</span><span id="line-9"> *</span>
	<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
	<span class="source-line-no">011</span><span id="line-11"> *</span>
	<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
	<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
	<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
	<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
	<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
	<span class="source-line-no">017</span><span id="line-17"> */</span>
	<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.regionserver;</span>
	<span class="source-line-no">019</span><span id="line-19"></span>
	<span class="source-line-no">020</span><span id="line-20">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span>
	<span class="source-line-no">021</span><span id="line-21">import org.apache.yetus.audience.InterfaceAudience;</span>
	<span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceStability;</span>
	<span class="source-line-no">023</span><span id="line-23"></span>
	<span class="source-line-no">024</span><span id="line-24">/**</span>
	<span class="source-line-no">025</span><span id="line-25"> * This is a special {@link ScannerContext} subclass that is designed to be used globally when</span>
	<span class="source-line-no">026</span><span id="line-26"> * limits should not be enforced during invocations of {@link InternalScanner#next(java.util.List)}</span>
	<span class="source-line-no">027</span><span id="line-27"> * or {@link RegionScanner#next(java.util.List)}.</span>
	<span class="source-line-no">028</span><span id="line-28"> * <p></span>
	<span class="source-line-no">029</span><span id="line-29"> * Instances of {@link NoLimitScannerContext} are immutable after construction. Any attempt to</span>
	<span class="source-line-no">030</span><span id="line-30"> * change the limits or progress of a {@link NoLimitScannerContext} will fail silently. The net</span>
	<span class="source-line-no">031</span><span id="line-31"> * effect is that all limit checks will return false, thus indicating that a limit has not been</span>
	<span class="source-line-no">032</span><span id="line-32"> * reached.</span>
	<span class="source-line-no">033</span><span id="line-33"> */</span>
	<span class="source-line-no">034</span><span id="line-34">@InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)</span>
	<span class="source-line-no">035</span><span id="line-35">@InterfaceStability.Evolving</span>
	<span class="source-line-no">036</span><span id="line-36">public class NoLimitScannerContext extends ScannerContext {</span>
	<span class="source-line-no">037</span><span id="line-37"></span>
	<span class="source-line-no">038</span><span id="line-38"> public NoLimitScannerContext() {</span>
	<span class="source-line-no">039</span><span id="line-39"> super(false, null, false);</span>
	<span class="source-line-no">040</span><span id="line-40"> }</span>
	<span class="source-line-no">041</span><span id="line-41"></span>
	<span class="source-line-no">042</span><span id="line-42"> /**</span>
	<span class="source-line-no">043</span><span id="line-43"> * Use this instance whenever limits do not need to be enforced.</span>
	<span class="source-line-no">044</span><span id="line-44"> */</span>
	<span class="source-line-no">045</span><span id="line-45"> private static final ScannerContext NO_LIMIT = new NoLimitScannerContext();</span>
	<span class="source-line-no">046</span><span id="line-46"></span>
	<span class="source-line-no">047</span><span id="line-47"> /**</span>
	<span class="source-line-no">048</span><span id="line-48"> * Returns the static, immutable instance of {@link NoLimitScannerContext} to be used whenever</span>
	<span class="source-line-no">049</span><span id="line-49"> * limits should not be enforced</span>
	<span class="source-line-no">050</span><span id="line-50"> */</span>
	<span class="source-line-no">051</span><span id="line-51"> @edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "MS_EXPOSE_REP",</span>
	<span class="source-line-no">052</span><span id="line-52"> justification = "singleton pattern")</span>
	<span class="source-line-no">053</span><span id="line-53"> public static final ScannerContext getInstance() {</span>
	<span class="source-line-no">054</span><span id="line-54"> return NO_LIMIT;</span>
	<span class="source-line-no">055</span><span id="line-55"> }</span>
	<span class="source-line-no">056</span><span id="line-56"></span>
	<span class="source-line-no">057</span><span id="line-57"> @Override</span>
	<span class="source-line-no">058</span><span id="line-58"> void setKeepProgress(boolean keepProgress) {</span>
	<span class="source-line-no">059</span><span id="line-59"> // Do nothing. NoLimitScannerContext instances are immutable post-construction</span>
	<span class="source-line-no">060</span><span id="line-60"> }</span>
	<span class="source-line-no">061</span><span id="line-61"></span>
	<span class="source-line-no">062</span><span id="line-62"> @Override</span>
	<span class="source-line-no">063</span><span id="line-63"> void setBatchProgress(int batchProgress) {</span>
	<span class="source-line-no">064</span><span id="line-64"> // Do nothing. NoLimitScannerContext instances are immutable post-construction</span>
	<span class="source-line-no">065</span><span id="line-65"> }</span>
	<span class="source-line-no">066</span><span id="line-66"></span>
	<span class="source-line-no">067</span><span id="line-67"> @Override</span>
	<span class="source-line-no">068</span><span id="line-68"> void setSizeProgress(long sizeProgress, long heapSizeProgress) {</span>
	<span class="source-line-no">069</span><span id="line-69"> // Do nothing. NoLimitScannerContext instances are immutable post-construction</span>
	<span class="source-line-no">070</span><span id="line-70"> }</span>
	<span class="source-line-no">071</span><span id="line-71"></span>
	<span class="source-line-no">072</span><span id="line-72"> @Override</span>
	<span class="source-line-no">073</span><span id="line-73"> void setProgress(int batchProgress, long sizeProgress, long heapSizeProgress) {</span>
	<span class="source-line-no">074</span><span id="line-74"> // Do nothing. NoLimitScannerContext instances are immutable post-construction</span>
	<span class="source-line-no">075</span><span id="line-75"> }</span>
	<span class="source-line-no">076</span><span id="line-76"></span>
	<span class="source-line-no">077</span><span id="line-77"> @Override</span>
	<span class="source-line-no">078</span><span id="line-78"> void clearProgress() {</span>
	<span class="source-line-no">079</span><span id="line-79"> // Do nothing. NoLimitScannerContext instances are immutable post-construction</span>
	<span class="source-line-no">080</span><span id="line-80"> }</span>
	<span class="source-line-no">081</span><span id="line-81"></span>
	<span class="source-line-no">082</span><span id="line-82"> @Override</span>
	<span class="source-line-no">083</span><span id="line-83"> void setSizeLimitScope(LimitScope scope) {</span>
	<span class="source-line-no">084</span><span id="line-84"> // Do nothing. NoLimitScannerContext instances are immutable post-construction</span>
	<span class="source-line-no">085</span><span id="line-85"> }</span>
	<span class="source-line-no">086</span><span id="line-86"></span>
	<span class="source-line-no">087</span><span id="line-87"> @Override</span>
	<span class="source-line-no">088</span><span id="line-88"> void setTimeLimitScope(LimitScope scope) {</span>
	<span class="source-line-no">089</span><span id="line-89"> // Do nothing. NoLimitScannerContext instances are immutable post-construction</span>
	<span class="source-line-no">090</span><span id="line-90"> }</span>
	<span class="source-line-no">091</span><span id="line-91"></span>
	<span class="source-line-no">092</span><span id="line-92"> @Override</span>
	<span class="source-line-no">093</span><span id="line-93"> NextState setScannerState(NextState state) {</span>
	<span class="source-line-no">094</span><span id="line-94"> // Do nothing. NoLimitScannerContext instances are immutable post-construction</span>
	<span class="source-line-no">095</span><span id="line-95"> return state;</span>
	<span class="source-line-no">096</span><span id="line-96"> }</span>
	<span class="source-line-no">097</span><span id="line-97"></span>
	<span class="source-line-no">098</span><span id="line-98"> @Override</span>
	<span class="source-line-no">099</span><span id="line-99"> boolean checkBatchLimit(LimitScope checkerScope) {</span>
	<span class="source-line-no">100</span><span id="line-100"> // No limits can be specified, thus return false to indicate no limit has been reached.</span>
	<span class="source-line-no">101</span><span id="line-101"> return false;</span>
	<span class="source-line-no">102</span><span id="line-102"> }</span>
	<span class="source-line-no">103</span><span id="line-103"></span>
	<span class="source-line-no">104</span><span id="line-104"> @Override</span>
	<span class="source-line-no">105</span><span id="line-105"> boolean checkSizeLimit(LimitScope checkerScope) {</span>
	<span class="source-line-no">106</span><span id="line-106"> // No limits can be specified, thus return false to indicate no limit has been reached.</span>
	<span class="source-line-no">107</span><span id="line-107"> return false;</span>
	<span class="source-line-no">108</span><span id="line-108"> }</span>
	<span class="source-line-no">109</span><span id="line-109"></span>
	<span class="source-line-no">110</span><span id="line-110"> @Override</span>
	<span class="source-line-no">111</span><span id="line-111"> boolean checkTimeLimit(LimitScope checkerScope) {</span>
	<span class="source-line-no">112</span><span id="line-112"> // No limits can be specified, thus return false to indicate no limit has been reached.</span>
	<span class="source-line-no">113</span><span id="line-113"> return false;</span>
	<span class="source-line-no">114</span><span id="line-114"> }</span>
	<span class="source-line-no">115</span><span id="line-115"></span>
	<span class="source-line-no">116</span><span id="line-116"> @Override</span>
	<span class="source-line-no">117</span><span id="line-117"> boolean checkAnyLimitReached(LimitScope checkerScope) {</span>
	<span class="source-line-no">118</span><span id="line-118"> return false;</span>
	<span class="source-line-no">119</span><span id="line-119"> }</span>
	<span class="source-line-no">120</span><span id="line-120">}</span>




























































	</pre>
	</div>
	</main>
	</body>
	</html>