PreloadHint (Lucene 10.5.0 core API)
Description: declaration: package: org.apache.lucene.store, enum: PreloadHint

Package org.apache.lucene.store

# Enum Class PreloadHint

java.lang.Object
java.lang.Enum<PreloadHint>
org.apache.lucene.store.PreloadHint

All Implemented Interfaces:
  `Serializable`, `Comparable<PreloadHint>`, `Constable`, `IOContext.FileOpenHint`

public enum PreloadHint extends Enum<PreloadHint> implements IOContext.FileOpenHint
A hint that the file should be preloaded into memory

- ## 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
  `INSTANCE`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static PreloadHint`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static PreloadHint[]`
  `values()`
  Returns an array containing the constants of this enum class, 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 Details

  - ### INSTANCE

    public static final PreloadHint INSTANCE

- ## Method Details

  - ### values

    public static PreloadHint[] values()
    Returns an array containing the constants of this enum class, in the order they are declared.
    Returns:
      an array containing the constants of this enum class, in the order they are declared

  - ### valueOf

    public static PreloadHint valueOf(String name)
    Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      `NullPointerException` - if the argument is null