[incubator-iotdb] branch fix_add_future_4_flush_opeartion updated: add comment

[hx...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

hxd pushed a commit to branch fix_add_future_4_flush_opeartion
in repository https://gitbox.apache.org/repos/asf/incubator-iotdb.git


The following commit(s) were added to refs/heads/fix_add_future_4_flush_opeartion by this push:
     new 179b54f  add comment
179b54f is described below

commit 179b54f9b9b5ce0381544498a0778c71f36a88e5
Author: xiangdong huang <sa...@gmail.com>
AuthorDate: Tue Feb 19 20:23:29 2019 +0800

    add comment
---
 .../org/apache/iotdb/db/engine/filenode/FileNodeFlushFuture.java  | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/iotdb/src/main/java/org/apache/iotdb/db/engine/filenode/FileNodeFlushFuture.java b/iotdb/src/main/java/org/apache/iotdb/db/engine/filenode/FileNodeFlushFuture.java
index 7ed7b0c..b1b40f8 100644
--- a/iotdb/src/main/java/org/apache/iotdb/db/engine/filenode/FileNodeFlushFuture.java
+++ b/iotdb/src/main/java/org/apache/iotdb/db/engine/filenode/FileNodeFlushFuture.java
@@ -45,6 +45,14 @@ public class FileNodeFlushFuture implements Future<Boolean> {
     }
   }
 
+  /**
+   * @param mayInterruptIfRunning true if the thread executing this task should be interrupted;
+   * otherwise, in-progress tasks are allowed to complete
+   * @return true if both of the two sub-future are canceled successfully.
+   * @see Future#cancel(boolean) The difference is that this Future consists of two sub-Futures. If
+   * the first sub-future is canceled successfully but the second sub-future fails, the result is
+   * false.
+   */
   @Override
   public boolean cancel(boolean mayInterruptIfRunning) {
     boolean result = bufferWriteFlushFuture.cancel(mayInterruptIfRunning);