org.apache.lucene.codecs.simpletext

## Class SimpleTextLiveDocsFormat

- java.lang.Object
- - org.apache.lucene.codecs.LiveDocsFormat
  - - org.apache.lucene.codecs.simpletext.SimpleTextLiveDocsFormat

-     public class SimpleTextLiveDocsFormat
      extends LiveDocsFormat

  reads/writes plaintext live docs

  FOR RECREATIONAL USE ONLY

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

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `SimpleTextLiveDocsFormat()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `files(SegmentInfoPerCommit info, Collection<String> files)`
    `MutableBits` | `newLiveDocs(Bits existing)`
    `MutableBits` | `newLiveDocs(int size)`
    `Bits` | `readLiveDocs(Directory dir, SegmentInfoPerCommit info, IOContext context)`
    `void` | `writeLiveDocs(MutableBits bits, Directory dir, SegmentInfoPerCommit info, int newDelCount, IOContext context)`

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

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

- - ### Constructor Detail

    - #### SimpleTextLiveDocsFormat

          public SimpleTextLiveDocsFormat()

  - ### Method Detail

    - #### newLiveDocs

          public MutableBits newLiveDocs(int size)
                                  throws IOException

      Specified by:
        `newLiveDocs` in class `LiveDocsFormat`
      Throws:
        `IOException`

    - #### newLiveDocs

          public MutableBits newLiveDocs(Bits existing)
                                  throws IOException

      Specified by:
        `newLiveDocs` in class `LiveDocsFormat`
      Throws:
        `IOException`

    - #### readLiveDocs

          public Bits readLiveDocs(Directory dir,
                          SegmentInfoPerCommit info,
                          IOContext context)
                            throws IOException

      Specified by:
        `readLiveDocs` in class `LiveDocsFormat`
      Throws:
        `IOException`

    - #### writeLiveDocs

          public void writeLiveDocs(MutableBits bits,
                           Directory dir,
                           SegmentInfoPerCommit info,
                           int newDelCount,
                           IOContext context)
                             throws IOException

      Specified by:
        `writeLiveDocs` in class `LiveDocsFormat`
      Throws:
        `IOException`

    - #### files

          public void files(SegmentInfoPerCommit info,
                   Collection<String> files)
                     throws IOException

      Specified by:
        `files` in class `LiveDocsFormat`
      Throws:
        `IOException`

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