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

LUCENE-758: fix javadocs to clarify that RAMDirectory(Directory) makes a full copy of the original Directory 

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@491574 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael McCandless 2007-01-01 14:06:26 +00:00
parent 9814a94714
commit 411575b600
2 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGES.txt
View File

@ -382,6 +382,9 @@ Documentation
9. Added some text about what is contained in releases. (Eric Haszlakiewicz via Grant Ingersoll) 9. Added some text about what is contained in releases. (Eric Haszlakiewicz via Grant Ingersoll)
10. LUCENE-758: Fix javadoc to clarify that RAMDirectory(Directory)
makes a full copy of the starting Directory. (Mike McCandless)
Build Build
1. Added in clover test code coverage per http://issues.apache.org/jira/browse/LUCENE-721 To enable clover code coverage, you must have clover.jar in the ANT classpath and specify -Drun.clover=true on the command line.(Michael Busch and Grant Ingersoll) 1. Added in clover test code coverage per http://issues.apache.org/jira/browse/LUCENE-721 To enable clover code coverage, you must have clover.jar in the ANT classpath and specify -Drun.clover=true on the command line.(Michael Busch and Grant Ingersoll)

10
src/java/org/apache/lucene/store/RAMDirectory.java
View File

@ -58,6 +58,12 @@ public class RAMDirectory extends Directory implements Serializable {
* a disk-based index into memory. * a disk-based index into memory.
* <P> * <P>
* This should be used only with indices that can fit into memory. * This should be used only with indices that can fit into memory.
* <P>
* Note that the resulting <code>RAMDirectory</code> instance is fully
* independent from the original <code>Directory</code> (it is a
* complete copy). Any subsequent changes to the
* original <code>Directory</code> will not be visible in the
* <code>RAMDirectory</code> instance.
* *
* @param dir a <code>Directory</code> value * @param dir a <code>Directory</code> value
* @exception IOException if an error occurs * @exception IOException if an error occurs
@ -97,6 +103,8 @@ public class RAMDirectory extends Directory implements Serializable {
* Creates a new <code>RAMDirectory</code> instance from the {@link FSDirectory}. * Creates a new <code>RAMDirectory</code> instance from the {@link FSDirectory}.
* *
* @param dir a <code>File</code> specifying the index directory * @param dir a <code>File</code> specifying the index directory
*
* @see #RAMDirectory(Directory)
*/ */
public RAMDirectory(File dir) throws IOException { public RAMDirectory(File dir) throws IOException {
this(FSDirectory.getDirectory(dir, false), true); this(FSDirectory.getDirectory(dir, false), true);
@ -106,6 +114,8 @@ public class RAMDirectory extends Directory implements Serializable {
* Creates a new <code>RAMDirectory</code> instance from the {@link FSDirectory}. * Creates a new <code>RAMDirectory</code> instance from the {@link FSDirectory}.
* *
* @param dir a <code>String</code> specifying the full index directory path * @param dir a <code>String</code> specifying the full index directory path
*
* @see #RAMDirectory(Directory)
*/ */
public RAMDirectory(String dir) throws IOException { public RAMDirectory(String dir) throws IOException {
this(FSDirectory.getDirectory(dir, false), true); this(FSDirectory.getDirectory(dir, false), true);