Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

LUCENE-6770: Add javadocs that FSDirectory canonicalizes the path 

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1702619 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Uwe Schindler 2015-09-12 11:43:20 +00:00
parent d7f184b3b0
commit 15a3efcd90
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lucene/core/src/java/org/apache/lucene/store/FSDirectory.java
View File

@ -117,6 +117,12 @@ public abstract class FSDirectory extends BaseDirectory {
/** Create a new FSDirectory for the named location (ctor for subclasses).
* The directory is created at the named location if it does not yet exist.
*
* <p>{@code FSDirectory} resolves the given Path to a canonical /
* real path to ensure it can correctly lock the index directory and no other process
* can interfere with changing possible symlinks to the index directory inbetween.
* If you want to use symlinks and change them dynamically, close all
* {@code IndexWriters} and create a new {@code FSDirecory} instance.
* @param path the path of the directory
* @param lockFactory the lock factory to use, or null for the default
* ({@link NativeFSLockFactory});
@ -135,6 +141,12 @@ public abstract class FSDirectory extends BaseDirectory {
* best implementation given the current environment.
* The directory returned uses the {@link NativeFSLockFactory}.
* The directory is created at the named location if it does not yet exist.
*
* <p>{@code FSDirectory} resolves the given Path when calling this method to a canonical /
* real path to ensure it can correctly lock the index directory and no other process
* can interfere with changing possible symlinks to the index directory inbetween.
* If you want to use symlinks and change them dynamically, close all
* {@code IndexWriters} and create a new {@code FSDirecory} instance.
*
* <p>Currently this returns {@link MMapDirectory} for Linux, MacOSX, Solaris,
* and Windows 64-bit JREs, {@link NIOFSDirectory} for other