Refactor and adjusts in docs

Author: sleipnir

README.md

@@ -6,6 +6,7 @@
 import io.eigr.spawn.api.actors.workflows.Pipe;
 import io.eigr.spawn.api.actors.workflows.SideEffect;
 
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Objects;
 import java.util.Optional;
@@ -14,6 +15,8 @@ public final class Value<S extends GeneratedMessageV3, R extends GeneratedMessag
 
     private S state;
     private R response;
+
+    private boolean checkpoint;
     private Optional<Broadcast<?>> broadcast;
     private Optional<Forward> forward;
     private Optional<Pipe> pipe;
@@ -24,6 +27,7 @@ public final class Value<S extends GeneratedMessageV3, R extends GeneratedMessag
     private Value() {
         this.state = null;
         this.response = null;
+        this.checkpoint = false;
         this.broadcast = Optional.empty();
         this.forward = Optional.empty();
         this.pipe = Optional.empty();
@@ -34,20 +38,26 @@ private Value() {
     private Value(
             R response,
             S state,
+            boolean checkpoint,
             Optional<Broadcast<?>> broadcast,
             Optional<Forward> forward,
             Optional<Pipe> pipe,
             Optional<List<SideEffect>> effects,
             ResponseType type) {
         this.response = response;
         this.state = state;
+        this.checkpoint = checkpoint;
         this.broadcast = broadcast;
         this.forward = forward;
         this.pipe = pipe;
         this.effects = effects;
         this.type = type;
     }
 
+    public static <S, V> Value at() {
+        return new Value();
+    }
+
     public R getResponse() {
         return response;
     }
@@ -56,6 +66,10 @@ public S getState() {
         return state;
     }
 
+    public boolean getCheckpoint() {
+        return checkpoint;
+    }
+
     public Optional<Broadcast<?>> getBroadcast() {
         return broadcast;
     }
@@ -76,10 +90,6 @@ public ResponseType getType() {
         return type;
     }
 
-    public static <S, V> Value at() {
-        return new Value();
-    }
-
     public Value response(R value) {
         this.response = value;
         return this;
@@ -90,6 +100,12 @@ public Value state(S state) {
         return this;
     }
 
+    public Value state(S state, boolean checkpoint) {
+        this.state = state;
+        this.checkpoint = checkpoint;
+        return this;
+    }
+
     public Value flow(Broadcast broadcast) {
         this.broadcast = Optional.of(broadcast);
         return this;
@@ -106,11 +122,16 @@ public Value flow(Pipe pipe) {
     }
 
     public Value flow(SideEffect effect) {
+        List<SideEffect> ef;
         if (this.effects.isPresent()) {
-            List<SideEffect> ef = this.effects.get();
+            ef = this.effects.get();
+            ef.add(effect);
+        } else {
+            ef = new ArrayList<>();
             ef.add(effect);
-            this.effects = Optional.of(ef);
         }
+
+        this.effects = Optional.of(ef);
         return this;
     }
 
@@ -120,11 +141,11 @@ public Value flow(List<SideEffect> effects) {
     }
 
     public Value reply() {
-        return new Value(this.response, this.state, this.broadcast, this.forward, this.pipe, this.effects, ResponseType.REPLY);
+        return new Value(this.response, this.state, this.checkpoint, this.broadcast, this.forward, this.pipe, this.effects, ResponseType.REPLY);
     }
 
     public Value noReply() {
-        return new Value(this.response, this.state, this.broadcast, this.forward, this.pipe, this.effects, ResponseType.NO_REPLY);
+        return new Value(this.response, this.state, this.checkpoint, this.broadcast, this.forward, this.pipe, this.effects, ResponseType.NO_REPLY);
     }
 
     public Value empty() {
@@ -135,6 +156,7 @@ public Value empty() {
     public String toString() {
         final StringBuilder sb = new StringBuilder("Value{");
         sb.append("state=").append(state);
+        sb.append("checkpoint=").append(checkpoint);
         sb.append(", value=").append(response);
         sb.append(", broadcast=").append(broadcast);
         sb.append(", forward=").append(forward);
@@ -152,6 +174,7 @@ public boolean equals(Object o) {
         Value<?, ?> value = (Value<?, ?>) o;
         return Objects.equals(state, value.state) &&
                 Objects.equals(response, value.response) &&
+                Objects.equals(checkpoint, value.checkpoint) &&
                 Objects.equals(broadcast, value.broadcast) &&
                 Objects.equals(forward, value.forward) &&
                 Objects.equals(pipe, value.pipe) &&
@@ -161,7 +184,7 @@ public boolean equals(Object o) {
 
     @Override
     public int hashCode() {
-        return Objects.hash(state, response, broadcast, forward, pipe, effects, type);
+        return Objects.hash(state, response, checkpoint, broadcast, forward, pipe, effects, type);
     }
 
     enum ResponseType {

src/main/java/io/eigr/spawn/api/Value.java

@@ -45,8 +45,7 @@ private ActorRef(SpawnClient client, String system, String name, String parent)
             spawnActor();
         }
     }
-
-
+    
     public static ActorRef of(SpawnClient client, String system, String name) throws Exception {
         return new ActorRef(client, system, name);
     }
@@ -114,7 +113,8 @@ private void spawnActor() throws Exception {
         this.client.spawn(req);
     }
 
-    private <T extends GeneratedMessageV3, S extends GeneratedMessageV3> Object invokeActor(String cmd, S argument, Class<T> outputType, Optional<InvocationOpts> options) throws Exception {
+    private <T extends GeneratedMessageV3, S extends GeneratedMessageV3> Object invokeActor(
+            String cmd, S argument, Class<T> outputType, Optional<InvocationOpts> options) throws Exception {
         Protocol.InvocationRequest.Builder invocationRequestBuilder = Protocol.InvocationRequest.newBuilder();
 
         if (options.isPresent()) {

src/main/java/io/eigr/spawn/api/actors/ActorRef.java

@@ -1,45 +1,59 @@
 package io.eigr.spawn.api.actors.workflows;
 
 import io.eigr.functions.protocol.Protocol;
+import io.eigr.spawn.api.actors.ActorRef;
 
 import java.util.Objects;
+import java.util.StringJoiner;
 
 public final class Forward {
 
-    private final String actor;
+    private final ActorRef actor;
 
-    private final String command;
+    private final String action;
 
-    private Forward(String actor, String command) {
+    private Forward(ActorRef actor, String action) {
         this.actor = actor;
-        this.command = command;
+        this.action = action;
     }
 
-    public static Forward to(String actor, String command) {
-        return new Forward(actor, command);
+    public static Forward to(ActorRef actor, String action) {
+        return new Forward(actor, action);
     }
 
-    public String getActor() {
+    public ActorRef getActor() {
         return actor;
     }
 
+    public String getAction() {
+        return action;
+    }
+
     public Protocol.Forward build() {
         return Protocol.Forward.newBuilder()
-                .setActor(this.actor)
-                .setActionName(this.command)
+                .setActor(this.actor.getActorName())
+                .setActionName(this.action)
                 .build();
     }
 
+    @Override
+    public String toString() {
+        return new StringJoiner(", ", Forward.class.getSimpleName() + "[", "]")
+                .add("actor='" + actor + "'")
+                .add("action='" + action + "'")
+                .toString();
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
         if (o == null || getClass() != o.getClass()) return false;
         Forward forward = (Forward) o;
-        return Objects.equals(actor, forward.actor) && Objects.equals(command, forward.command);
+        return Objects.equals(actor, forward.actor) && Objects.equals(action, forward.action);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(actor, command);
+        return Objects.hash(actor, action);
     }
 }

src/main/java/io/eigr/spawn/api/actors/workflows/Forward.java

@@ -1,49 +1,61 @@
 package io.eigr.spawn.api.actors.workflows;
 
 import io.eigr.functions.protocol.Protocol;
+import io.eigr.spawn.api.actors.ActorRef;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.Objects;
+import java.util.StringJoiner;
 
 public final class Pipe {
 
-    private final String actor;
+    private final ActorRef actor;
 
-    private final String command;
+    private final String action;
 
-    private Pipe(String actor, String command) {
+    private Pipe(ActorRef actor, String action) {
         this.actor = actor;
-        this.command = command;
+        this.action = action;
     }
 
-    public static Pipe to(String actor, String command) {
-        return new Pipe(actor, command);
+    @NotNull
+    public static Pipe to(ActorRef actor, String action) {
+        return new Pipe(actor, action);
     }
 
-    public String getActor() {
+    public ActorRef getActor() {
         return actor;
     }
 
-    public String getCommand() {
-        return command;
+    public String getAction() {
+        return action;
     }
 
     public Protocol.Pipe build() {
         return Protocol.Pipe.newBuilder()
-                .setActor(this.actor)
-                .setActionName(this.command)
+                .setActor(this.actor.getActorName())
+                .setActionName(this.action)
                 .build();
     }
 
+    @Override
+    public String toString() {
+        return new StringJoiner(", ", Pipe.class.getSimpleName() + "[", "]")
+                .add("actor='" + actor + "'")
+                .add("action='" + action + "'")
+                .toString();
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
         if (o == null || getClass() != o.getClass()) return false;
         Pipe pipe = (Pipe) o;
-        return Objects.equals(actor, pipe.actor) && Objects.equals(command, pipe.command);
+        return Objects.equals(actor, pipe.actor) && Objects.equals(action, pipe.action);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(actor, command);
+        return Objects.hash(actor, action);
     }
 }