From 1a3dce15217b515ce761e3250200aea54ceda651 Mon Sep 17 00:00:00 2001 From: Nikita Koksharov Date: Fri, 1 Nov 2024 14:49:57 +0300 Subject: [PATCH] javadocs fixed --- .../redisson/api/stream/StreamAddArgs.java | 86 +++++++++---------- .../api/stream/StreamMultiReadArgs.java | 57 ++++++------ .../api/stream/StreamMultiReadGroupArgs.java | 57 ++++++------ .../redisson/api/stream/StreamReadArgs.java | 1 + .../api/stream/StreamReadGroupArgs.java | 7 +- 5 files changed, 106 insertions(+), 102 deletions(-) diff --git a/redisson/src/main/java/org/redisson/api/stream/StreamAddArgs.java b/redisson/src/main/java/org/redisson/api/stream/StreamAddArgs.java index f706d01bf..28b41f0e4 100644 --- a/redisson/src/main/java/org/redisson/api/stream/StreamAddArgs.java +++ b/redisson/src/main/java/org/redisson/api/stream/StreamAddArgs.java @@ -51,10 +51,10 @@ public interface StreamAddArgs { /** * Defines entry to add * - * @param k1 - key to add - * @param v1 - value to add - * @param - key type - * @param - value type + * @param k1 key to add + * @param v1 value to add + * @param key type + * @param value type * @return arguments object */ static StreamAddArgs entry(K k1, V v1) { @@ -64,12 +64,12 @@ public interface StreamAddArgs { /** * Defines entries to add * - * @param k1 - 1st key to add - * @param v1 - 1st value to add - * @param k2 - 2nd key to add - * @param v2 - 2nd value to add - * @param - key type - * @param - value type + * @param k1 1st key to add + * @param v1 1st value to add + * @param k2 2nd key to add + * @param v2 2nd value to add + * @param key type + * @param value type * @return arguments object */ static StreamAddArgs entries(K k1, V v1, K k2, V v2) { @@ -82,14 +82,14 @@ public interface StreamAddArgs { /** * Defines entries to add * - * @param k1 - 1st key to add - * @param v1 - 1st value to add - * @param k2 - 2nd key to add - * @param v2 - 2nd value to add - * @param k3 - 3rd key to add - * @param v3 - 3rd value to add - * @param - key type - * @param - value type + * @param k1 1st key to add + * @param v1 1st value to add + * @param k2 2nd key to add + * @param v2 2nd value to add + * @param k3 3rd key to add + * @param v3 3rd value to add + * @param key type + * @param value type * @return arguments object */ static StreamAddArgs entries(K k1, V v1, K k2, V v2, K k3, V v3) { @@ -103,16 +103,16 @@ public interface StreamAddArgs { /** * Defines entries to add * - * @param k1 - 1st key to add - * @param v1 - 1st value to add - * @param k2 - 2nd key to add - * @param v2 - 2nd value to add - * @param k3 - 3rd key to add - * @param v3 - 3rd value to add - * @param k4 - 4th key to add - * @param v4 - 4th key to add - * @param - key type - * @param - value type + * @param k1 1st key to add + * @param v1 1st value to add + * @param k2 2nd key to add + * @param v2 2nd value to add + * @param k3 3rd key to add + * @param v3 3rd value to add + * @param k4 4th key to add + * @param v4 4th key to add + * @param key type + * @param value type * @return arguments object */ static StreamAddArgs entries(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4) { @@ -127,18 +127,18 @@ public interface StreamAddArgs { /** * Defines entries to add * - * @param k1 - 1st key to add - * @param v1 - 1st value to add - * @param k2 - 2nd key to add - * @param v2 - 2nd value to add - * @param k3 - 3rd key to add - * @param v3 - 3rd value to add - * @param k4 - 4th key to add - * @param v4 - 4th key to add - * @param k5 - 5th key to add - * @param v5 - 5th key to add - * @param - key type - * @param - value type + * @param k1 1st key to add + * @param v1 1st value to add + * @param k2 2nd key to add + * @param v2 2nd value to add + * @param k3 3rd key to add + * @param v3 3rd value to add + * @param k4 4th key to add + * @param v4 4th key to add + * @param k5 5th key to add + * @param v5 5th key to add + * @param key type + * @param value type * @return arguments object */ static StreamAddArgs entries(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5) { @@ -154,9 +154,9 @@ public interface StreamAddArgs { /** * Defines entries to add * - * @param entries - entries map to add - * @param - key type - * @param - value type + * @param entries entries map to add + * @param key type + * @param value type * @return arguments object */ static StreamAddArgs entries(Map entries) { diff --git a/redisson/src/main/java/org/redisson/api/stream/StreamMultiReadArgs.java b/redisson/src/main/java/org/redisson/api/stream/StreamMultiReadArgs.java index 92741fd70..9a7cef66f 100644 --- a/redisson/src/main/java/org/redisson/api/stream/StreamMultiReadArgs.java +++ b/redisson/src/main/java/org/redisson/api/stream/StreamMultiReadArgs.java @@ -33,15 +33,16 @@ public interface StreamMultiReadArgs { /** * Defines stream data size limit. * - * @param count - stream data size limit + * @param count stream data size limit * @return arguments object */ StreamMultiReadArgs count(int count); /** * Defines time interval to wait for stream data availability. + * 0 is used to wait infinitely. * - * @param timeout - timeout duration + * @param timeout timeout duration * @return arguments object */ StreamMultiReadArgs timeout(Duration timeout); @@ -53,9 +54,9 @@ public interface StreamMultiReadArgs { * Read stream data from all defined streams * with ids greater than defined ids. * - * @param id1 - last stream id of current stream - * @param stream2 - name of 2nd stream - * @param id2 - last stream id of 2nd stream + * @param id1 last stream id of current stream + * @param stream2 name of 2nd stream + * @param id2 last stream id of 2nd stream * @return arguments object */ static StreamMultiReadArgs greaterThan(StreamMessageId id1, @@ -70,11 +71,11 @@ public interface StreamMultiReadArgs { * Read stream data from all defined streams * with ids greater than defined ids. * - * @param id1 - last stream id of current stream - * @param stream2 - name of 2nd stream - * @param id2 - last stream id of 2nd stream - * @param stream3 - name of 3rd stream - * @param id3 - last stream id of 3rd stream + * @param id1 last stream id of current stream + * @param stream2 name of 2nd stream + * @param id2 last stream id of 2nd stream + * @param stream3 name of 3rd stream + * @param id3 last stream id of 3rd stream * @return arguments object */ static StreamMultiReadArgs greaterThan(StreamMessageId id1, @@ -93,13 +94,13 @@ public interface StreamMultiReadArgs { * Read stream data from all defined streams * with ids greater than defined ids. * - * @param id1 - last stream id of current stream - * @param stream2 - name of 2nd stream - * @param id2 - last stream id of 2nd stream - * @param stream3 - name of 3rd stream - * @param id3 - last stream id of 3rd stream - * @param stream4 - name of 4th stream - * @param id4 - last stream id of 4th stream + * @param id1 last stream id of current stream + * @param stream2 name of 2nd stream + * @param id2 last stream id of 2nd stream + * @param stream3 name of 3rd stream + * @param id3 last stream id of 3rd stream + * @param stream4 name of 4th stream + * @param id4 last stream id of 4th stream * @return arguments object */ static StreamMultiReadArgs greaterThan(StreamMessageId id1, @@ -120,15 +121,15 @@ public interface StreamMultiReadArgs { * Read stream data from all defined streams * with ids greater than defined ids. * - * @param id1 - last stream id of current stream - * @param stream2 - name of 2nd stream - * @param id2 - last stream id of 2nd stream - * @param stream3 - name of 3rd stream - * @param id3 - last stream id of 3rd stream - * @param stream4 - name of 4th stream - * @param id4 - last stream id of 4th stream - * @param stream5 - name of 4th stream - * @param id5 - last stream id of 4th stream + * @param id1 last stream id of current stream + * @param stream2 name of 2nd stream + * @param id2 last stream id of 2nd stream + * @param stream3 name of 3rd stream + * @param id3 last stream id of 3rd stream + * @param stream4 name of 4th stream + * @param id4 last stream id of 4th stream + * @param stream5 name of 4th stream + * @param id5 last stream id of 4th stream * @return arguments object */ static StreamMultiReadArgs greaterThan(StreamMessageId id1, @@ -151,8 +152,8 @@ public interface StreamMultiReadArgs { * Read stream data from all defined streams * with ids greater than defined ids. * - * @param id1 - last stream id of current stream - * @param offsets - last stream id mapped by stream name + * @param id1 last stream id of current stream + * @param offsets last stream id mapped by stream name * @return arguments object */ static StreamMultiReadArgs greaterThan(StreamMessageId id1, Map offsets) { diff --git a/redisson/src/main/java/org/redisson/api/stream/StreamMultiReadGroupArgs.java b/redisson/src/main/java/org/redisson/api/stream/StreamMultiReadGroupArgs.java index 9ac15be4c..e8410b7c1 100644 --- a/redisson/src/main/java/org/redisson/api/stream/StreamMultiReadGroupArgs.java +++ b/redisson/src/main/java/org/redisson/api/stream/StreamMultiReadGroupArgs.java @@ -40,15 +40,16 @@ public interface StreamMultiReadGroupArgs { /** * Defines stream data size limit. * - * @param count - stream data size limit + * @param count stream data size limit * @return arguments object */ StreamMultiReadGroupArgs count(int count); /** * Defines time interval to wait for stream data availability. + * 0 is used to wait infinitely. * - * @param timeout - timeout duration + * @param timeout timeout duration * @return arguments object */ StreamMultiReadGroupArgs timeout(Duration timeout); @@ -57,9 +58,9 @@ public interface StreamMultiReadGroupArgs { * Defines to return messages of all Streams * with ids greater than defined message ids. * - * @param id1 - last stream id of current stream - * @param stream2 - name of 2nd stream - * @param id2 - last stream id of 2nd stream + * @param id1 last stream id of current stream + * @param stream2 name of 2nd stream + * @param id2 last stream id of 2nd stream * @return arguments object */ static StreamMultiReadGroupArgs greaterThan(StreamMessageId id1, @@ -71,11 +72,11 @@ public interface StreamMultiReadGroupArgs { * Defines to return messages of all Streams * with ids greater than defined message ids. * - * @param id1 - last stream id of current stream - * @param stream2 - name of 2nd stream - * @param id2 - last stream id of 2nd stream - * @param stream3 - name of 3rd stream - * @param id3 - last stream id of 3rd stream + * @param id1 last stream id of current stream + * @param stream2 name of 2nd stream + * @param id2 last stream id of 2nd stream + * @param stream3 name of 3rd stream + * @param id3 last stream id of 3rd stream * @return arguments object */ static StreamMultiReadGroupArgs greaterThan(StreamMessageId id1, @@ -91,13 +92,13 @@ public interface StreamMultiReadGroupArgs { * Defines to return messages of all Streams * with ids greater than defined message ids. * - * @param id1 - last stream id of current stream - * @param stream2 - name of 2nd stream - * @param id2 - last stream id of 2nd stream - * @param stream3 - name of 3rd stream - * @param id3 - last stream id of 3rd stream - * @param stream4 - name of 4th stream - * @param id4 - last stream id of 4th stream + * @param id1 last stream id of current stream + * @param stream2 name of 2nd stream + * @param id2 last stream id of 2nd stream + * @param stream3 name of 3rd stream + * @param id3 last stream id of 3rd stream + * @param stream4 name of 4th stream + * @param id4 last stream id of 4th stream * @return arguments object */ static StreamMultiReadGroupArgs greaterThan(StreamMessageId id1, @@ -115,15 +116,15 @@ public interface StreamMultiReadGroupArgs { * Defines to return messages of all Streams * with ids greater than defined message ids. * - * @param id1 - last stream id of current stream - * @param stream2 - name of 2nd stream - * @param id2 - last stream id of 2nd stream - * @param stream3 - name of 3rd stream - * @param id3 - last stream id of 3rd stream - * @param stream4 - name of 4th stream - * @param id4 - last stream id of 4th stream - * @param stream5 - name of 4th stream - * @param id5 - last stream id of 4th stream + * @param id1 last stream id of current stream + * @param stream2 name of 2nd stream + * @param id2 last stream id of 2nd stream + * @param stream3 name of 3rd stream + * @param id3 last stream id of 3rd stream + * @param stream4 name of 4th stream + * @param id4 last stream id of 4th stream + * @param stream5 name of 4th stream + * @param id5 last stream id of 4th stream * @return arguments object */ static StreamMultiReadGroupArgs greaterThan(StreamMessageId id1, @@ -143,8 +144,8 @@ public interface StreamMultiReadGroupArgs { * Defines to return messages of all Streams * with ids greater than defined message ids. * - * @param id - last stream id of current stream - * @param offsets - last stream id mapped by stream name + * @param id last stream id of current stream + * @param offsets last stream id mapped by stream name * @return arguments object */ static StreamMultiReadGroupArgs greaterThan(StreamMessageId id, Map offsets) { diff --git a/redisson/src/main/java/org/redisson/api/stream/StreamReadArgs.java b/redisson/src/main/java/org/redisson/api/stream/StreamReadArgs.java index 6119e3d25..a67f0a1a5 100644 --- a/redisson/src/main/java/org/redisson/api/stream/StreamReadArgs.java +++ b/redisson/src/main/java/org/redisson/api/stream/StreamReadArgs.java @@ -37,6 +37,7 @@ public interface StreamReadArgs { /** * Defines time interval to wait for stream data availability. + * 0 is used to wait infinitely. * * @param timeout timeout duration * @return arguments object diff --git a/redisson/src/main/java/org/redisson/api/stream/StreamReadGroupArgs.java b/redisson/src/main/java/org/redisson/api/stream/StreamReadGroupArgs.java index 722f126c0..a72735681 100644 --- a/redisson/src/main/java/org/redisson/api/stream/StreamReadGroupArgs.java +++ b/redisson/src/main/java/org/redisson/api/stream/StreamReadGroupArgs.java @@ -37,15 +37,16 @@ public interface StreamReadGroupArgs { /** * Defines stream data size limit. * - * @param count - stream data size limit + * @param count stream data size limit * @return arguments object */ StreamReadGroupArgs count(int count); /** * Defines time interval to wait for stream data availability. + * 0 is used to wait infinitely. * - * @param timeout - timeout duration + * @param timeout timeout duration * @return arguments object */ StreamReadGroupArgs timeout(Duration timeout); @@ -64,7 +65,7 @@ public interface StreamReadGroupArgs { * Defines to return messages of current Stream * with ids greater than defined message id. * - * @param id - message id + * @param id message id * @return arguments object */ static StreamReadGroupArgs greaterThan(StreamMessageId id) {