Merge pull request #5 from pavansharma36/dev

fixed checkstyle

workflow-api/src/main/java/io/github/pavansharma36/workflow/api/adapter/builder/BasePersistenceAdapterBuilder.java

@@ -3,9 +3,20 @@
 import io.github.pavansharma36.workflow.api.adapter.PersistenceAdapter;
 import io.github.pavansharma36.workflow.api.util.PollDelayGenerator;
 
+/**
+ * persistent adapter builder.
+ *
+ * @param <T> - same class.
+ */
 public abstract class BasePersistenceAdapterBuilder<T extends BasePersistenceAdapterBuilder<T>>
     extends BaseAdapterBuilder<T, PersistenceAdapter> {
 
+  /**
+   * heartbeat delay generator to use.
+   *
+   * @param heartbeatDelayGenerator - generator
+   * @return - this
+   */
   public T withHeartbeatDelayGenerator(PollDelayGenerator heartbeatDelayGenerator) {
     this.pollDelayGenerator = heartbeatDelayGenerator;
     return (T) this;

workflow-api/src/main/java/io/github/pavansharma36/workflow/api/adapter/builder/WorkflowAdapterBuilder.java

@@ -22,40 +22,86 @@ public WorkflowAdapterBuilder withQueuePollDelayGenerator(
     return this;
   }
 
+  /**
+   * schedule poll delay generator to use.
+   *
+   * @param pollDelayGenerator - generator
+   * @return - this
+   */
   public WorkflowAdapterBuilder withSchedulePollDelayGenerator(
       final PollDelayGenerator pollDelayGenerator) {
     this.scheduleAdapterBuilder.withPollDelayGenerator(pollDelayGenerator);
     return this;
   }
 
-  public WorkflowAdapterBuilder withHeartbeatDelayGenerator(PollDelayGenerator heartbeatDelayGenerator) {
+  /**
+   * heartbeat generator to use.
+   *
+   * @param heartbeatDelayGenerator - generator
+   * @return - this
+   */
+  public WorkflowAdapterBuilder withHeartbeatDelayGenerator(PollDelayGenerator
+                                                                heartbeatDelayGenerator) {
     this.persistenceAdapterBuilder.withHeartbeatDelayGenerator(heartbeatDelayGenerator);
     return this;
   }
 
+  /**
+   * poll delay generator to use.
+   *
+   * @param pollDelayGenerator - generator
+   * @return - this
+   */
   public WorkflowAdapterBuilder withMaintenancePollDelayGenerator(
       final PollDelayGenerator pollDelayGenerator
   ) {
     this.scheduleAdapterBuilder.withMaintenanceDelayGenerator(pollDelayGenerator);
     return this;
   }
 
+  /**
+   * max run duration to use.
+   *
+   * @param duration - duration
+   * @return - this
+   */
   public WorkflowAdapterBuilder withMaxRunDuration(Duration duration) {
     this.scheduleAdapterBuilder.maxRunDuration(duration);
     return this;
   }
 
-  public WorkflowAdapterBuilder withScheduleAdapterBuilder(BaseScheduleAdapterBuilder<?> scheduleAdapterBuilder) {
+  /**
+   * scheduler adapter to use.
+   *
+   * @param scheduleAdapterBuilder - adapter
+   * @return - this
+   */
+  public WorkflowAdapterBuilder withScheduleAdapterBuilder(BaseScheduleAdapterBuilder<?>
+                                                               scheduleAdapterBuilder) {
     this.scheduleAdapterBuilder = scheduleAdapterBuilder;
     return this;
   }
 
-  public WorkflowAdapterBuilder withPersistenceAdapterBuilder(BasePersistenceAdapterBuilder<?> persistenceAdapterBuilder) {
+  /**
+   * persistent adapter to use.
+   *
+   * @param persistenceAdapterBuilder - adaper
+   * @return - this
+   */
+  public WorkflowAdapterBuilder withPersistenceAdapterBuilder(BasePersistenceAdapterBuilder<?>
+                                                                  persistenceAdapterBuilder) {
     this.persistenceAdapterBuilder = persistenceAdapterBuilder;
     return this;
   }
 
-  public WorkflowAdapterBuilder withQueueAdapterBuilder(BaseAdapterBuilder<?, ? extends QueueAdapter> queueAdapterBuilder) {
+  /**
+   * queue adapter to use.
+   *
+   * @param queueAdapterBuilder - queue adaper
+   * @return - this
+   */
+  public WorkflowAdapterBuilder withQueueAdapterBuilder(
+      BaseAdapterBuilder<?, ? extends QueueAdapter> queueAdapterBuilder) {
     this.queueAdapterBuilder = queueAdapterBuilder;
     return this;
   }

workflow-api/src/main/java/io/github/pavansharma36/workflow/api/executor/ExecutionResult.java

@@ -18,10 +18,21 @@ public class ExecutionResult {
   private Map<String, Object> resultMeta;
   private TaskId decision;
 
+  /**
+   * for serializer.
+   */
   public ExecutionResult() {
 
   }
 
+  /**
+   * all args constructor.
+   *
+   * @param status - status
+   * @param message - message
+   * @param resultMeta - result
+   * @param decision - decision
+   */
   public ExecutionResult(TaskExecutionStatus status, String message, Map<String, Object> resultMeta,
                          TaskId decision) {
     this.status = status;

workflow-api/src/main/java/io/github/pavansharma36/workflow/api/impl/QueueConsumerImpl.java

@@ -132,7 +132,8 @@ private void run(final WorkflowManager workflowManager) {
                     break;
                   } catch (final Throwable e) {
                     log.error("Unhandled error in task execution {}", e.getMessage(), e);
-                    executionResult = new ExecutionResult(TaskExecutionStatus.FAILED_STOP, e.getMessage(), null, null);
+                    executionResult = new ExecutionResult(TaskExecutionStatus.FAILED_STOP,
+                        e.getMessage(), null, null);
                     force = true;
                   }
                 } while (retry++ < taskInfo.getRetryCount());

workflow-api/src/main/java/io/github/pavansharma36/workflow/api/serde/IdSerializer.java

@@ -3,11 +3,22 @@
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.JsonSerializer;
 import com.fasterxml.jackson.databind.SerializerProvider;
-import com.fasterxml.jackson.databind.ser.std.StdSerializer;
 import io.github.pavansharma36.workflow.api.bean.id.Id;
 import java.io.IOException;
 
+/**
+ * jackson serializer for Id.
+ */
 public class IdSerializer extends JsonSerializer<Id> {
+
+  /**
+   * serialize id as string.
+   *
+   * @param id - id to serialize
+   * @param jsonGenerator - json
+   * @param serializerProvider - serializer
+   * @throws IOException - invalid
+   */
   @Override
   public void serialize(Id id, JsonGenerator jsonGenerator, SerializerProvider serializerProvider)
       throws IOException {

workflow-api/src/test/resources/simplelogger.properties

@@ -1 +1 @@
-org.slf4j.simpleLogger.defaultLogLevel=warn
+org.slf4j.simpleLogger.defaultLogLevel=info

workflow-examples/src/main/java/io/github/pavansharma36/workflow/examples/App.java

@@ -77,7 +77,8 @@ public static void main(final String[] args) throws InterruptedException, IOExce
     final WorkflowManager workflowManager = WorkflowManagerBuilder.builder().withAdapter(adapter)
         .addingTaskExecutor(taskTypeA, 2, te).addingTaskExecutor(taskTypeB, 2, te)
         .addingTaskExecutor(taskTypeC, 2, te).addingTaskExecutor(decisionType, 1,
-            (manager, task) -> new ExecutionResult(TaskExecutionStatus.SUCCESS, null, null, new TaskId("taske"))).build();
+            (manager, task) -> new ExecutionResult(TaskExecutionStatus.SUCCESS, null,
+                null, new TaskId("taske"))).build();
 
     CountDownLatch countDownLatch = new CountDownLatch(SUBMIT_COUNT);
     workflowManager.workflowManagerListener().addListener(new WorkflowListener() {

workflow-inmemory/src/main/java/io/github/pavansharma36/workflow/inmemory/adapter/InmemoryPersistenceAdapter.java

@@ -21,12 +21,21 @@
 import java.util.Optional;
 import java.util.stream.Collectors;
 
+/**
+ * inmemory persistence adapter.
+ */
 public class InmemoryPersistenceAdapter extends BasePersistenceAdapter {
 
   private Map<ManagerId, ManagerInfo> managerInfos = new HashMap<>();
   private Map<RunId, RunInfo> runInfos = new HashMap<>();
   private Map<RunId, Map<TaskId, TaskInfo>> taskInfos = new HashMap<>();
 
+  /**
+   * required constructor.
+   *
+   * @param namespace - NA
+   * @param heartbeatDelayGenerator - poll delay generator.
+   */
   public InmemoryPersistenceAdapter(String namespace, PollDelayGenerator heartbeatDelayGenerator) {
     super(namespace, heartbeatDelayGenerator);
   }
@@ -130,7 +139,8 @@ public boolean updateRunInfoEpoch(RunId runId) {
 
   @Override
   public void createTaskInfos(RunId runId, List<TaskInfo> taskInfos) {
-    this.taskInfos.put(runId, taskInfos.stream().collect(Collectors.toMap(TaskInfo::getTaskId, t -> t)));
+    this.taskInfos.put(runId, taskInfos.stream().collect(
+        Collectors.toMap(TaskInfo::getTaskId, t -> t)));
   }
 
   @Override

workflow-inmemory/src/main/java/io/github/pavansharma36/workflow/inmemory/adapter/InmemoryQueueAdapter.java

@@ -13,6 +13,9 @@
 import java.util.Optional;
 import lombok.RequiredArgsConstructor;
 
+/**
+ * queue adapter for inmemory workflow.
+ */
 @RequiredArgsConstructor
 public class InmemoryQueueAdapter implements QueueAdapter {
 

workflow-inmemory/src/main/java/io/github/pavansharma36/workflow/inmemory/adapter/InmemorySchedulerAdapter.java

@@ -7,6 +7,9 @@
 import java.time.Duration;
 import lombok.RequiredArgsConstructor;
 
+/**
+ * schedule adapter for inmemory workflow.
+ */
 @RequiredArgsConstructor
 public class InmemorySchedulerAdapter implements ScheduleAdapter {
 

workflow-inmemory/src/main/java/io/github/pavansharma36/workflow/inmemory/builder/InmemoryPersistenceAdapterBuilder.java

@@ -5,12 +5,19 @@
 import io.github.pavansharma36.workflow.api.util.WorkflowException;
 import io.github.pavansharma36.workflow.inmemory.adapter.InmemoryPersistenceAdapter;
 
+/**
+ * persistent adapter builder for inmemory workflow.
+ */
 public class InmemoryPersistenceAdapterBuilder
     extends BasePersistenceAdapterBuilder<InmemoryPersistenceAdapterBuilder> {
 
+  /**
+   * default constructor.
+   */
   public InmemoryPersistenceAdapterBuilder() {
     namespace = "NA";
   }
+
   @Override
   public PersistenceAdapter build() {
     return new InmemoryPersistenceAdapter(namespace, pollDelayGenerator);

workflow-inmemory/src/main/java/io/github/pavansharma36/workflow/inmemory/builder/InmemoryQueueAdapterBuilder.java

@@ -5,12 +5,19 @@
 import io.github.pavansharma36.workflow.api.util.WorkflowException;
 import io.github.pavansharma36.workflow.inmemory.adapter.InmemoryQueueAdapter;
 
+/**
+ * queue adapter builder for inmemory workflow.
+ */
 public class InmemoryQueueAdapterBuilder
     extends BaseAdapterBuilder<InmemoryQueueAdapterBuilder, QueueAdapter> {
 
+  /**
+   * default constructor.
+   */
   public InmemoryQueueAdapterBuilder() {
     namespace = "NA";
   }
+
   @Override
   public QueueAdapter build() {
     return new InmemoryQueueAdapter(pollDelayGenerator);

workflow-inmemory/src/main/java/io/github/pavansharma36/workflow/inmemory/builder/InmemoryScheduleAdapterBuilder.java

@@ -5,8 +5,15 @@
 import io.github.pavansharma36.workflow.api.util.WorkflowException;
 import io.github.pavansharma36.workflow.inmemory.adapter.InmemorySchedulerAdapter;
 
-public class InmemoryScheduleAdapterBuilder extends BaseScheduleAdapterBuilder<InmemoryScheduleAdapterBuilder> {
+/**
+ * schedule adapter builder for inmemory workflow.
+ */
+public class InmemoryScheduleAdapterBuilder
+    extends BaseScheduleAdapterBuilder<InmemoryScheduleAdapterBuilder> {
 
+  /**
+   * default constructor.
+   */
   public InmemoryScheduleAdapterBuilder() {
     namespace = "NA";
   }

workflow-inmemory/src/main/java/io/github/pavansharma36/workflow/inmemory/builder/InmemoryWorkflowAdapterBuilder.java

@@ -2,10 +2,17 @@
 
 import io.github.pavansharma36.workflow.api.adapter.builder.WorkflowAdapterBuilder;
 
+/**
+ * workflow adapter builder for inmemory workflow.
+ */
 public class InmemoryWorkflowAdapterBuilder
     extends WorkflowAdapterBuilder {
 
-
+  /**
+   * main builder.
+   *
+   * @return - this
+   */
   public static InmemoryWorkflowAdapterBuilder builder() {
     InmemoryWorkflowAdapterBuilder builder = new InmemoryWorkflowAdapterBuilder();
     builder.scheduleAdapterBuilder = new InmemoryScheduleAdapterBuilder();