| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ScannerContext.LimitFields (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase.regionserver, class: ScannerContext, class: LimitFields"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/ScannerContext.LimitFields.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.regionserver</a></div> |
| <h1 title="Class ScannerContext.LimitFields" class="title">Class ScannerContext.LimitFields</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.hadoop.hbase.regionserver.ScannerContext.LimitFields</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="ScannerContext.html" title="class in org.apache.hadoop.hbase.regionserver">ScannerContext</a></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">private static class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.html#line-565">ScannerContext.LimitFields</a></span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">The different fields that can be used as limits in calls to |
| <a href="InternalScanner.html#next(java.util.List)"><code>InternalScanner.next(java.util.List)</code></a> and <a href="InternalScanner.html#next(java.util.List)"><code>InternalScanner.next(java.util.List)</code></a></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>(package private) int</code></div> |
| <div class="col-second even-row-color"><code><a href="#batch" class="member-name-link">batch</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>(package private) long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#blockSize" class="member-name-link">blockSize</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>(package private) long</code></div> |
| <div class="col-second even-row-color"><code><a href="#dataSize" class="member-name-link">dataSize</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private static int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_BATCH" class="member-name-link">DEFAULT_BATCH</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Default values of the limit fields.</div> |
| </div> |
| <div class="col-first even-row-color"><code>private static final <a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_SCOPE" class="member-name-link">DEFAULT_SCOPE</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Default scope that is assigned to a limit if a scope is not specified.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private static long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_SIZE" class="member-name-link">DEFAULT_SIZE</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private static long</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_TIME" class="member-name-link">DEFAULT_TIME</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>(package private) long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#heapSize" class="member-name-link">heapSize</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>(package private) <a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#sizeScope" class="member-name-link">sizeScope</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>(package private) long</code></div> |
| <div class="col-second odd-row-color"><code><a href="#time" class="member-name-link">time</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>(package private) <a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#timeScope" class="member-name-link">timeScope</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">LimitFields</a>()</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Fields keep their default values.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canEnforceBatchLimitFromScope(org.apache.hadoop.hbase.regionserver.ScannerContext.LimitScope)" class="member-name-link">canEnforceBatchLimitFromScope</a><wbr>(<a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a> checkerScope)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns true when the limit can be enforced from the scope of the checker</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canEnforceSizeLimitFromScope(org.apache.hadoop.hbase.regionserver.ScannerContext.LimitScope)" class="member-name-link">canEnforceSizeLimitFromScope</a><wbr>(<a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a> checkerScope)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns true when the limit can be enforced from the scope of the checker</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#canEnforceTimeLimitFromScope(org.apache.hadoop.hbase.regionserver.ScannerContext.LimitScope)" class="member-name-link">canEnforceTimeLimitFromScope</a><wbr>(<a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a> checkerScope)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns true when the limit can be enforced from the scope of the checker</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#copy(org.apache.hadoop.hbase.regionserver.ScannerContext.LimitFields)" class="member-name-link">copy</a><wbr>(<a href="ScannerContext.LimitFields.html" title="class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitFields</a> limitsToCopy)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBatch()" class="member-name-link">getBatch</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getBlockSize()" class="member-name-link">getBlockSize</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDataSize()" class="member-name-link">getDataSize</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeapSize()" class="member-name-link">getHeapSize</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) <a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSizeScope()" class="member-name-link">getSizeScope</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns <a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver"><code>ScannerContext.LimitScope</code></a> indicating scope in which the size limit is enforced</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTime()" class="member-name-link">getTime</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) <a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTimeScope()" class="member-name-link">getTimeScope</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns <a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver"><code>ScannerContext.LimitScope</code></a> indicating scope in which the time limit is enforced</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setBatch(int)" class="member-name-link">setBatch</a><wbr>(int batch)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setBlockSize(long)" class="member-name-link">setBlockSize</a><wbr>(long blockSize)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDataSize(long)" class="member-name-link">setDataSize</a><wbr>(long dataSize)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setFields(int,org.apache.hadoop.hbase.regionserver.ScannerContext.LimitScope,long,long,long,org.apache.hadoop.hbase.regionserver.ScannerContext.LimitScope,long)" class="member-name-link">setFields</a><wbr>(int batch, |
| <a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a> sizeScope, |
| long dataSize, |
| long heapSize, |
| long blockSize, |
| <a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a> timeScope, |
| long time)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set all fields together.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setHeapSize(long)" class="member-name-link">setHeapSize</a><wbr>(long heapSize)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setSizeScope(org.apache.hadoop.hbase.regionserver.ScannerContext.LimitScope)" class="member-name-link">setSizeScope</a><wbr>(<a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a> scope)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Change the scope in which the size limit is enforced</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTime(long)" class="member-name-link">setTime</a><wbr>(long time)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setTimeScope(org.apache.hadoop.hbase.regionserver.ScannerContext.LimitScope)" class="member-name-link">setTimeScope</a><wbr>(<a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a> scope)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Change the scope in which the time limit is enforced</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="DEFAULT_BATCH"> |
| <h3>DEFAULT_BATCH</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-570">DEFAULT_BATCH</a></span></div> |
| <div class="block">Default values of the limit fields. Defined such that if a field does NOT change from its |
| default, it will not be enforced</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_SIZE"> |
| <h3>DEFAULT_SIZE</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-571">DEFAULT_SIZE</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_TIME"> |
| <h3>DEFAULT_TIME</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-572">DEFAULT_TIME</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_SCOPE"> |
| <h3>DEFAULT_SCOPE</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type"><a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-577">DEFAULT_SCOPE</a></span></div> |
| <div class="block">Default scope that is assigned to a limit if a scope is not specified.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="batch"> |
| <h3>batch</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-581">batch</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="sizeScope"> |
| <h3>sizeScope</h3> |
| <div class="member-signature"><span class="return-type"><a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-583">sizeScope</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="dataSize"> |
| <h3>dataSize</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-585">dataSize</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="heapSize"> |
| <h3>heapSize</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-588">heapSize</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="blockSize"> |
| <h3>blockSize</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-591">blockSize</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="timeScope"> |
| <h3>timeScope</h3> |
| <div class="member-signature"><span class="return-type"><a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-593">timeScope</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="time"> |
| <h3>time</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-594">time</a></span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>LimitFields</h3> |
| <div class="member-signature"><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-599">LimitFields</a></span>()</div> |
| <div class="block">Fields keep their default values.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="copy(org.apache.hadoop.hbase.regionserver.ScannerContext.LimitFields)"> |
| <h3>copy</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-602">copy</a></span><wbr><span class="parameters">(<a href="ScannerContext.LimitFields.html" title="class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitFields</a> limitsToCopy)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFields(int,org.apache.hadoop.hbase.regionserver.ScannerContext.LimitScope,long,long,long,org.apache.hadoop.hbase.regionserver.ScannerContext.LimitScope,long)"> |
| <h3>setFields</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-613">setFields</a></span><wbr><span class="parameters">(int batch, |
| <a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a> sizeScope, |
| long dataSize, |
| long heapSize, |
| long blockSize, |
| <a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a> timeScope, |
| long time)</span></div> |
| <div class="block">Set all fields together.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBatch()"> |
| <h3>getBatch</h3> |
| <div class="member-signature"><span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-624">getBatch</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setBatch(int)"> |
| <h3>setBatch</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-628">setBatch</a></span><wbr><span class="parameters">(int batch)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="canEnforceBatchLimitFromScope(org.apache.hadoop.hbase.regionserver.ScannerContext.LimitScope)"> |
| <h3>canEnforceBatchLimitFromScope</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-633">canEnforceBatchLimitFromScope</a></span><wbr><span class="parameters">(<a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a> checkerScope)</span></div> |
| <div class="block">Returns true when the limit can be enforced from the scope of the checker</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDataSize()"> |
| <h3>getDataSize</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-637">getDataSize</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getHeapSize()"> |
| <h3>getHeapSize</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-641">getHeapSize</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBlockSize()"> |
| <h3>getBlockSize</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-645">getBlockSize</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDataSize(long)"> |
| <h3>setDataSize</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-649">setDataSize</a></span><wbr><span class="parameters">(long dataSize)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setHeapSize(long)"> |
| <h3>setHeapSize</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-653">setHeapSize</a></span><wbr><span class="parameters">(long heapSize)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setBlockSize(long)"> |
| <h3>setBlockSize</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-657">setBlockSize</a></span><wbr><span class="parameters">(long blockSize)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSizeScope()"> |
| <h3>getSizeScope</h3> |
| <div class="member-signature"><span class="return-type"><a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-662">getSizeScope</a></span>()</div> |
| <div class="block">Returns <a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver"><code>ScannerContext.LimitScope</code></a> indicating scope in which the size limit is enforced</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSizeScope(org.apache.hadoop.hbase.regionserver.ScannerContext.LimitScope)"> |
| <h3>setSizeScope</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-669">setSizeScope</a></span><wbr><span class="parameters">(<a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a> scope)</span></div> |
| <div class="block">Change the scope in which the size limit is enforced</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="canEnforceSizeLimitFromScope(org.apache.hadoop.hbase.regionserver.ScannerContext.LimitScope)"> |
| <h3>canEnforceSizeLimitFromScope</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-674">canEnforceSizeLimitFromScope</a></span><wbr><span class="parameters">(<a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a> checkerScope)</span></div> |
| <div class="block">Returns true when the limit can be enforced from the scope of the checker</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTime()"> |
| <h3>getTime</h3> |
| <div class="member-signature"><span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-678">getTime</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTime(long)"> |
| <h3>setTime</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-682">setTime</a></span><wbr><span class="parameters">(long time)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTimeScope()"> |
| <h3>getTimeScope</h3> |
| <div class="member-signature"><span class="return-type"><a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-687">getTimeScope</a></span>()</div> |
| <div class="block">Returns <a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver"><code>ScannerContext.LimitScope</code></a> indicating scope in which the time limit is enforced</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setTimeScope(org.apache.hadoop.hbase.regionserver.ScannerContext.LimitScope)"> |
| <h3>setTimeScope</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-694">setTimeScope</a></span><wbr><span class="parameters">(<a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a> scope)</span></div> |
| <div class="block">Change the scope in which the time limit is enforced</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="canEnforceTimeLimitFromScope(org.apache.hadoop.hbase.regionserver.ScannerContext.LimitScope)"> |
| <h3>canEnforceTimeLimitFromScope</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-699">canEnforceTimeLimitFromScope</a></span><wbr><span class="parameters">(<a href="ScannerContext.LimitScope.html" title="enum class in org.apache.hadoop.hbase.regionserver">ScannerContext.LimitScope</a> checkerScope)</span></div> |
| <div class="block">Returns true when the limit can be enforced from the scope of the checker</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/ScannerContext.LimitFields.html#line-703">toString</a></span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
