You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by us...@apache.org on 2015/02/04 23:20:32 UTC
svn commit: r1657428 - in /lucene/dev/trunk/lucene:
core/src/java/org/apache/lucene/store/ misc/src/java/org/apache/lucene/store/
Author: uschindler
Date: Wed Feb 4 22:20:31 2015
New Revision: 1657428
URL: http://svn.apache.org/r1657428
Log:
Add missing documentation: In Lucene 5+, instantiating FSDirectory creates the directory in file system if it does not yet exist
Modified:
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/MMapDirectory.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/NIOFSDirectory.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/SimpleFSDirectory.java
lucene/dev/trunk/lucene/misc/src/java/org/apache/lucene/store/RAFDirectory.java
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java?rev=1657428&r1=1657427&r2=1657428&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/FSDirectory.java Wed Feb 4 22:20:31 2015
@@ -114,6 +114,7 @@ public abstract class FSDirectory extend
protected final Path directory; // The underlying filesystem directory
/** 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.
* @param path the path of the directory
* @param lockFactory the lock factory to use, or null for the default
* ({@link NativeFSLockFactory});
@@ -128,6 +129,7 @@ public abstract class FSDirectory extend
/** Creates an FSDirectory instance, trying to pick the
* 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>Currently this returns {@link MMapDirectory} for most Solaris
* and Windows 64-bit JREs, {@link NIOFSDirectory} for other
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/MMapDirectory.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/MMapDirectory.java?rev=1657428&r1=1657427&r2=1657428&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/MMapDirectory.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/MMapDirectory.java Wed Feb 4 22:20:31 2015
@@ -88,6 +88,7 @@ public class MMapDirectory extends FSDir
final int chunkSizePower;
/** Create a new MMapDirectory for the named location.
+ * The directory is created at the named location if it does not yet exist.
*
* @param path the path of the directory
* @param lockFactory the lock factory to use
@@ -98,6 +99,7 @@ public class MMapDirectory extends FSDir
}
/** Create a new MMapDirectory for the named location and {@link FSLockFactory#getDefault()}.
+ * The directory is created at the named location if it does not yet exist.
*
* @param path the path of the directory
* @throws IOException if there is a low-level I/O error
@@ -107,6 +109,7 @@ public class MMapDirectory extends FSDir
}
/** Create a new MMapDirectory for the named location and {@link FSLockFactory#getDefault()}.
+ * The directory is created at the named location if it does not yet exist.
*
* @param path the path of the directory
* @param maxChunkSize maximum chunk size (default is 1 GiBytes for
@@ -120,6 +123,7 @@ public class MMapDirectory extends FSDir
/**
* Create a new MMapDirectory for the named location, specifying the
* maximum chunk size used for memory mapping.
+ * The directory is created at the named location if it does not yet exist.
*
* @param path the path of the directory
* @param lockFactory the lock factory to use, or null for the default
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/NIOFSDirectory.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/NIOFSDirectory.java?rev=1657428&r1=1657427&r2=1657428&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/NIOFSDirectory.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/NIOFSDirectory.java Wed Feb 4 22:20:31 2015
@@ -54,6 +54,7 @@ import java.util.concurrent.Future; // j
public class NIOFSDirectory extends FSDirectory {
/** Create a new NIOFSDirectory for the named location.
+ * The directory is created at the named location if it does not yet exist.
*
* @param path the path of the directory
* @param lockFactory the lock factory to use
@@ -64,6 +65,7 @@ public class NIOFSDirectory extends FSDi
}
/** Create a new NIOFSDirectory for the named location and {@link FSLockFactory#getDefault()}.
+ * The directory is created at the named location if it does not yet exist.
*
* @param path the path of the directory
* @throws IOException if there is a low-level I/O error
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/SimpleFSDirectory.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/SimpleFSDirectory.java?rev=1657428&r1=1657427&r2=1657428&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/SimpleFSDirectory.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/SimpleFSDirectory.java Wed Feb 4 22:20:31 2015
@@ -35,6 +35,7 @@ import java.nio.file.StandardOpenOption;
public class SimpleFSDirectory extends FSDirectory {
/** Create a new SimpleFSDirectory for the named location.
+ * The directory is created at the named location if it does not yet exist.
*
* @param path the path of the directory
* @param lockFactory the lock factory to use
@@ -45,6 +46,7 @@ public class SimpleFSDirectory extends F
}
/** Create a new SimpleFSDirectory for the named location and {@link FSLockFactory#getDefault()}.
+ * The directory is created at the named location if it does not yet exist.
*
* @param path the path of the directory
* @throws IOException if there is a low-level I/O error
Modified: lucene/dev/trunk/lucene/misc/src/java/org/apache/lucene/store/RAFDirectory.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/misc/src/java/org/apache/lucene/store/RAFDirectory.java?rev=1657428&r1=1657427&r2=1657428&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/misc/src/java/org/apache/lucene/store/RAFDirectory.java (original)
+++ lucene/dev/trunk/lucene/misc/src/java/org/apache/lucene/store/RAFDirectory.java Wed Feb 4 22:20:31 2015
@@ -38,6 +38,7 @@ import java.nio.file.Path;
public class RAFDirectory extends FSDirectory {
/** Create a new RAFDirectory for the named location.
+ * The directory is created at the named location if it does not yet exist.
*
* @param path the path of the directory
* @param lockFactory the lock factory to use
@@ -49,6 +50,7 @@ public class RAFDirectory extends FSDire
}
/** Create a new SimpleFSDirectory for the named location and {@link FSLockFactory#getDefault()}.
+ * The directory is created at the named location if it does not yet exist.
*
* @param path the path of the directory
* @throws IOException if there is a low-level I/O error