ihuzenko commented on a change in pull request #1975: DRILL-7576: Fail fast for
operator errors
URL: https://github.com/apache/drill/pull/1975#discussion_r376908070
##########
File path:
exec/java-exec/src/main/java/org/apache/drill/exec/physical/impl/RootExec.java
##########
@@ -20,34 +20,38 @@
import org.apache.drill.exec.proto.ExecProtos.FragmentHandle;
/**
- * <h2>Functionality</h2>
- * <p>
- * A FragmentRoot is a node which is the last processing node in a query
plan. FragmentTerminals include Exchange
- * output nodes and storage nodes. They are there driving force behind the
completion of a query.
- * </p>
- * <h2>Assumptions</h2>
- * <p>
- * All implementations of {@link RootExec} assume that all their methods are
called by the same thread.
+ * Node which is the last processing node in a query plan. FragmentTerminals
+ * include Exchange output nodes and storage nodes. They are there driving
force
+ * behind the completion of a query.
* </p>
+ * Assumes that all implementations of {@link RootExec} assume that all their
+ * methods are called by the same thread.
*/
public interface RootExec extends AutoCloseable {
+
/**
* Do the next batch of work.
- * @return Whether or not additional batches of work are necessary. False
means that this fragment is done.
+ *
+ * @return Whether or not additional batches of work are necessary. False
+ * means that this fragment is done.
*/
boolean next();
/**
- * Inform sender that receiving fragment is finished and doesn't need any
more data. This can be called multiple
- * times (once for each downstream receiver). If all receivers are finished
then a subsequent call to {@link #next()}
- * will return false.
- * @param handle The handle pointing to the downstream receiver that does
not need anymore data.
+ * Inform sender that receiving fragment is finished and doesn't need any
more
+ * data. This can be called multiple times (once for each downstream
+ * receiver). If all receivers are finished then a subsequent call to
+ * {@link #next()} will return false.
+ *
+ * @param handle
+ * The handle pointing to the downstream receiver that does not need
+ * anymore data.
*/
void receivingFragmentFinished(FragmentHandle handle);
/**
- * Dump failed batches' state preceded by its parent's state to logs.
Invoked when there is a
- * failure during fragment execution.
+ * Dump failed batches' state preceded by its parent's state to logs. Invoked
+ * when there is a failure during fragment execution.
Review comment:
Please add ```@param``` section to the JavaDoc describing where the trowable
came from.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
