Skip to content

Commit bbd7e4d

Browse files
chore: add document for function
1 parent f21aaf9 commit bbd7e4d

File tree

1 file changed

+28
-12
lines changed

1 file changed

+28
-12
lines changed

src/main/java/com/influxdb/v3/client/InfluxDBClient.java

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,9 @@ public interface InfluxDBClient extends AutoCloseable {
7676
* Write a {@link Point} to the InfluxDB server.
7777
*
7878
* @param point the {@link Point} to write, can be null
79-
* @apiNote the timestamp passed will be converted to nanoseconds since the Unix epoch by NanosecondConverter helper class
79+
* <p>
80+
* note: the timestamp passed will be converted to nanoseconds since the Unix epoch
81+
* by NanosecondConverter helper class
8082
*/
8183
void writePoint(@Nullable final Point point);
8284

@@ -85,15 +87,19 @@ public interface InfluxDBClient extends AutoCloseable {
8587
*
8688
* @param point the {@link Point} to write, can be null
8789
* @param options the options for writing data to InfluxDB
88-
* @apiNote the timestamp passed will be converted to nanoseconds since the Unix epoch by NanosecondConverter helper class
90+
* <p>
91+
* note: the timestamp passed will be converted to nanoseconds since the Unix epoch
92+
* by NanosecondConverter helper class
8993
*/
9094
void writePoint(@Nullable final Point point, @Nonnull final WriteOptions options);
9195

9296
/**
9397
* Write a list of {@link Point} to the InfluxDB server.
9498
*
9599
* @param points the list of {@link Point} to write, cannot be null
96-
* @apiNote the timestamp passed will be converted to nanoseconds since the Unix epoch by NanosecondConverter helper class
100+
* <p>
101+
* note: the timestamp passed will be converted to nanoseconds since the Unix epoch
102+
* by NanosecondConverter helper class
97103
*/
98104
void writePoints(@Nonnull final List<Point> points);
99105

@@ -102,7 +108,9 @@ public interface InfluxDBClient extends AutoCloseable {
102108
*
103109
* @param points the list of {@link Point} to write, cannot be null
104110
* @param options the options for writing data to InfluxDB
105-
* @apiNote the timestamp passed will be converted to nanoseconds since the Unix epoch by NanosecondConverter helper class
111+
* <p>
112+
* note: the timestamp passed will be converted to nanoseconds since the Unix epoch
113+
* by NanosecondConverter helper class
106114
*/
107115
void writePoints(@Nonnull final List<Point> points, @Nonnull final WriteOptions options);
108116

@@ -120,7 +128,8 @@ public interface InfluxDBClient extends AutoCloseable {
120128
*
121129
* @param query the SQL query string to execute, cannot be null
122130
* @return Batches of rows returned by the query
123-
* @apiNote the timestamp will be returned as a number of nanoseconds since the Unix epoch
131+
* <p>
132+
* note: the timestamp will be returned as a number of nanoseconds since the Unix epoch
124133
*/
125134
@Nonnull
126135
Stream<Object[]> query(@Nonnull final String query);
@@ -141,7 +150,8 @@ public interface InfluxDBClient extends AutoCloseable {
141150
* @param query the SQL query string to execute, cannot be null
142151
* @param parameters query named parameters
143152
* @return Batches of rows returned by the query
144-
* @apiNote the timestamp will be returned as a number of nanoseconds since the Unix epoch
153+
* <p>
154+
* note: the timestamp will be returned as a number of nanoseconds since the Unix epoch
145155
*/
146156
@Nonnull
147157
Stream<Object[]> query(@Nonnull final String query, @Nonnull final Map<String, Object> parameters);
@@ -161,7 +171,8 @@ public interface InfluxDBClient extends AutoCloseable {
161171
* @param query the query string to execute, cannot be null
162172
* @param options the options for querying data from InfluxDB
163173
* @return Batches of rows returned by the query
164-
* @apiNote the timestamp will be returned as a number of nanoseconds since the Unix epoch
174+
* <p>
175+
* note: the timestamp will be returned as a number of nanoseconds since the Unix epoch
165176
*/
166177
@Nonnull
167178
Stream<Object[]> query(@Nonnull final String query, @Nonnull final QueryOptions options);
@@ -183,7 +194,8 @@ public interface InfluxDBClient extends AutoCloseable {
183194
* @param parameters query named parameters
184195
* @param options the options for querying data from InfluxDB
185196
* @return Batches of rows returned by the query
186-
* @apiNote the timestamp will be returned as a number of nanoseconds since the Unix epoch
197+
* <p>
198+
* note: the timestamp will be returned as a number of nanoseconds since the Unix epoch
187199
*/
188200
@Nonnull
189201
Stream<Object[]> query(@Nonnull final String query,
@@ -204,7 +216,8 @@ Stream<Object[]> query(@Nonnull final String query,
204216
*
205217
* @param query the SQL query string to execute, cannot be null
206218
* @return Batches of PointValues returned by the query
207-
* @apiNote the timestamp will be returned as a number of nanoseconds since the Unix epoch
219+
* <p>
220+
* note: the timestamp will be returned as a number of nanoseconds since the Unix epoch
208221
*/
209222
@Nonnull
210223
Stream<PointValues> queryPoints(@Nonnull final String query);
@@ -225,7 +238,8 @@ Stream<Object[]> query(@Nonnull final String query,
225238
* @param query the SQL query string to execute, cannot be null
226239
* @param parameters query named parameters
227240
* @return Batches of PointValues returned by the query
228-
* @apiNote the timestamp will be returned as a number of nanoseconds since the Unix epoch
241+
* <p>
242+
* note: the timestamp will be returned as a number of nanoseconds since the Unix epoch
229243
*/
230244
@Nonnull
231245
Stream<PointValues> queryPoints(@Nonnull final String query, @Nonnull final Map<String, Object> parameters);
@@ -245,7 +259,8 @@ Stream<Object[]> query(@Nonnull final String query,
245259
* @param query the query string to execute, cannot be null
246260
* @param options the options for querying data from InfluxDB
247261
* @return Batches of PointValues returned by the query
248-
* @apiNote the timestamp will be returned as a number of nanoseconds since the Unix epoch
262+
* <p>
263+
* note: the timestamp will be returned as a number of nanoseconds since the Unix epoch
249264
*/
250265
@Nonnull
251266
Stream<PointValues> queryPoints(@Nonnull final String query, @Nonnull final QueryOptions options);
@@ -268,7 +283,8 @@ Stream<Object[]> query(@Nonnull final String query,
268283
* @param parameters query named parameters
269284
* @param options the options for querying data from InfluxDB
270285
* @return Batches of PointValues returned by the query
271-
* @apiNote the timestamp will be returned as a number of nanoseconds since the Unix epoch
286+
* <p>
287+
* note: the timestamp will be returned as a number of nanoseconds since the Unix epoch
272288
*/
273289
@Nonnull
274290
Stream<PointValues> queryPoints(@Nonnull final String query,

0 commit comments

Comments
 (0)