Skip to content

Commit 0c26454

Browse files
YangKiandaleiz
authored andcommitted
update javadoc of io.hstream
1 parent 26d9380 commit 0c26454

13 files changed

+15
-2
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import io.hstream.impl.ClientImpl;
44

5-
/** used to construct a hstreamdb client, which you can use it to interact with hstreamdb server */
5+
/** used to construct a hstream client, which you can use it to interact with hstream server */
66
public class ClientBuilder {
77

88
private String serviceUrl;

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22

33
import com.google.common.util.concurrent.Service;
44

5+
/** The consumer interface of hstream consumer */
56
public interface Consumer extends Service {}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import com.google.protobuf.ListValue;
44

5+
/** a data structure like array */
56
public class HArray {
67

78
private ListValue delegate;

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import com.google.protobuf.ListValue;
44
import com.google.protobuf.util.Values;
55

6+
/** the {@link HArray} constructor */
67
public class HArrayBuilder {
78

89
private ListValue.Builder delegate;

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import com.google.protobuf.ByteString;
44
import com.google.protobuf.Struct;
55

6+
/** the data structure defined by hstream */
67
public class HRecord {
78

89
private Struct delegate;

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package io.hstream;
22

3+
/** the interface that user use to process {@link HRecord} received from server */
34
public interface HRecordReceiver {
45

56
/**

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import java.util.List;
44

5-
/** HstreamClient implement the hstreamdb client */
5+
/** HstreamClient implement the hstream client, user can use it to interact with server */
66
public interface HStreamClient extends AutoCloseable {
77

88
/**

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package io.hstream;
22

3+
/** Client exception definition */
34
public class HStreamDBClientException extends RuntimeException {
45

56
public HStreamDBClientException(final String message) {

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
package io.hstream;
22

3+
/** user can define actions when consume data from {@link Publisher} */
34
public interface Observer<V> {
45

56
/**

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
import java.util.concurrent.CompletableFuture;
44

5+
/** the interface of hstream producer */
56
public interface Producer {
67

78
/**

0 commit comments

Comments
 (0)