Package org.apache.lucene.store

Binary i/o API, used for all index data.

See: Description

Interface Summary

Interface	Description
RandomAccessInput	Random Access Index API.

Class Summary

Class	Description
BaseDirectory	Base implementation for a concrete Directory that uses a LockFactory for locking.
BaseDirectoryTestCase	Base class for per-Directory tests.
BaseDirectoryWrapper	Calls check index on close.
BaseLockFactoryTestCase	Base class for per-LockFactory tests.
BufferedChecksum	Wraps another Checksum with an internal buffer to speed up checksum calculations.
BufferedChecksumIndexInput	Simple implementation of ChecksumIndexInput that wraps another input and delegates calls.
BufferedIndexInput	Base implementation class for buffered IndexInput.
ByteArrayDataInput	DataInput backed by a byte array.
ByteArrayDataOutput	DataOutput backed by a byte array.
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 is a flat list of files.
FileSwitchDirectory	Expert: A Directory instance that switches files between two other Directory instances.
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	Abstract base class for output to a file in a Directory.
InputStreamDataInput	A DataInput wrapping a plain InputStream.
IOContext	IOContext holds additional details on the merge/search context.
Lock	An interprocess mutex lock.
LockFactory	Base class for Locking implementation.
LockStressTest	Simple standalone tool that forever acquires and releases a lock using a specific LockFactory.
LockValidatingDirectoryWrapper	This class makes a best-effort check that a provided Lock is valid before any destructive filesystem operation.
LockVerifyServer	Simple standalone server that must be running when you use VerifyingLockFactory.
MergeInfo	A MergeInfo provides information required for a MERGE context.
MMapDirectory	File-based Directory implementation that uses mmap for reading, and FSDirectory.FSIndexOutput for writing.
MockDirectoryWrapper	This is a Directory Wrapper that adds methods intended to be used only by unit tests.
MockDirectoryWrapper.Failure	Objects that represent fail-able conditions.
MockIndexInputWrapper	Used by MockDirectoryWrapper to create an input stream that keeps track of when it's been closed.
MockIndexOutputWrapper	Used by MockRAMDirectory to create an output stream that will throw an IOException on fake disk full, track max disk space actually used, and maybe throw random IOExceptions.
NativeFSLockFactory	Implements LockFactory using native OS file locks.
NativePosixUtil	Provides JNI access to native methods such as madvise() for NativeUnixDirectory
NativeUnixDirectory	A Directory implementation for all Unixes that uses DIRECT I/O to bypass OS level IO caching during merging.
NIOFSDirectory	An FSDirectory implementation that uses java.nio's FileChannel's positional read, which allows multiple threads to read from the same file without synchronizing.
NoLockFactory	Use this LockFactory to disable locking entirely.
NRTCachingDirectory	Wraps a RAMDirectory around any provided delegate directory, to be used during NRT search.
OutputStreamDataOutput	A DataOutput wrapping a plain OutputStream.
OutputStreamIndexOutput	Implementation class for buffered IndexOutput that writes to an OutputStream.
RAFDirectory	A straightforward implementation of FSDirectory using java.io.RandomAccessFile.
RAMDirectory	A memory-resident Directory implementation.
RAMFile	Represents a file in RAM as a list of byte[] buffers.
RAMInputStream	A memory-resident IndexInput implementation.
RAMOutputStream	A memory-resident IndexOutput implementation.
RateLimitedIndexOutput	A rate limiting IndexOutput
RateLimiter	Abstract base class to rate limit IO.
RateLimiter.SimpleRateLimiter	Simple class to rate limit IO.
RawDirectoryWrapper	Delegates all operations, even optional ones, to the wrapped directory.
SimpleFSDirectory	A straightforward implementation of FSDirectory using Files.newByteChannel(Path, java.nio.file.OpenOption...).
SimpleFSLockFactory	Implements LockFactory using Files.createFile(java.nio.file.Path, java.nio.file.attribute.FileAttribute<?>...).
SingleInstanceLockFactory	Implements LockFactory for a single in-process instance, meaning all locking will take place through this one instance.
SleepingLockWrapper	Directory that wraps another, and that sleeps and retries if obtaining the lock fails.
TrackingDirectoryWrapper	A delegating Directory that records which files were written to and deleted.
VerifyingLockFactory	A LockFactory that wraps another LockFactory and verifies that each lock obtain/release is "correct" (never results in two processes holding the lock at the same time).
WindowsDirectory	Native Directory implementation for Microsoft Windows.

Enum Summary

Enum	Description
IOContext.Context	Context is a enumerator which specifies the context in which the Directory is being used for.
MockDirectoryWrapper.Throttling	Enum for controlling hard disk throttling.

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 the write.lock could not be acquired.
LockReleaseFailedException	This exception is thrown when the write.lock could not be released.
MockDirectoryWrapper.FakeIOException	Use this when throwing fake IOException, e.g.

Package org.apache.lucene.store Description

Binary i/o API, used for all index data.