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

Field Summary

Fields

Modifier and Type	Field and Description
private static ScannerContext	NO_LIMIT Use this instance whenever limits do not need to be enforced.

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

keepProgress, limits, metrics, progress, scannerState

Constructor Summary

Constructors

Constructor and Description
NoLimitScannerContext()

Method Summary

Modifier and Type	Method and Description
(package private) boolean	checkAnyLimitReached(ScannerContext.LimitScope checkerScope)
(package private) boolean	checkBatchLimit(ScannerContext.LimitScope checkerScope)
(package private) boolean	checkSizeLimit(ScannerContext.LimitScope checkerScope)
(package private) boolean	checkTimeLimit(ScannerContext.LimitScope checkerScope)
(package private) void	clearProgress() Clear away any progress that has been made so far.
static ScannerContext	getInstance()
(package private) void	setBatchProgress(int batchProgress)
(package private) void	setKeepProgress(boolean keepProgress)
(package private) void	setProgress(int batchProgress, long sizeProgress, long heapSizeProgress)
(package private) ScannerContext.NextState	setScannerState(ScannerContext.NextState state) Note that this is not a typical setter.
(package private) void	setSizeLimitScope(ScannerContext.LimitScope scope)
(package private) void	setSizeProgress(long sizeProgress, long heapSizeProgress)
(package private) void	setTimeLimitScope(ScannerContext.LimitScope scope)

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

getBatchLimit, getBatchProgress, getDataSizeLimit, getDataSizeProgress, getHeapSizeProgress, getKeepProgress, getLastPeekedCell, getMetrics, getTimeLimit, getTimeProgress, hasAnyLimit, hasBatchLimit, hasSizeLimit, hasTimeLimit, incrementBatchProgress, incrementSizeProgress, isTrackingMetrics, mayHaveMoreCellsInRow, newBuilder, newBuilder, returnImmediately, setLastPeekedCell, setProgress, setTimeProgress, toString, updateTimeProgress

Methods inherited from class java.lang.Object

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

Field Detail

NO_LIMIT

private static final ScannerContext NO_LIMIT

Use this instance whenever limits do not need to be enforced.

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

setKeepProgress

void setKeepProgress(boolean keepProgress)

Overrides:

setKeepProgress in class ScannerContext

setBatchProgress

void setBatchProgress(int batchProgress)

Overrides:

setBatchProgress in class ScannerContext

setSizeProgress

void setSizeProgress(long sizeProgress,
                     long heapSizeProgress)

Overrides:

setSizeProgress in class ScannerContext

setProgress

void setProgress(int batchProgress,
                 long sizeProgress,
                 long heapSizeProgress)

Overrides:

setProgress in class ScannerContext

clearProgress

void clearProgress()

Description copied from class: ScannerContext

Clear away any progress that has been made so far. All progress fields are reset to initial values

Overrides:

clearProgress in class ScannerContext

setSizeLimitScope

void setSizeLimitScope(ScannerContext.LimitScope scope)

Overrides:

setSizeLimitScope in class ScannerContext

Parameters:

scope - The scope in which the size limit will be enforced

setTimeLimitScope

void setTimeLimitScope(ScannerContext.LimitScope scope)

Overrides:

setTimeLimitScope in class ScannerContext

Parameters:

scope - The scope in which the time limit will be enforced

setScannerState

ScannerContext.NextState setScannerState(ScannerContext.NextState state)

Description copied from class: ScannerContext

Note that this is not a typical setter. This setter returns the ScannerContext.NextState that was passed in so that methods can be invoked against the new state. Furthermore, this pattern allows the NoLimitScannerContext to cleanly override this setter and simply return the new state, thus preserving the immutability of NoLimitScannerContext

Overrides:

setScannerState in class ScannerContext

Returns:

The state that was passed in.

checkBatchLimit

boolean checkBatchLimit(ScannerContext.LimitScope checkerScope)

Overrides:

checkBatchLimit in class ScannerContext

Parameters:

checkerScope - The scope that the limit is being checked from

Returns:

true when the limit is enforceable from the checker's scope and it has been reached

checkSizeLimit

boolean checkSizeLimit(ScannerContext.LimitScope checkerScope)

Overrides:

checkSizeLimit in class ScannerContext

Parameters:

checkerScope - The scope that the limit is being checked from

Returns:

true when the limit is enforceable from the checker's scope and it has been reached

checkTimeLimit

boolean checkTimeLimit(ScannerContext.LimitScope checkerScope)

Overrides:

checkTimeLimit in class ScannerContext

Parameters:

checkerScope - The scope that the limit is being checked from. The time limit is always checked against System.currentTimeMillis()

Returns:

true when the limit is enforceable from the checker's scope and it has been reached

checkAnyLimitReached

boolean checkAnyLimitReached(ScannerContext.LimitScope checkerScope)

Overrides:

checkAnyLimitReached in class ScannerContext

Parameters:

checkerScope - The scope that the limits are being checked from

Returns:

true when some limit is enforceable from the checker's scope and it has been reached