public class

SingleInstanceLockFactory

extends LockFactory
java.lang.Object
   ↳ org.apache.lucene.store.LockFactory
     ↳ org.apache.lucene.store.SingleInstanceLockFactory

Class Overview

Implements LockFactory for a single in-process instance, meaning all locking will take place through this one instance. Only use this LockFactory when you are certain all IndexReaders and IndexWriters for a given index are running against a single shared in-process Directory instance. This is currently the default locking for RAMDirectory.

See Also

Summary

[Expand]
Inherited Fields
From class org.apache.lucene.store.LockFactory
Public Constructors
SingleInstanceLockFactory()
Public Methods
void clearLock(String lockName)
Attempt to clear (forcefully unlock and remove) the specified lock.
Lock makeLock(String lockName)
Return a new Lock instance identified by lockName.
[Expand]
Inherited Methods
From class org.apache.lucene.store.LockFactory
From class java.lang.Object

Public Constructors

public SingleInstanceLockFactory ()

Public Methods

public void clearLock (String lockName)

Attempt to clear (forcefully unlock and remove) the specified lock. Only call this at a time when you are certain this lock is no longer in use.

Parameters
lockName name of the lock to be cleared.
Throws
IOException

public Lock makeLock (String lockName)

Return a new Lock instance identified by lockName.

Parameters
lockName name of the lock to be created.