From b07cfa0687e7f6d047e9c0bcbe7aec6c44fb5575 Mon Sep 17 00:00:00 2001 From: YangKian <1207783292@qq.com> Date: Fri, 6 Aug 2021 17:05:48 +0800 Subject: [PATCH] update javadoc of io.hstream --- src/main/java/io/hstream/ClientBuilder.java | 2 +- src/main/java/io/hstream/Consumer.java | 1 + src/main/java/io/hstream/HArray.java | 1 + src/main/java/io/hstream/HArrayBuilder.java | 1 + src/main/java/io/hstream/HRecord.java | 1 + src/main/java/io/hstream/HRecordReceiver.java | 1 + src/main/java/io/hstream/HStreamClient.java | 2 +- src/main/java/io/hstream/HStreamDBClientException.java | 1 + src/main/java/io/hstream/Observer.java | 1 + src/main/java/io/hstream/Producer.java | 1 + src/main/java/io/hstream/Publisher.java | 1 + src/main/java/io/hstream/RawRecordReceiver.java | 1 + src/main/java/io/hstream/Responder.java | 3 +++ 13 files changed, 15 insertions(+), 2 deletions(-) diff --git a/src/main/java/io/hstream/ClientBuilder.java b/src/main/java/io/hstream/ClientBuilder.java index 7ba7a37f..b7007867 100644 --- a/src/main/java/io/hstream/ClientBuilder.java +++ b/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; diff --git a/src/main/java/io/hstream/Consumer.java b/src/main/java/io/hstream/Consumer.java index b101fdd6..70b61e28 100644 --- a/src/main/java/io/hstream/Consumer.java +++ b/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 {} diff --git a/src/main/java/io/hstream/HArray.java b/src/main/java/io/hstream/HArray.java index 2176757a..dd2ad9ab 100644 --- a/src/main/java/io/hstream/HArray.java +++ b/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; diff --git a/src/main/java/io/hstream/HArrayBuilder.java b/src/main/java/io/hstream/HArrayBuilder.java index a832efd2..1c6e545c 100644 --- a/src/main/java/io/hstream/HArrayBuilder.java +++ b/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; diff --git a/src/main/java/io/hstream/HRecord.java b/src/main/java/io/hstream/HRecord.java index a8a2241a..1a7d1cf4 100644 --- a/src/main/java/io/hstream/HRecord.java +++ b/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; diff --git a/src/main/java/io/hstream/HRecordReceiver.java b/src/main/java/io/hstream/HRecordReceiver.java index af7c23c5..a1a7ee4c 100644 --- a/src/main/java/io/hstream/HRecordReceiver.java +++ b/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 { /** diff --git a/src/main/java/io/hstream/HStreamClient.java b/src/main/java/io/hstream/HStreamClient.java index 6fb56323..85b37087 100644 --- a/src/main/java/io/hstream/HStreamClient.java +++ b/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 { /** diff --git a/src/main/java/io/hstream/HStreamDBClientException.java b/src/main/java/io/hstream/HStreamDBClientException.java index 4f59b882..dc9e36a7 100644 --- a/src/main/java/io/hstream/HStreamDBClientException.java +++ b/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) { diff --git a/src/main/java/io/hstream/Observer.java b/src/main/java/io/hstream/Observer.java index 475a6e31..eddd05bb 100644 --- a/src/main/java/io/hstream/Observer.java +++ b/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 { /** diff --git a/src/main/java/io/hstream/Producer.java b/src/main/java/io/hstream/Producer.java index 4340c937..40f6d8de 100644 --- a/src/main/java/io/hstream/Producer.java +++ b/src/main/java/io/hstream/Producer.java @@ -2,6 +2,7 @@ import java.util.concurrent.CompletableFuture; +/** the interface of hstream producer */ public interface Producer { /** diff --git a/src/main/java/io/hstream/Publisher.java b/src/main/java/io/hstream/Publisher.java index ca2ade0b..644beb6a 100644 --- a/src/main/java/io/hstream/Publisher.java +++ b/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 { /** diff --git a/src/main/java/io/hstream/RawRecordReceiver.java b/src/main/java/io/hstream/RawRecordReceiver.java index 8a1ad4fe..2670ed03 100644 --- a/src/main/java/io/hstream/RawRecordReceiver.java +++ b/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 { /** diff --git a/src/main/java/io/hstream/Responder.java b/src/main/java/io/hstream/Responder.java index df0ef494..f3fcc0f8 100644 --- a/src/main/java/io/hstream/Responder.java +++ b/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. */