## Uses of Class
org.apache.lucene.store.LockFactory

- Packages that use LockFactory
  Package | Description
  --- | ---
  org.apache.lucene.store | Binary i/o API, used for all index data.

- - ### Uses of LockFactory in org.apache.lucene.store

    Subclasses of LockFactory in org.apache.lucene.store
    Modifier and Type | Class and Description
    --- | ---
    `class` | `FSLockFactory` Base class for file system based locking implementation.
    `class` | `NativeFSLockFactory` Implements `LockFactory` using native OS file locks.
    `class` | `NoLockFactory` Use this `LockFactory` to disable locking entirely.
    `class` | `SimpleFSLockFactory` Implements `LockFactory` using `File.createNewFile()`.
    `class` | `SingleInstanceLockFactory` Implements `LockFactory` for a single in-process instance, meaning all locking will take place through this one instance.
    `class` | `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).

    Fields in org.apache.lucene.store declared as LockFactory
    Modifier and Type | Field and Description
    --- | ---
    `protected LockFactory` | Directory.`lockFactory` Holds the LockFactory instance (implements locking for this Directory instance).

    Methods in org.apache.lucene.store that return LockFactory
    Modifier and Type | Method and Description
    --- | ---
    `LockFactory` | TrackingDirectoryWrapper.`getLockFactory()`
    `LockFactory` | RateLimitedDirectoryWrapper.`getLockFactory()`
    `LockFactory` | NRTCachingDirectory.`getLockFactory()`
    `LockFactory` | Directory.`getLockFactory()` Get the LockFactory that this Directory instance is using for its locking implementation.

    Methods in org.apache.lucene.store with parameters of type LockFactory
    Modifier and Type | Method and Description
    --- | ---
    `static FSDirectory` | FSDirectory.`open(File path, LockFactory lockFactory)` Just like `FSDirectory.open(File)`, but allows you to also specify a custom `LockFactory`.
    `void` | TrackingDirectoryWrapper.`setLockFactory(LockFactory lockFactory)`
    `void` | RateLimitedDirectoryWrapper.`setLockFactory(LockFactory lockFactory)`
    `void` | NRTCachingDirectory.`setLockFactory(LockFactory lf)`
    `void` | FSDirectory.`setLockFactory(LockFactory lockFactory)`
    `void` | Directory.`setLockFactory(LockFactory lockFactory)` Set the LockFactory that this Directory instance should use for its locking implementation.

    Constructors in org.apache.lucene.store with parameters of type LockFactory
    Constructor and Description
    `FSDirectory(File path, LockFactory lockFactory)` Create a new FSDirectory for the named location (ctor for subclasses).
    `MMapDirectory(File path, LockFactory lockFactory)` Create a new MMapDirectory for the named location.
    `MMapDirectory(File path, LockFactory lockFactory, int maxChunkSize)` Create a new MMapDirectory for the named location, specifying the maximum chunk size used for memory mapping.
    `NIOFSDirectory(File path, LockFactory lockFactory)` Create a new NIOFSDirectory for the named location.
    `SimpleFSDirectory(File path, LockFactory lockFactory)` Create a new SimpleFSDirectory for the named location.
    `VerifyingLockFactory(byte id, LockFactory lf, String host, int port)`

Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.