Package org.apache.lucene.store
Binary i/o API, used for all index data.
-
Class Summary Class Description BufferedIndexInput Base implementation class for bufferedIndexInput
.BufferedIndexOutput Base implementation class for bufferedIndexOutput
.ByteArrayDataInput DataInput backed by a byte array.ByteArrayDataOutput DataOutput backed by a byte array.ChecksumIndexInput Writes bytes through to a primary IndexOutput, computing checksum as it goes.ChecksumIndexOutput Writes bytes through to a primary IndexOutput, computing checksum.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 is a flat list of files.FileSwitchDirectory Expert: A Directory instance that switches files between two other Directory instances.FSDirectory FSDirectory.FSIndexOutput FSLockFactory Base class for file system based locking implementation.IndexInput Abstract base class for input from a file in aDirectory
.IndexOutput Abstract base class for output to a file in a Directory.InputStreamDataInput ADataInput
wrapping a plainInputStream
.Lock An interprocess mutex lock.Lock.With Utility class for executing code with exclusive access.LockFactory Base class for Locking implementation.LockStressTest Simple standalone tool that forever acquires & releases a lock using a specific LockFactory.LockVerifyServer Simple standalone server that must be running when you useVerifyingLockFactory
.MMapDirectory File-basedDirectory
implementation that uses mmap for reading, andFSDirectory.FSIndexOutput
for writing.NativeFSLockFactory ImplementsLockFactory
using native OS file locks.NIOFSDirectory AnFSDirectory
implementation that uses java.nio's FileChannel's positional read, which allows multiple threads to read from the same file without synchronizing.NIOFSDirectory.NIOFSIndexInput NoLockFactory Use thisLockFactory
to disable locking entirely.NRTCachingDirectory Wraps aRAMDirectory
around any provided delegate directory, to be used during NRT search.OutputStreamDataOutput ADataOutput
wrapping a plainOutputStream
.RAMDirectory A memory-residentDirectory
implementation.RAMFile RAMInputStream A memory-residentIndexInput
implementation.RAMOutputStream A memory-residentIndexOutput
implementation.SimpleFSDirectory A straightforward implementation ofFSDirectory
using java.io.RandomAccessFile.SimpleFSDirectory.SimpleFSIndexInput SimpleFSDirectory.SimpleFSIndexInput.Descriptor SimpleFSLockFactory ImplementsLockFactory
usingFile.createNewFile()
.SingleInstanceLockFactory ImplementsLockFactory
for a single in-process instance, meaning all locking will take place through this one instance.VerifyingLockFactory ALockFactory
that wraps anotherLockFactory
and verifies that each lock obtain/release is "correct" (never results in two processes holding the lock at the same time). -
Exception Summary Exception Description AlreadyClosedException This exception is thrown when there is an attempt to access something that has already been closed.LockObtainFailedException This exception is thrown when thewrite.lock
could not be acquired.LockReleaseFailedException This exception is thrown when thewrite.lock
could not be released.NoSuchDirectoryException This exception is thrown when you try to list a non-existent directory.