code refactoring

Author: alexcheng1982

core/src/main/java/com/javaaidev/agenticpatterns/core/AgenticWorkflow.java

@@ -3,14 +3,38 @@
 import io.micrometer.observation.ObservationRegistry;
 import org.jspecify.annotations.Nullable;
 
+/**
+ * Agentic workflow
+ *
+ * @param <Request>  Type of request
+ * @param <Response> Type of response
+ */
 public interface AgenticWorkflow<Request, Response> {
 
+  /**
+   * Execute this workflow
+   *
+   * @param request Request
+   * @return Response
+   */
   Response execute(@Nullable Request request);
 
+  /**
+   * Name of this workflow
+   *
+   * @return name
+   */
   default String getName() {
     return this.getClass().getSimpleName();
   }
 
+  /**
+   * Builder to create {@linkplain AgenticWorkflow}
+   *
+   * @param <Request>  Type of request
+   * @param <Response> Type of response
+   * @param <T>        Type of {@linkplain AgenticWorkflow}
+   */
   interface Builder<Request, Response, T extends AgenticWorkflow.Builder<Request, Response, T>> {
 
     T name(String name);

core/src/main/java/com/javaaidev/agenticpatterns/core/CustomWorkflowBuilder.java

@@ -5,11 +5,23 @@
 import org.jspecify.annotations.Nullable;
 import org.springframework.util.Assert;
 
+/**
+ * Build a custom {@linkplain AgenticWorkflow}
+ *
+ * @param <Request>  Type of request
+ * @param <Response> Type of response
+ */
 public class CustomWorkflowBuilder<Request, Response> extends
     AbstractAgenticWorkflowBuilder<Request, Response, CustomWorkflowBuilder<Request, Response>> {
 
   protected Function<Request, Response> action;
 
+  /**
+   * Set the action of this workflow
+   *
+   * @param action Action to run
+   * @return Current builder
+   */
   public CustomWorkflowBuilder<Request, Response> action(Function<Request, Response> action) {
     this.action = Objects.requireNonNull(action, "Action cannot be null");
     return this;

patterns/chain-workflow/src/main/java/com/javaaidev/agenticpatterns/chainworkflow/ChainStep.java

@@ -3,6 +3,12 @@
 import java.util.Map;
 import org.springframework.core.Ordered;
 
+/**
+ * A step in the chain
+ *
+ * @param <Request>
+ * @param <Response>
+ */
 public interface ChainStep<Request, Response> extends Ordered {
 
   /**

patterns/chain-workflow/src/main/java/com/javaaidev/agenticpatterns/chainworkflow/ChainStepAgent.java

@@ -14,7 +14,7 @@
 import org.springframework.util.Assert;
 
 /**
- * A step in the chain
+ * A step in the chain implemented as a {@linkplain TaskExecutionAgent}
  *
  * @param <Request>  Task input type
  * @param <Response> Task output type

patterns/chain-workflow/src/main/java/com/javaaidev/agenticpatterns/chainworkflow/ChainWorkflow.java

@@ -5,9 +5,15 @@
 import io.micrometer.observation.ObservationRegistry;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Objects;
 import org.jspecify.annotations.Nullable;
-import org.springframework.util.Assert;
 
+/**
+ * A chain workflow
+ *
+ * @param <Request>
+ * @param <Response>
+ */
 public class ChainWorkflow<Request, Response> extends AbstractAgenticWorkflow<Request, Response> {
 
   private final List<ChainStep<Request, Response>> steps;
@@ -35,15 +41,13 @@ public static final class Builder<Request, Response> extends
     private final List<ChainStep<Request, Response>> steps = new ArrayList<>();
 
     public Builder<Request, Response> addStep(ChainStep<Request, Response> step) {
-      Assert.notNull(step, "Chain step cannot be null");
-      steps.add(step);
+      steps.add(Objects.requireNonNull(step, "Chain step cannot be null"));
       return this;
     }
 
     public Builder<Request, Response> addStepAgent(
         ChainStepAgent<Request, Response> agent) {
-      Assert.notNull(agent, "Chain step agent cannot be null");
-      steps.add(agent);
+      steps.add(Objects.requireNonNull(agent, "Chain step agent cannot be null"));
       return this;
     }
 

patterns/parallelization-workflow/src/main/java/com/javaaidev/agenticpatterns/parallelizationworkflow/DefaultResponseAssembler.java

@@ -12,6 +12,12 @@
 import org.springframework.ai.chat.client.ChatClient;
 import org.springframework.ai.chat.client.ChatClient.ChatClientRequestSpec;
 
+/**
+ * A {@linkplain ResponseAssembler} implemented using {@linkplain TaskExecutionAgent}
+ *
+ * @param <Request>
+ * @param <Response>
+ */
 public class DefaultResponseAssembler<Request, Response> extends
     TaskExecutionAgent<AssemblingInput<Request>, Response> implements
     ResponseAssembler<Request, Response> {

patterns/parallelization-workflow/src/main/java/com/javaaidev/agenticpatterns/parallelizationworkflow/DirectAssembling.java

@@ -18,6 +18,13 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * Parallelization Workflow agent, refer to <a
+ * href="https://javaaidev.com/docs/agentic-patterns/patterns/parallelization-workflow">doc</a>
+ *
+ * @param <Request>  Type of workflow input
+ * @param <Response> Type of workflow output
+ */
 public class ParallelizationWorkflow<Request, Response> extends
     AbstractAgenticWorkflow<Request, Response> {