org.apache.lucene.search.suggest.document

## Class Completion84PostingsFormat

- java.lang.Object
- - org.apache.lucene.codecs.PostingsFormat
  - - org.apache.lucene.search.suggest.document.CompletionPostingsFormat
    - - org.apache.lucene.search.suggest.document.Completion84PostingsFormat

- All Implemented Interfaces:
    NamedSPILoader.NamedSPI

      public class Completion84PostingsFormat
      extends CompletionPostingsFormat

  `CompletionPostingsFormat` for `Lucene84PostingsFormat`
  WARNING: This API is experimental and might change in incompatible ways in the next release.

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class org.apache.lucene.search.suggest.document.CompletionPostingsFormat

      `CompletionPostingsFormat.FSTLoadMode`

  - ### Field Summary

    - ### Fields inherited from class org.apache.lucene.codecs.PostingsFormat

      `EMPTY`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `Completion84PostingsFormat()` Creates a `Completion84PostingsFormat` that will load the completion FST on-heap.
    `Completion84PostingsFormat(CompletionPostingsFormat.FSTLoadMode fstLoadMode)` Creates a `Completion84PostingsFormat` that will use the provided `fstLoadMode` to determine if the completion FST should be loaded on or off heap.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected PostingsFormat` | `delegatePostingsFormat()` Concrete implementation should specify the delegating postings format

    - ### Methods inherited from class org.apache.lucene.search.suggest.document.CompletionPostingsFormat

      `fieldsConsumer, fieldsProducer`

    - ### Methods inherited from class org.apache.lucene.codecs.PostingsFormat

      `availablePostingsFormats, forName, getName, reloadPostingsFormats, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### Completion84PostingsFormat

          public Completion84PostingsFormat()

      Creates a `Completion84PostingsFormat` that will load the completion FST on-heap.

    - #### Completion84PostingsFormat

          public Completion84PostingsFormat(CompletionPostingsFormat.FSTLoadMode fstLoadMode)

      Creates a `Completion84PostingsFormat` that will use the provided `fstLoadMode` to determine if the completion FST should be loaded on or off heap.

  - ### Method Detail

    - #### delegatePostingsFormat

          protected PostingsFormat delegatePostingsFormat()

      Description copied from class: `CompletionPostingsFormat`
      Concrete implementation should specify the delegating postings format
      Specified by:
        `delegatePostingsFormat` in class `CompletionPostingsFormat`

Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.