Module org.apache.lucene.suggest
Enum Class CompletionPostingsFormat.FSTLoadMode
java.lang.Object
java.lang.Enum<CompletionPostingsFormat.FSTLoadMode>
org.apache.lucene.search.suggest.document.CompletionPostingsFormat.FSTLoadMode
- All Implemented Interfaces:
Serializable
,Comparable<CompletionPostingsFormat.FSTLoadMode>
,Constable
- Enclosing class:
- CompletionPostingsFormat
public static enum CompletionPostingsFormat.FSTLoadMode
extends Enum<CompletionPostingsFormat.FSTLoadMode>
An enum that allows to control if suggester FSTs are loaded into memory or read off-heap
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the enum constant of this class with the specified name.static CompletionPostingsFormat.FSTLoadMode[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
OFF_HEAP
Always read FSTs from disk. NOTE: If this option is used the FST will be read off-heap even if buffered directory implementations are used. -
ON_HEAP
Never read FSTs from disk ie. all suggest fields FSTs are loaded into memory -
AUTO
Automatically make the decision if FSTs are read from disk depending if the segment read from an MMAPDirectory
-
-
Constructor Details
-
FSTLoadMode
private FSTLoadMode()
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-