org.apache.lucene.store

Class BaseDirectory

java.lang.Object

org.apache.lucene.store.Directory

org.apache.lucene.store.BaseDirectory

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

FSDirectory, RAMDirectory

public abstract class BaseDirectory
extends Directory

Base implementation for a concrete Directory that uses a LockFactory for locking.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isOpen
protected LockFactory	lockFactory Holds the LockFactory instance (implements locking for this Directory instance).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseDirectory(LockFactory lockFactory) Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	ensureOpen()
Lock	makeLock(String name) Construct a Lock.
String	toString()

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

close, copyFrom, createOutput, deleteFile, fileLength, listAll, openChecksumInput, openInput, renameFile, sync

Methods inherited from class java.lang.Object

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

Field Detail

isOpen

protected volatile boolean isOpen

lockFactory

protected final LockFactory lockFactory

Holds the LockFactory instance (implements locking for this Directory instance).

Constructor Detail

BaseDirectory

protected BaseDirectory(LockFactory lockFactory)

Sole constructor.

Method Detail

makeLock

public final Lock makeLock(String name)

Description copied from class: Directory

Construct a Lock.

Specified by:

makeLock in class Directory

Parameters:

name - the name of the lock file

ensureOpen

protected final void ensureOpen()
                         throws AlreadyClosedException

Overrides:

ensureOpen in class Directory

Throws:

AlreadyClosedException - if this Directory is closed

toString

public String toString()

Overrides:

toString in class Directory