[incubator-gobblin] branch master updated: [GOBBLIN-977] Update the misleading comments in BaseAbstractTask

[suvasude]

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

suvasude pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-gobblin.git


The following commit(s) were added to refs/heads/master by this push:
     new bc6c440  [GOBBLIN-977] Update the misleading comments in 
BaseAbstractTask
bc6c440 is described below

commit bc6c44072279631705dc1df20ae66a366f6ed42d
Author: Chen Guo <almight...@gmail.com>
AuthorDate: Mon Dec 2 16:38:54 2019 -0800

    [GOBBLIN-977] Update the misleading comments in BaseAbstractTask
    
    Closes #2824 from enjoyear/GOBBLIN-977
---
 .../java/org/apache/gobblin/runtime/task/BaseAbstractTask.java   | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git 
a/gobblin-runtime/src/main/java/org/apache/gobblin/runtime/task/BaseAbstractTask.java
 
b/gobblin-runtime/src/main/java/org/apache/gobblin/runtime/task/BaseAbstractTask.java
index 71e2b39..4224e5d 100644
--- 
a/gobblin-runtime/src/main/java/org/apache/gobblin/runtime/task/BaseAbstractTask.java
+++ 
b/gobblin-runtime/src/main/java/org/apache/gobblin/runtime/task/BaseAbstractTask.java
@@ -37,7 +37,8 @@ public abstract class BaseAbstractTask implements TaskIFace {
   }
 
   /**
-   * Overriding methods should call super at the end.
+   * Overriding methods should implement the logic of this task
+   * and update the {@link BaseAbstractTask#workingState} accordingly
    */
   @Override
   public void run() {
@@ -45,7 +46,8 @@ public abstract class BaseAbstractTask implements TaskIFace {
   }
 
   /**
-   * Overriding methods should call super at the end.
+   * The logic to run at committing phase.
+   * Overriding methods should update the {@link 
BaseAbstractTask#workingState} based on the execution state of the task
    */
   @Override
   public void commit() {
@@ -69,7 +71,8 @@ public abstract class BaseAbstractTask implements TaskIFace {
 
   @Override
   public void shutdown() {
-    if (getWorkingState() == WorkUnitState.WorkingState.PENDING || 
getWorkingState() == WorkUnitState.WorkingState.RUNNING) {
+    if (getWorkingState() == WorkUnitState.WorkingState.PENDING
+        || getWorkingState() == WorkUnitState.WorkingState.RUNNING) {
       this.workingState = WorkUnitState.WorkingState.CANCELLED;
     }
   }