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 ADataInputwrapping 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-basedDirectoryimplementation that uses mmap for reading, andFSDirectory.FSIndexOutputfor writing.NativeFSLockFactory ImplementsLockFactoryusing native OS file locks.NIOFSDirectory AnFSDirectoryimplementation 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 thisLockFactoryto disable locking entirely.NRTCachingDirectory Wraps aRAMDirectoryaround any provided delegate directory, to be used during NRT search.OutputStreamDataOutput ADataOutputwrapping a plainOutputStream.RAMDirectory A memory-residentDirectoryimplementation.RAMFile RAMInputStream A memory-residentIndexInputimplementation.RAMOutputStream A memory-residentIndexOutputimplementation.SimpleFSDirectory A straightforward implementation ofFSDirectoryusing java.io.RandomAccessFile.SimpleFSDirectory.SimpleFSIndexInput SimpleFSDirectory.SimpleFSIndexInput.Descriptor SimpleFSLockFactory ImplementsLockFactoryusingFile.createNewFile().SingleInstanceLockFactory ImplementsLockFactoryfor a single in-process instance, meaning all locking will take place through this one instance.VerifyingLockFactory ALockFactorythat wraps anotherLockFactoryand 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.lockcould not be acquired.LockReleaseFailedException This exception is thrown when thewrite.lockcould not be released.NoSuchDirectoryException This exception is thrown when you try to list a non-existent directory.