ReadMode (Pinot Service Provider Interface 0.12.1 API)

java.lang.Object
- java.lang.Enum<ReadMode>
- - org.apache.pinot.spi.utils.ReadMode

All Implemented Interfaces:

Serializable, Comparable<ReadMode>, java.lang.constant.Constable
```
public enum ReadMode
extends Enum<ReadMode>
```
Enum class for segment read mode:
- heap: Segments are loaded on direct-memory. Note, 'heap' here is a legacy misnomer, and it does not imply JVM heap. This mode should only be used when we want faster performance than memory-mapped files, and are also sure that we will never run into OOM.
- mmap: Segments are loaded on memory-mapped file. This is the default mode.

Nested Class Summary
- Nested classes/interfaces inherited from class java.lang.Enum
  Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants
Enum Constant Description

heap

mmap

Field Summary

Fields
Modifier and Type Field Description

static ReadMode DEFAULT_MODE

Method Summary

Modifier and Type	Method	Description
`static ReadMode`	`getEnum(String strVal)`
`static ReadMode`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static ReadMode[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - heap
```
public static final ReadMode heap
```
  - mmap
```
public static final ReadMode mmap
```
- Field Detail
  - DEFAULT_MODE
```
public static final ReadMode DEFAULT_MODE
```
- Method Detail
  - values
```
public static ReadMode[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared.
    
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ReadMode valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getEnum
```
public static ReadMode getEnum(String strVal)
```