Author: catholicon
Date: Sun Aug 18 20:48:54 2019
New Revision: 1865406
URL: http://svn.apache.org/viewvc?rev=1865406&view=rev
Log:
OAK-8543: Javadoc of IndexCopier#waitForCopyCompletion refers to boolean return
Modified:
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexCopier.java
Modified:
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexCopier.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexCopier.java?rev=1865406&r1=1865405&r2=1865406&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexCopier.java
(original)
+++
jackrabbit/oak/trunk/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexCopier.java
Sun Aug 18 20:48:54 2019
@@ -361,8 +361,8 @@ public class IndexCopier implements Copy
/**
* Waits for maximum of {@code timeoutMillis} while checking if {@code
file} isn't being copied already.
- * The method can return before {@code timeoutMillis} if it got
interrupted. So, if the method reports false,
- * caller should apply its own logic to see if a wait should be repeated
or not.
+ * The method can return before {@code timeoutMillis} if it got
interrupted. So, if required then the
+ * caller should check using {@code isCopyInProgress} and wait again.
* @param file
* @param timeoutMillis
*/
