Binary i/o API, used for all index data.
Class Summary Class Description BaseDirectoryBase implementation for a concrete
BufferedIndexInputBase implementation class for buffered
BufferedIndexOutputBase implementation class for buffered
ByteArrayDataInputDataInput backed by a byte array. ByteArrayDataOutputDataOutput backed by a byte array. ChecksumIndexInputReads bytes through to a primary IndexInput, computing checksum as it goes. ChecksumIndexOutputWrites bytes through to a primary IndexOutput, computing checksum. CompoundFileDirectoryClass for accessing a compound stream. CompoundFileDirectory.FileEntryOffset/Length for a slice inside of a compound file DataInputAbstract base class for performing read operations of Lucene's low-level data types. DataOutputAbstract base class for performing write operations of Lucene's low-level data types. DirectoryA Directory is a flat list of files. FileSwitchDirectoryExpert: A Directory instance that switches files between two other Directory instances. FilterDirectoryDirectory implementation that delegates calls to another directory. FlushInfoA FlushInfo provides information required for a FLUSH context. FSDirectoryBase class for Directory implementations that store index files in the file system. FSLockFactoryBase class for file system based locking implementation. IndexInputAbstract base class for input from a file in a
IndexOutputAbstract base class for output to a file in a Directory. InputStreamDataInputA
DataInputwrapping a plain
IOContextIOContext holds additional details on the merge/search context. LockAn interprocess mutex lock. Lock.WithUtility class for executing code with exclusive access. LockFactoryBase class for Locking implementation. LockStressTestSimple standalone tool that forever acquires & releases a lock using a specific LockFactory. LockVerifyServerSimple standalone server that must be running when you use
MergeInfoA MergeInfo provides information required for a MERGE context. MMapDirectoryFile-based
Directoryimplementation that uses mmap for reading, and
LockFactoryusing native OS file locks.
NativePosixUtilProvides JNI access to native methods such as madvise() for
Directoryimplementation for all Unixes that uses DIRECT I/O to bypass OS level IO caching during merging.
FSDirectoryimplementation that uses java.nio's FileChannel's positional read, which allows multiple threads to read from the same file without synchronizing.
LockFactoryto disable locking entirely.
RAMDirectoryaround any provided delegate directory, to be used during NRT search.
DataOutputwrapping a plain
RAMFileRepresents a file in RAM as a list of byte buffers. RAMInputStreamA memory-resident
Directorywrapper that allows
IndexOutputrate limiting using
RateLimiterAbstract base class to rate limit IO. RateLimiter.SimpleRateLimiterSimple class to rate limit IO. SimpleFSDirectoryA straightforward implementation of
LockFactoryfor a single in-process instance, meaning all locking will take place through this one instance.
TrackingDirectoryWrapperA delegating Directory that records which files were written to and deleted. VerifyingLockFactoryA
LockFactorythat wraps another
LockFactoryand verifies that each lock obtain/release is "correct" (never results in two processes holding the lock at the same time).
Directoryimplementation for Microsoft Windows.
Enum Summary Enum Description IOContext.ContextContext is a enumerator which specifies the context in which the Directory is being used for.
Exception Summary Exception Description AlreadyClosedExceptionThis exception is thrown when there is an attempt to access something that has already been closed. LockObtainFailedExceptionThis exception is thrown when the
write.lockcould not be acquired.
LockReleaseFailedExceptionThis exception is thrown when the
write.lockcould not be released.
NoSuchDirectoryExceptionThis exception is thrown when you try to list a non-existent directory.