org.apache.lucene.store
public final class FSDirectory extends Directory
If the system property 'disableLuceneLocks' has the String value of "true", lock creation will be disabled.
See Also: Directory
Field Summary | |
---|---|
static String | LOCK_DIR
Directory specified by org.apache.lucene.lockdir
or java.io.tmpdir system property |
Method Summary | |
---|---|
void | close() Closes the store to future operations. |
OutputStream | createFile(String name) Creates a new, empty file in the directory with the given name.
|
void | deleteFile(String name) Removes an existing file in the directory. |
boolean | fileExists(String name) Returns true iff a file with the given name exists. |
long | fileLength(String name) Returns the length in bytes of a file in the directory. |
long | fileModified(String name) Returns the time the named file was last modified. |
static long | fileModified(File directory, String name) Returns the time the named file was last modified. |
static FSDirectory | getDirectory(String path, boolean create) Returns the directory instance for the named location.
|
static FSDirectory | getDirectory(File file, boolean create) Returns the directory instance for the named location.
|
File | getFile() |
String[] | list() Returns an array of strings, one for each file in the directory. |
Lock | makeLock(String name) Constructs a {@link Lock} with the specified name. |
InputStream | openFile(String name) Returns a stream reading an existing file. |
void | renameFile(String from, String to) Renames an existing file in the directory. |
String | toString() For debug output. |
void | touchFile(String name) Set the modified time of an existing file to now. |
org.apache.lucene.lockdir
or java.io.tmpdir
system propertyDirectories are cached, so that, for a given canonical path, the same FSDirectory instance will always be returned. This permits synchronization on directories.
Parameters: path the path to the directory. create if true, create, or erase any existing contents.
Returns: the FSDirectory for the named file.
Directories are cached, so that, for a given canonical path, the same FSDirectory instance will always be returned. This permits synchronization on directories.
Parameters: file the path to the directory. create if true, create, or erase any existing contents.
Returns: the FSDirectory for the named file.
In JDK 1.1 or if system property disableLuceneLocks is the string "true", locks are disabled. Assigning this property any other string will not prevent creation of lock files. This is useful for using Lucene on read-only medium, such as CD-ROM.
Parameters: name the name of the lock file
Returns: an instance of Lock
holding the lock