FSTDictionary.BrowserSupplier

java.lang.Object
- org.apache.lucene.codecs.uniformsplit.FSTDictionary.BrowserSupplier

All Implemented Interfaces:

IndexDictionary.BrowserSupplier, Accountable, IOSupplier<IndexDictionary.Browser>

Enclosing class:

FSTDictionary
```
public static class FSTDictionary.BrowserSupplier
extends java.lang.Object
implements IndexDictionary.BrowserSupplier
```
Provides stateful FSTDictionary.Browser to seek in the FSTDictionary.

Field Summary

Fields
Modifier and Type	Field	Description
`protected BlockDecoder`	`blockDecoder`
`protected IndexDictionary`	`dictionary`	Lazy loaded immutable index dictionary FST.
`protected IndexInput`	`dictionaryInput`
`protected boolean`	`isFSTOnHeap`

Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLE

Constructor Summary

Constructors
Constructor	Description
`BrowserSupplier(IndexInput dictionaryInput, long dictionaryStartFP, BlockDecoder blockDecoder, boolean isFSTOnHeap)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`IndexDictionary.Browser`	`get()`	Gets the result.
`long`	`ramBytesUsed()`	Return the memory usage of this object in bytes.

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

Methods inherited from interface org.apache.lucene.util.Accountable
getChildResources

- Field Detail
  - dictionaryInput
```
protected final IndexInput dictionaryInput
```
  - blockDecoder
```
protected final BlockDecoder blockDecoder
```
  - isFSTOnHeap
```
protected final boolean isFSTOnHeap
```
  - dictionary
```
protected IndexDictionary dictionary
```
    Lazy loaded immutable index dictionary FST. The FST is either kept off-heap, or hold in RAM on-heap.
- Constructor Detail
  - BrowserSupplier
```
public BrowserSupplier(IndexInput dictionaryInput,
                       long dictionaryStartFP,
                       BlockDecoder blockDecoder,
                       boolean isFSTOnHeap)
                throws java.io.IOException
```
    Throws:
    
    java.io.IOException
- Method Detail
  - get
```
public IndexDictionary.Browser get()
                            throws java.io.IOException
```
    Description copied from interface: IOSupplier
    
    Gets the result.
    
    Specified by:
    
    get in interface IOSupplier<IndexDictionary.Browser>
    
    Returns:
    
    the result
    
    Throws:
    
    java.io.IOException - if producing the result throws an IOException
  - ramBytesUsed
```
public long ramBytesUsed()
```
    Description copied from interface: Accountable
    
    Return the memory usage of this object in bytes. Negative values are illegal.
    
    Specified by:
    
    ramBytesUsed in interface Accountable