add comments

temporalio · Oct 22, 2024 · c0cfc6e · c0cfc6e
1 parent f14f563
commit c0cfc6e
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/temporal-sdk/src/main/java/io/temporal/client/UpdateWithStartWorkflowOperation.java b/temporal-sdk/src/main/java/io/temporal/client/UpdateWithStartWorkflowOperation.java
@@ -22,6 +22,8 @@
 
 import io.temporal.common.Experimental;
 import io.temporal.workflow.Functions;
+
+import javax.annotation.Nullable;
 import java.lang.reflect.Type;
 import java.util.Arrays;
 import java.util.concurrent.*;
@@ -276,8 +278,10 @@ public static <R> Builder<R> newBuilder(String updateName, Class<R> resultClass,
 
   private UpdateOptions<R> options;
 
+  // set by constructor (untyped) or `prepareUpdate` (typed)
   private Object[] updateArgs;
 
+  // set by `prepareStart`
   private Object[] workflowArgs;
 
   private final CompletableFuture<WorkflowUpdateHandle<R>> handle;
@@ -296,8 +300,12 @@ WorkflowUpdateHandle<R> invoke(Functions.Proc workflow) {
     WorkflowInvocationHandler.initAsyncInvocation(
         WorkflowInvocationHandler.InvocationType.UPDATE_WITH_START, this);
     try {
+      // invokes `prepareUpdate` via WorkflowInvocationHandler.UpdateWithStartInvocationHandler
       request.apply();
+
+      // invokes `prepareStart` via WorkflowInvocationHandler.UpdateWithStartInvocationHandler
       workflow.apply();
+
       stub.updateWithStart(this, this.workflowArgs);
       return this.handle.get();
     } catch (InterruptedException e) {
@@ -313,6 +321,9 @@ WorkflowUpdateHandle<R> invoke(Functions.Proc workflow) {
     }
   }
 
+  /**
+   * Invoked by {@link WorkflowInvocationHandler.UpdateWithStartInvocationHandler}.
+   */
   void prepareUpdate(
       WorkflowStub stub, String updateName, Class resultClass, Type resultType, Object[] args) {
     setStub(stub);
@@ -325,6 +336,9 @@ void prepareUpdate(
             .build();
   }
 
+  /**
+   * Invoked by {@link WorkflowInvocationHandler.UpdateWithStartInvocationHandler}.
+   */
   void prepareStart(WorkflowStub stub, Object[] args) {
     setStub(stub);
     this.workflowArgs = args;