com.apple.foundationdb.record

Class RecordScanLimiter

java.lang.Object

com.apple.foundationdb.record.RecordScanLimiter

@API(value=MAINTAINED)
public class RecordScanLimiter
extends Object

Track number of records scanned up to some limit, after which record scans should not be allowed.

See Also:

ExecuteState.getRecordScanLimiter()

Constructor Summary

Constructors

Constructor and Description
RecordScanLimiter(int limit)

Method Summary

Modifier and Type	Method and Description
int	getLimit() Get the record scan limit.
RecordScanLimiter	reset() Create a new RecordScanLimiter with this limiter's original limit, ignoring any calls to tryRecordScan().
String	toString()
boolean	tryRecordScan() Atomically decrement the counter and return false if falls below 0.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordScanLimiter

public RecordScanLimiter(int limit)

Method Detail

reset

@Nonnull
public RecordScanLimiter reset()

Create a new RecordScanLimiter with this limiter's original limit, ignoring any calls to tryRecordScan().

Returns:

a new limiter with the same original scan limit as this limiter

tryRecordScan

public boolean tryRecordScan()

Atomically decrement the counter and return false if falls below 0.

Returns:

true if the remaining count is at least 0, and false if it is less than 0

getLimit

public int getLimit()

Get the record scan limit. In particular, this will return the target number of records that this limiter is being used to enforce.

Returns:

the record scan limit being enforced

toString

public String toString()

Overrides:

toString in class Object