org.apache.lucene.store

Class FSLockFactory

java.lang.Object

org.apache.lucene.store.LockFactory

org.apache.lucene.store.FSLockFactory

Direct Known Subclasses:

NativeFSLockFactory, SimpleFSLockFactory

public abstract class FSLockFactory
extends LockFactory

Base class for file system based locking implementation. This class is explicitly checking that the passed Directory is an FSDirectory.

Constructor Summary

Constructors

Constructor and Description
FSLockFactory()

Method Summary

Methods

Modifier and Type	Method and Description
static FSLockFactory	getDefault() Returns the default locking implementation for this platform.
protected abstract Lock	makeFSLock(FSDirectory dir, String lockName) Implement this method to create a lock for a FSDirectory instance.
Lock	makeLock(Directory dir, String lockName) Return a new Lock instance identified by lockName.

Methods inherited from class java.lang.Object

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

Constructor Detail

FSLockFactory

public FSLockFactory()

Method Detail

getDefault

public static final FSLockFactory getDefault()

Returns the default locking implementation for this platform. This method currently returns always NativeFSLockFactory.

makeLock

public final Lock makeLock(Directory dir,
            String lockName)

Description copied from class: LockFactory

Return a new Lock instance identified by lockName.

Specified by:

makeLock in class LockFactory

lockName - name of the lock to be created.

makeFSLock

protected abstract Lock makeFSLock(FSDirectory dir,
              String lockName)

Implement this method to create a lock for a FSDirectory instance.