# Uses of Package
org.apache.lucene.store

- Packages that use org.apache.lucene.store
  Package | Description
  --- | ---
  org.apache.lucene.codecs | Codecs API: API for customization of the encoding and structure of the index.
  org.apache.lucene.codecs.compressing | StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.
  org.apache.lucene.codecs.lucene50 | Components from the Lucene 5.0 index format See `org.apache.lucene.codecs.lucene80` for an overview of the index format.
  org.apache.lucene.codecs.lucene60 | Components from the Lucene 6.0 index format.
  org.apache.lucene.codecs.lucene84 | Components from the Lucene 8.4 index format.
  org.apache.lucene.codecs.lucene86 | Lucene 8.6 file format.
  org.apache.lucene.index | Code to maintain and access indices.
  org.apache.lucene.search | Code to search indices.
  org.apache.lucene.store | Binary i/o API, used for all index data.
  org.apache.lucene.util | Some utility classes.
  org.apache.lucene.util.bkd | Block KD-tree, implementing the generic spatial data structure described in this paper.
  org.apache.lucene.util.compress | Compression utilities.
  org.apache.lucene.util.fst | Finite state transducers
  org.apache.lucene.util.packed | Packed integer arrays and streams.

- Classes in org.apache.lucene.store used by org.apache.lucene.codecs
  Class and Description
  ChecksumIndexInput Extension of IndexInput, computing checksum as it goes.
  DataInput Abstract base class for performing read operations of Lucene's low-level data types.
  DataOutput Abstract base class for performing write operations of Lucene's low-level data types.
  Directory A `Directory` provides an abstraction layer for storing a list of files.
  IndexInput Abstract base class for input from a file in a `Directory`.
  IndexOutput A `DataOutput` for appending data to a file in a `Directory`.
  IOContext IOContext holds additional details on the merge/search context.
  Lock An interprocess mutex lock.

- Classes in org.apache.lucene.store used by org.apache.lucene.codecs.compressing
  Class and Description
  DataInput Abstract base class for performing read operations of Lucene's low-level data types.
  DataOutput Abstract base class for performing write operations of Lucene's low-level data types.
  Directory A `Directory` provides an abstraction layer for storing a list of files.
  IOContext IOContext holds additional details on the merge/search context.

- Classes in org.apache.lucene.store used by org.apache.lucene.codecs.lucene50
  Class and Description
  Directory A `Directory` provides an abstraction layer for storing a list of files.
  IOContext IOContext holds additional details on the merge/search context.

- Classes in org.apache.lucene.store used by org.apache.lucene.codecs.lucene60
  Class and Description
  Directory A `Directory` provides an abstraction layer for storing a list of files.
  IOContext IOContext holds additional details on the merge/search context.

- Classes in org.apache.lucene.store used by org.apache.lucene.codecs.lucene84
  Class and Description
  DataInput Abstract base class for performing read operations of Lucene's low-level data types.
  DataOutput Abstract base class for performing write operations of Lucene's low-level data types.
  IndexInput Abstract base class for input from a file in a `Directory`.
  IndexOutput A `DataOutput` for appending data to a file in a `Directory`.

- Classes in org.apache.lucene.store used by org.apache.lucene.codecs.lucene86
  Class and Description
  Directory A `Directory` provides an abstraction layer for storing a list of files.
  IndexOutput A `DataOutput` for appending data to a file in a `Directory`.
  IOContext IOContext holds additional details on the merge/search context.

- Classes in org.apache.lucene.store used by org.apache.lucene.index
  Class and Description
  AlreadyClosedException This exception is thrown when there is an attempt to access something that has already been closed.
  ChecksumIndexInput Extension of IndexInput, computing checksum as it goes.
  DataInput Abstract base class for performing read operations of Lucene's low-level data types.
  DataOutput Abstract base class for performing write operations of Lucene's low-level data types.
  Directory A `Directory` provides an abstraction layer for storing a list of files.
  IndexOutput A `DataOutput` for appending data to a file in a `Directory`.
  IOContext IOContext holds additional details on the merge/search context.
  Lock An interprocess mutex lock.
  MergeInfo A MergeInfo provides information required for a MERGE context.
  RateLimiter Abstract base class to rate limit IO.

- Classes in org.apache.lucene.store used by org.apache.lucene.search
  Class and Description
  DataInput Abstract base class for performing read operations of Lucene's low-level data types.
  DataOutput Abstract base class for performing write operations of Lucene's low-level data types.
  Directory A `Directory` provides an abstraction layer for storing a list of files.

- Classes in org.apache.lucene.store used by org.apache.lucene.store
  Class and Description
  AlreadyClosedException This exception is thrown when there is an attempt to access something that has already been closed.
  BaseDirectory Base implementation for a concrete `Directory` that uses a `LockFactory` for locking.
  BufferedIndexInput Base implementation class for buffered `IndexInput`.
  ByteBufferIndexInput Base IndexInput implementation that uses an array of ByteBuffers to represent a file.
  ByteBuffersDataInput A `DataInput` implementing `RandomAccessInput` and reading data from a list of `ByteBuffer`s.
  ByteBuffersDataOutput A `DataOutput` storing data in a list of `ByteBuffer`s.
  ByteBuffersIndexInput An `IndexInput` implementing `RandomAccessInput` and backed by a `ByteBuffersDataInput`.
  ChecksumIndexInput Extension of IndexInput, computing checksum as it goes.
  DataInput Abstract base class for performing read operations of Lucene's low-level data types.
  DataOutput Abstract base class for performing write operations of Lucene's low-level data types.
  Directory A `Directory` provides an abstraction layer for storing a list of files.
  FilterDirectory Directory implementation that delegates calls to another directory.
  FlushInfo A FlushInfo provides information required for a FLUSH context.
  FSDirectory Base class for Directory implementations that store index files in the file system.
  FSLockFactory Base class for file system based locking implementation.
  IndexInput Abstract base class for input from a file in a `Directory`.
  IndexOutput A `DataOutput` for appending data to a file in a `Directory`.
  IOContext IOContext holds additional details on the merge/search context.
  IOContext.Context Context is a enumerator which specifies the context in which the Directory is being used for.
  Lock An interprocess mutex lock.
  LockFactory Base class for Locking implementation.
  MergeInfo A MergeInfo provides information required for a MERGE context.
  NativeFSLockFactory Implements `LockFactory` using native OS file locks.
  NoLockFactory Use this `LockFactory` to disable locking entirely.
  RAMFile Deprecated. This class uses inefficient synchronization and is discouraged in favor of `MMapDirectory`. It will be removed in future versions of Lucene.
  RandomAccessInput Random Access Index API.
  RateLimiter Abstract base class to rate limit IO.
  SimpleFSLockFactory Implements `LockFactory` using `Files.createFile(java.nio.file.Path, java.nio.file.attribute.FileAttribute<?>...)`.

- Classes in org.apache.lucene.store used by org.apache.lucene.util
  Class and Description
  ChecksumIndexInput Extension of IndexInput, computing checksum as it goes.
  DataInput Abstract base class for performing read operations of Lucene's low-level data types.
  DataOutput Abstract base class for performing write operations of Lucene's low-level data types.
  Directory A `Directory` provides an abstraction layer for storing a list of files.
  FSDirectory Base class for Directory implementations that store index files in the file system.
  IndexInput Abstract base class for input from a file in a `Directory`.
  IndexOutput A `DataOutput` for appending data to a file in a `Directory`.
  LockFactory Base class for Locking implementation.

- Classes in org.apache.lucene.store used by org.apache.lucene.util.bkd
  Class and Description
  Directory A `Directory` provides an abstraction layer for storing a list of files.
  IndexInput Abstract base class for input from a file in a `Directory`.
  IndexOutput A `DataOutput` for appending data to a file in a `Directory`.

- Classes in org.apache.lucene.store used by org.apache.lucene.util.compress
  Class and Description
  DataInput Abstract base class for performing read operations of Lucene's low-level data types.
  DataOutput Abstract base class for performing write operations of Lucene's low-level data types.

- Classes in org.apache.lucene.store used by org.apache.lucene.util.fst
  Class and Description
  DataInput Abstract base class for performing read operations of Lucene's low-level data types.
  DataOutput Abstract base class for performing write operations of Lucene's low-level data types.

- Classes in org.apache.lucene.store used by org.apache.lucene.util.packed
  Class and Description
  DataInput Abstract base class for performing read operations of Lucene's low-level data types.
  DataOutput Abstract base class for performing write operations of Lucene's low-level data types.
  IndexInput Abstract base class for input from a file in a `Directory`.
  IndexOutput A `DataOutput` for appending data to a file in a `Directory`.
  RandomAccessInput Random Access Index API.

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