org.apache.lucene.store

Class SingleInstanceLockFactory

java.lang.Object

org.apache.lucene.store.LockFactory

org.apache.lucene.store.SingleInstanceLockFactory

public final class SingleInstanceLockFactory
extends LockFactory

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 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:

LockFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	SingleInstanceLockFactory.SingleInstanceLock

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.HashSet<java.lang.String>	locks

Constructor Summary

Constructors

Constructor and Description
SingleInstanceLockFactory()

Method Summary

Modifier and Type	Method and Description
Lock	obtainLock(Directory dir, java.lang.String lockName) Return a new obtained Lock instance identified by lockName.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

locks

final java.util.HashSet<java.lang.String> locks

Constructor Detail

SingleInstanceLockFactory

public SingleInstanceLockFactory()

Method Detail

obtainLock

public Lock obtainLock(Directory dir,
                       java.lang.String lockName)
                throws java.io.IOException

Description copied from class: LockFactory

Return a new obtained Lock instance identified by lockName.

Specified by:

obtainLock in class LockFactory

lockName - name of the lock to be created.

Throws:

LockObtainFailedException - (optional specific exception) if the lock could not be obtained because it is currently held elsewhere.

java.io.IOException - if any i/o error occurs attempting to gain the lock