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

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

@API(INTERNAL)
public class ByteScanLimiterFactory
extends Object

A factory that produces implementations of ByteScanLimiters.

Method Summary

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

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

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