Binary i/o API, used for all index data.
Interface Summary Interface Description RandomAccessInputRandom Access Index API.
Class Summary Class Description BaseDirectoryBase implementation for a concrete
Directorythat uses a
Checksumwith an internal buffer to speed up checksum calculations.
BufferedChecksumIndexInputSimple implementation of
ChecksumIndexInputthat wraps another input and delegates calls.
BufferedIndexInputBase implementation class for buffered
ByteArrayDataInputDataInput backed by a byte array. ByteArrayDataOutputDataOutput backed by a byte array. ByteBufferIndexInputBase IndexInput implementation that uses an array of ByteBuffers to represent a file. ByteBuffersDataInputA
RandomAccessInputand reading data from a list of
DataOutputstoring data in a list of
ByteBuffersDataOutput.ByteBufferRecyclerAn implementation of a
ByteBufferallocation and recycling policy.
Directoryimplementation that can be used to store index files on the heap.
RandomAccessInputand backed by a
IndexOutputwriting to a
ChecksumIndexInputExtension of IndexInput, computing checksum as it goes. 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
Directoryprovides an abstraction layer for storing a 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
DataOutputfor appending data to a file in a
DataInputwrapping a plain
IOContextIOContext holds additional details on the merge/search context. LockAn interprocess mutex lock. LockFactoryBase class for Locking implementation. LockStressTestSimple standalone tool that forever acquires and releases a lock using a specific
LockValidatingDirectoryWrapperThis class makes a best-effort check that a provided
Lockis valid before any destructive filesystem operation.
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.
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.
NRTCachingDirectoryWraps a RAM-resident directory around any provided delegate directory, to be used during NRT search. OutputStreamDataOutputA
DataOutputwrapping a plain
OutputStreamIndexOutputImplementation class for buffered
IndexOutputthat writes to an
RateLimitedIndexOutput RateLimiterAbstract base class to rate limit IO. RateLimiter.SimpleRateLimiterSimple class to rate limit IO. SimpleFSLockFactory SingleInstanceLockFactoryImplements
LockFactoryfor a single in-process instance, meaning all locking will take place through this one instance.
SleepingLockWrapperDirectory that wraps another, and that sleeps and retries if obtaining the lock fails. 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).
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.