make main builders as interfaces (#31)

Author: daleiz

.github/workflows/main.yml

@@ -22,7 +22,7 @@ jobs:
           args: '--set-exit-if-changed'
 
       - name: Prepare test env
-        run:  script/prepare-test-env-latest.sh
+        run:  script/prepare-test-env.sh
 
       - name: Set up JDK 11
         uses: actions/setup-java@v2

client/src/main/java/io/hstream/ClientBuilder.java

@@ -1,47 +1,14 @@
 package io.hstream;
 
-import io.hstream.impl.ConsumerImpl;
-import io.hstream.internal.HStreamApiGrpc;
+public interface ConsumerBuilder {
 
-/** used to construct a consumer */
-public class ConsumerBuilder {
+  ConsumerBuilder name(String name);
 
-  private HStreamApiGrpc.HStreamApiStub grpcStub;
-  private HStreamApiGrpc.HStreamApiBlockingStub grpcBlockingStub;
-  private String name;
-  private String subscription;
-  private RawRecordReceiver rawRecordReceiver;
-  private HRecordReceiver hRecordReceiver;
+  ConsumerBuilder subscription(String subscription);
 
-  public ConsumerBuilder(
-      HStreamApiGrpc.HStreamApiStub grpcStub,
-      HStreamApiGrpc.HStreamApiBlockingStub grpcBlockingStub) {
-    this.grpcStub = grpcStub;
-    this.grpcBlockingStub = grpcBlockingStub;
-  }
+  ConsumerBuilder rawRecordReceiver(RawRecordReceiver rawRecordReceiver);
 
-  public ConsumerBuilder name(String name) {
-    this.name = name;
-    return this;
-  }
+  ConsumerBuilder hRecordReceiver(HRecordReceiver hRecordReceiver);
 
-  public ConsumerBuilder subscription(String subscription) {
-    this.subscription = subscription;
-    return this;
-  }
-
-  public ConsumerBuilder rawRecordReceiver(RawRecordReceiver rawRecordReceiver) {
-    this.rawRecordReceiver = rawRecordReceiver;
-    return this;
-  }
-
-  public ConsumerBuilder hRecordReceiver(HRecordReceiver hRecordReceiver) {
-    this.hRecordReceiver = hRecordReceiver;
-    return this;
-  }
-
-  public Consumer build() {
-    return new ConsumerImpl(
-        grpcStub, grpcBlockingStub, name, subscription, rawRecordReceiver, hRecordReceiver);
-  }
+  Consumer build();
 }

client/src/main/java/io/hstream/ConsumerBuilder.java

@@ -1,45 +1,26 @@
 package io.hstream;
 
+import io.hstream.impl.HStreamClientBuilderImpl;
 import java.util.List;
 
-/** HstreamClient implement the hstream client, user can use it to interact with server */
+/** HStreamDB Client. */
 public interface HStreamClient extends AutoCloseable {
 
-  /**
-   * a static method use to create a new client.
-   *
-   * @return {@link ClientBuilder}.
-   */
-  static ClientBuilder builder() {
-    return new ClientBuilder();
+  /** @return {@link HStreamClientBuilder}. */
+  static HStreamClientBuilder builder() {
+    return new HStreamClientBuilderImpl();
   }
 
-  /**
-   * create a producer.
-   *
-   * @return the {@link ProducerBuilder}.
-   */
+  /** @return the {@link ProducerBuilder}. */
   ProducerBuilder newProducer();
 
-  /**
-   * create a consumer.
-   *
-   * @return the {@link ConsumerBuilder}.
-   */
+  /** @return the {@link ConsumerBuilder}. */
   ConsumerBuilder newConsumer();
 
-  /**
-   * create a {@link QueryerBuilder}.
-   *
-   * @return the {@link Queryer}.
-   */
+  /** @return the {@link QueryerBuilder}. */
   QueryerBuilder newQueryer();
 
-  /**
-   * Create a stream.
-   *
-   * @param stream the name of stream.
-   */
+  /** @param stream the name of stream. */
   void createStream(String stream);
 
   /**

client/src/main/java/io/hstream/HStreamClient.java

@@ -0,0 +1,8 @@
+package io.hstream;
+
+public interface HStreamClientBuilder {
+
+  HStreamClientBuilder serviceUrl(String serviceUrl);
+
+  HStreamClient build();
+}

client/src/main/java/io/hstream/HStreamClientBuilder.java

@@ -1,39 +1,12 @@
 package io.hstream;
 
-import io.hstream.impl.ProducerImpl;
-import io.hstream.internal.HStreamApiGrpc;
+public interface ProducerBuilder {
 
-/** used to construct a producer */
-public class ProducerBuilder {
+  ProducerBuilder stream(String streamName);
 
-  private HStreamApiGrpc.HStreamApiStub grpcStub;
+  ProducerBuilder enableBatch();
 
-  private String streamName;
+  ProducerBuilder recordCountLimit(int recordCountLimit);
 
-  private boolean enableBatch = false;
-
-  private int recordCountLimit = 1;
-
-  public ProducerBuilder(HStreamApiGrpc.HStreamApiStub stub) {
-    this.grpcStub = stub;
-  }
-
-  public ProducerBuilder stream(String streamName) {
-    this.streamName = streamName;
-    return this;
-  }
-
-  public ProducerBuilder enableBatch() {
-    this.enableBatch = true;
-    return this;
-  }
-
-  public ProducerBuilder recordCountLimit(int recordCountLimit) {
-    this.recordCountLimit = recordCountLimit;
-    return this;
-  }
-
-  public Producer build() {
-    return new ProducerImpl(grpcStub, streamName, enableBatch, recordCountLimit);
-  }
+  Producer build();
 }

client/src/main/java/io/hstream/ProducerBuilder.java

@@ -1,49 +1,27 @@
 package io.hstream;
 
-import io.hstream.impl.QueryerImpl;
-import io.hstream.internal.HStreamApiGrpc;
-
-/** Builder used to configure and construct a {@link Queryer} instance. */
-public class QueryerBuilder {
-
-  private HStreamClient client;
-  private HStreamApiGrpc.HStreamApiStub grpcStub;
-  private String sql;
-  private Observer<HRecord> resultObserver;
-
-  public QueryerBuilder(HStreamClient client, HStreamApiGrpc.HStreamApiStub grpcStub) {
-    this.client = client;
-    this.grpcStub = grpcStub;
-  }
+public interface QueryerBuilder {
 
   /**
    * Set SQL statement the queryer will execute.
    *
    * @param sql SQL statement, only allow statements like "select ... emit changes"
    * @return the {@link QueryerBuilder} instance
    */
-  public QueryerBuilder sql(String sql) {
-    this.sql = sql;
-    return this;
-  }
+  QueryerBuilder sql(String sql);
 
   /**
    * Set {@link Observer} for sql results.
    *
    * @param resultObserver the {@link Observer} instance
    * @return the {@link QueryerBuilder} instance
    */
-  public QueryerBuilder resultObserver(Observer<HRecord> resultObserver) {
-    this.resultObserver = resultObserver;
-    return this;
-  }
+  QueryerBuilder resultObserver(Observer<HRecord> resultObserver);
 
   /**
    * Construct the final {@link Queryer} instance.
    *
    * @return the {@link Queryer} instance
    */
-  public Queryer build() {
-    return new QueryerImpl(client, grpcStub, sql, resultObserver);
-  }
+  Queryer build();
 }

client/src/main/java/io/hstream/QueryerBuilder.java

@@ -0,0 +1,54 @@
+package io.hstream.impl;
+
+import io.hstream.Consumer;
+import io.hstream.ConsumerBuilder;
+import io.hstream.HRecordReceiver;
+import io.hstream.RawRecordReceiver;
+import io.hstream.internal.HStreamApiGrpc;
+
+public class ConsumerBuilderImpl implements ConsumerBuilder {
+
+  private HStreamApiGrpc.HStreamApiStub grpcStub;
+  private HStreamApiGrpc.HStreamApiBlockingStub grpcBlockingStub;
+  private String name;
+  private String subscription;
+  private RawRecordReceiver rawRecordReceiver;
+  private HRecordReceiver hRecordReceiver;
+
+  public ConsumerBuilderImpl(
+      HStreamApiGrpc.HStreamApiStub grpcStub,
+      HStreamApiGrpc.HStreamApiBlockingStub grpcBlockingStub) {
+    this.grpcStub = grpcStub;
+    this.grpcBlockingStub = grpcBlockingStub;
+  }
+
+  @Override
+  public ConsumerBuilder name(String name) {
+    this.name = name;
+    return this;
+  }
+
+  @Override
+  public ConsumerBuilder subscription(String subscription) {
+    this.subscription = subscription;
+    return this;
+  }
+
+  @Override
+  public ConsumerBuilder rawRecordReceiver(RawRecordReceiver rawRecordReceiver) {
+    this.rawRecordReceiver = rawRecordReceiver;
+    return this;
+  }
+
+  @Override
+  public ConsumerBuilder hRecordReceiver(HRecordReceiver hRecordReceiver) {
+    this.hRecordReceiver = hRecordReceiver;
+    return this;
+  }
+
+  @Override
+  public Consumer build() {
+    return new ConsumerImpl(
+        grpcStub, grpcBlockingStub, name, subscription, rawRecordReceiver, hRecordReceiver);
+  }
+}

client/src/main/java/io/hstream/impl/ConsumerBuilderImpl.java

@@ -0,0 +1,20 @@
+package io.hstream.impl;
+
+import io.hstream.HStreamClient;
+import io.hstream.HStreamClientBuilder;
+
+public class HStreamClientBuilderImpl implements HStreamClientBuilder {
+
+  private String serviceUrl;
+
+  @Override
+  public HStreamClientBuilder serviceUrl(String serviceUrl) {
+    this.serviceUrl = serviceUrl;
+    return this;
+  }
+
+  @Override
+  public HStreamClient build() {
+    return new HStreamClientImpl(serviceUrl);
+  }
+}

client/src/main/java/io/hstream/impl/HStreamClientBuilderImpl.java

@@ -15,15 +15,15 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class ClientImpl implements HStreamClient {
+public class HStreamClientImpl implements HStreamClient {
 
-  private static final Logger logger = LoggerFactory.getLogger(ClientImpl.class);
+  private static final Logger logger = LoggerFactory.getLogger(HStreamClientImpl.class);
 
   private final ManagedChannel managedChannel;
   private final HStreamApiGrpc.HStreamApiStub stub;
   private final HStreamApiGrpc.HStreamApiBlockingStub blockingStub;
 
-  public ClientImpl(String serviceUrl) {
+  public HStreamClientImpl(String serviceUrl) {
     ManagedChannel channel = ManagedChannelBuilder.forTarget(serviceUrl).usePlaintext().build();
     this.managedChannel = channel;
     this.stub = HStreamApiGrpc.newStub(channel);
@@ -32,17 +32,17 @@ public ClientImpl(String serviceUrl) {
 
   @Override
   public ProducerBuilder newProducer() {
-    return new ProducerBuilder(stub);
+    return new ProducerBuilderImpl(stub);
   }
 
   @Override
   public ConsumerBuilder newConsumer() {
-    return new ConsumerBuilder(stub, blockingStub);
+    return new ConsumerBuilderImpl(stub, blockingStub);
   }
 
   @Override
   public QueryerBuilder newQueryer() {
-    return new QueryerBuilder(this, stub);
+    return new QueryerBuilderImpl(this, stub);
   }
 
   @Override