public abstract class Directory extends Object
Java's i/o APIs not used directly, but rather all i/o is through this API. This permits things such as:
LockFactory
, and can be changed for each Directory
instance using setLockFactory(org.apache.lucene.store.LockFactory)
.Modifier and Type | Field and Description |
---|---|
protected boolean |
isOpen |
protected LockFactory |
lockFactory
Holds the LockFactory instance (implements locking for
this Directory instance).
|
Constructor and Description |
---|
Directory() |
Modifier and Type | Method and Description |
---|---|
void |
clearLock(String name)
Attempt to clear (forcefully unlock and remove) the
specified lock.
|
abstract void |
close()
Closes the store.
|
static void |
copy(Directory src,
Directory dest,
boolean closeDirSrc)
Copy contents of a directory src to a directory dest.
|
abstract IndexOutput |
createOutput(String name)
Creates a new, empty file in the directory with the given name.
|
abstract void |
deleteFile(String name)
Removes an existing file in the directory.
|
protected void |
ensureOpen() |
abstract boolean |
fileExists(String name)
Returns true iff a file with the given name exists.
|
abstract long |
fileLength(String name)
Returns the length of a file in the directory.
|
abstract long |
fileModified(String name)
Returns the time the named file was last modified.
|
LockFactory |
getLockFactory()
Get the LockFactory that this Directory instance is
using for its locking implementation.
|
String |
getLockID()
Return a string identifier that uniquely differentiates
this Directory instance from other Directory instances.
|
abstract String[] |
list()
Deprecated.
For some Directory implementations (
FSDirectory , and its subclasses), this method
silently filters its results to include only index
files. Please use listAll() instead, which
does no filtering. |
String[] |
listAll()
Returns an array of strings, one for each file in the
directory.
|
Lock |
makeLock(String name)
Construct a
Lock . |
abstract IndexInput |
openInput(String name)
Returns a stream reading an existing file.
|
IndexInput |
openInput(String name,
int bufferSize)
Returns a stream reading an existing file, with the
specified read buffer size.
|
abstract void |
renameFile(String from,
String to)
Deprecated.
|
void |
setLockFactory(LockFactory lockFactory)
Set the LockFactory that this Directory instance should
use for its locking implementation.
|
void |
sync(String name)
Ensure that any writes to this file are moved to
stable storage.
|
String |
toString() |
abstract void |
touchFile(String name)
Set the modified time of an existing file to now.
|
protected volatile boolean isOpen
protected LockFactory lockFactory
public abstract String[] list() throws IOException
FSDirectory
, and its subclasses), this method
silently filters its results to include only index
files. Please use listAll()
instead, which
does no filtering.IOException
public String[] listAll() throws IOException
list()
this method does no
filtering of the contents in a directory, and it will
never return null (throws IOException instead).
Currently this method simply falls back to list()
for Directory impls outside of Lucene's core &
contrib, but in 3.0 that method will be removed and
this method will become abstract.IOException
public abstract boolean fileExists(String name) throws IOException
IOException
public abstract long fileModified(String name) throws IOException
IOException
public abstract void touchFile(String name) throws IOException
IOException
public abstract void deleteFile(String name) throws IOException
IOException
public abstract void renameFile(String from, String to) throws IOException
IOException
public abstract long fileLength(String name) throws IOException
IOException
public abstract IndexOutput createOutput(String name) throws IOException
IOException
public void sync(String name) throws IOException
IOException
public abstract IndexInput openInput(String name) throws IOException
IOException
public IndexInput openInput(String name, int bufferSize) throws IOException
FSDirectory
and CompoundFileReader
.IOException
public Lock makeLock(String name)
Lock
.name
- the name of the lock filepublic void clearLock(String name) throws IOException
name
- name of the lock to be cleared.IOException
public abstract void close() throws IOException
IOException
public void setLockFactory(LockFactory lockFactory)
lockFactory
- instance of LockFactory
.public LockFactory getLockFactory()
public String getLockID()
public static void copy(Directory src, Directory dest, boolean closeDirSrc) throws IOException
NOTE: the source directory cannot change while this method is running. Otherwise the results are undefined and you could easily hit a FileNotFoundException.
NOTE: this method only copies files that look like index files (ie, have extensions matching the known extensions of index files).
src
- source directorydest
- destination directorycloseDirSrc
- if true
, call close()
method on source directoryIOException
protected final void ensureOpen() throws AlreadyClosedException
AlreadyClosedException
- if this Directory is closedCopyright © 2000-2012 Apache Software Foundation. All Rights Reserved.