org.apache.hadoop.hbase.regionserver

Class NoLimitScannerContext

java.lang.Object

org.apache.hadoop.hbase.regionserver.ScannerContext

org.apache.hadoop.hbase.regionserver.NoLimitScannerContext

@InterfaceAudience.LimitedPrivate(value="Coprocesssor")
@InterfaceStability.Evolving
public class NoLimitScannerContext
extends ScannerContext

This is a special ScannerContext subclass that is designed to be used globally when limits should not be enforced during invocations of InternalScanner.next(java.util.List) or InternalScanner.next(java.util.List).

Instances of NoLimitScannerContext are immutable after construction. Any attempt to change the limits or progress of a NoLimitScannerContext will fail silently. The net effect is that all limit checks will return false, thus indicating that a limit has not been reached.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.regionserver.ScannerContext

ScannerContext.Builder, ScannerContext.LimitScope, ScannerContext.NextState

Constructor Summary

Constructors

Constructor and Description
NoLimitScannerContext()

Method Summary

Methods

Modifier and Type	Method and Description
static ScannerContext	getInstance()

Methods inherited from class org.apache.hadoop.hbase.regionserver.ScannerContext

newBuilder, newBuilder, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NoLimitScannerContext

public NoLimitScannerContext()

Method Detail

getInstance

public static final ScannerContext getInstance()

Returns:

The static, immutable instance of NoLimitScannerContext to be used whenever limits should not be enforced