svn commit: r926948 - /lucene/dev/trunk/lucene/src/java/org/apache/lucene/store/Directory.java

[mi...@apache.org]

Author: mikemccand
Date: Wed Mar 24 06:25:13 2010
New Revision: 926948

URL: http://svn.apache.org/viewvc?rev=926948&view=rev
Log:
LUCENE-2328: add jdoc details for deprecation of Directory.sync(String)

Modified:
    lucene/dev/trunk/lucene/src/java/org/apache/lucene/store/Directory.java

Modified: lucene/dev/trunk/lucene/src/java/org/apache/lucene/store/Directory.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/src/java/org/apache/lucene/store/Directory.java?rev=926948&r1=926947&r2=926948&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/src/java/org/apache/lucene/store/Directory.java (original)
+++ lucene/dev/trunk/lucene/src/java/org/apache/lucene/store/Directory.java Wed Mar 24 06:25:13 2010
@@ -85,6 +85,9 @@ public abstract class Directory implemen
    * stable storage.  Lucene uses this to properly commit
    * changes to the index, to prevent a machine/OS crash
    * from corrupting the index.
+   * @deprecated use {@link #sync(Collection)} instead.
+   * For easy migration you can change your code to call
+   * sync(Collections.singleton(name))
    */
   @Deprecated
   public void sync(String name) throws IOException { // TODO 4.0 kill me