Package 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.

Field Summary

Fields

Modifier and Type	Field	Description
protected File	lockDir	Directory for the lock files.

Fields inherited from class org.apache.lucene.store.LockFactory

lockPrefix

Constructor Summary

Constructors

Constructor	Description
FSLockFactory()

Method Summary

Modifier and Type	Method	Description
File	getLockDir()	Retrieve the lock directory.
protected final void	setLockDir(File lockDir)	Set the lock directory.
String	toString()

Methods inherited from class org.apache.lucene.store.LockFactory

clearLock, getLockPrefix, makeLock, setLockPrefix

Methods inherited from class java.lang.Object

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

Field Details

lockDir

protected File lockDir

Directory for the lock files.

Constructor Details

FSLockFactory

public FSLockFactory()

Method Details

setLockDir

protected final void setLockDir(File lockDir)

Set the lock directory. This method can be only called once to initialize the lock directory. It is used by FSDirectory to set the lock directory to itself. Subclasses can also use this method to set the directory in the constructor.

getLockDir

public File getLockDir()

Retrieve the lock directory.

toString

public String toString()

Overrides:

toString in class Object