update javadoc of io.hstream

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

@@ -2,7 +2,7 @@
 
 import io.hstream.impl.ClientImpl;
 
-/** used to construct a hstreamdb client, which you can use it to interact with hstreamdb server */
+/** used to construct a hstream client, which you can use it to interact with hstream server */
 public class ClientBuilder {
 
   private String serviceUrl;

src/main/java/io/hstream/Consumer.java

@@ -2,4 +2,5 @@
 
 import com.google.common.util.concurrent.Service;
 
+/** The consumer interface of hstream consumer */
 public interface Consumer extends Service {}

src/main/java/io/hstream/HArray.java

@@ -2,6 +2,7 @@
 
 import com.google.protobuf.ListValue;
 
+/** a data structure like array */
 public class HArray {
 
   private ListValue delegate;

src/main/java/io/hstream/HArrayBuilder.java

@@ -3,6 +3,7 @@
 import com.google.protobuf.ListValue;
 import com.google.protobuf.util.Values;
 
+/** the {@link HArray} constructor */
 public class HArrayBuilder {
 
   private ListValue.Builder delegate;

src/main/java/io/hstream/HRecord.java

@@ -3,6 +3,7 @@
 import com.google.protobuf.ByteString;
 import com.google.protobuf.Struct;
 
+/** the data structure defined by hstream */
 public class HRecord {
 
   private Struct delegate;

src/main/java/io/hstream/HRecordReceiver.java

@@ -1,5 +1,6 @@
 package io.hstream;
 
+/** the interface that user use to process {@link HRecord} received from server */
 public interface HRecordReceiver {
 
   /**

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

@@ -2,7 +2,7 @@
 
 import java.util.List;
 
-/** HstreamClient implement the hstreamdb client */
+/** HstreamClient implement the hstream client, user can use it to interact with server */
 public interface HStreamClient extends AutoCloseable {
 
   /**

src/main/java/io/hstream/HStreamDBClientException.java

@@ -1,5 +1,6 @@
 package io.hstream;
 
+/** Client exception definition */
 public class HStreamDBClientException extends RuntimeException {
 
   public HStreamDBClientException(final String message) {

src/main/java/io/hstream/Observer.java

@@ -1,5 +1,6 @@
 package io.hstream;
 
+/** user can define actions when consume data from {@link Publisher} */
 public interface Observer<V> {
 
   /**

src/main/java/io/hstream/Producer.java

@@ -2,6 +2,7 @@
 
 import java.util.concurrent.CompletableFuture;
 
+/** the interface of hstream producer */
 public interface Producer {
 
   /**

src/main/java/io/hstream/Publisher.java

@@ -1,5 +1,6 @@
 package io.hstream;
 
+/** a Publisher is a provider of a potentially unbounded number of sequenced elements */
 public interface Publisher<V> {
 
   /**

src/main/java/io/hstream/RawRecordReceiver.java

@@ -1,5 +1,6 @@
 package io.hstream;
 
+/** the interface that user use to process raw record received from server */
 public interface RawRecordReceiver {
 
   /**

src/main/java/io/hstream/Responder.java

@@ -1,5 +1,8 @@
 package io.hstream;
 
+/**
+ * after receiving messages from the server, the interface defines methods related to the response
+ */
 public interface Responder {
 
   /** used to respond server when receive messages. */