RecordScanLimiterFactory (fdb-record-layer-core-pb3 2.10.164.0 API)

java.lang.Object
- com.apple.foundationdb.record.RecordScanLimiterFactory

@API(INTERNAL)
public class RecordScanLimiterFactory
extends Object

A factory that produces implementations of RecordScanLimiters.

Constructor Summary

Constructors
Constructor Description

RecordScanLimiterFactory()

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static RecordScanLimiter`	`enforce(int limit)`	Creates a limiter that enforces a maximum number of records that can be processed in a single scan.
`static RecordScanLimiter`	`tracking()`	Creates a limiter that tracks the number of records that has been scanned, but does not impose a limit.
`static RecordScanLimiter`	`untracked()`	Creates a limiter that neither enforces nor tracks the number of records scanned.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RecordScanLimiterFactory
```
public RecordScanLimiterFactory()
```
- Method Detail
  - enforce
```
public static RecordScanLimiter enforce(int limit)
```
    Creates a limiter that enforces a maximum number of records that can be processed in a single scan.
    
    Parameters:
    
    limit - the maximum number of records that can be processed in a single scan
    
    Returns:
    
    an enforcing limiter
  - tracking
```
public static RecordScanLimiter tracking()
```
    Creates a limiter that tracks the number of records that has been scanned, but does not impose a limit.
    
    Returns:
    
    a tracking limiter
  - untracked
```
public static RecordScanLimiter untracked()
```
    Creates a limiter that neither enforces nor tracks the number of records scanned.
    
    Returns:
    
    an untracked limiter