github-forks
/
redisson
mirror of https://github.com/redisson/redisson.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

javadocs fixed

Browse Source
pull/6262/head
Nikita Koksharov 3 months ago
parent a362296c80
commit 1a3dce1521
5 changed files with 106 additions and 102 deletions
Show Stats Download Patch File Download Diff File

86
redisson/src/main/java/org/redisson/api/stream/StreamAddArgs.java
Unescape Escape View File

@ -51,10 +51,10 @@ public interface StreamAddArgs<K, V> {
/** /**
* Defines entry to add * Defines entry to add
* *
* @param k1 - key to add * @param k1 key to add
* @param v1 - value to add * @param v1 value to add
* @param <K> - key type * @param <K> key type
* @param <V> - value type * @param <V> value type
* @return arguments object * @return arguments object
*/ */
static <K, V> StreamAddArgs<K, V> entry(K k1, V v1) { static <K, V> StreamAddArgs<K, V> entry(K k1, V v1) {
@ -64,12 +64,12 @@ public interface StreamAddArgs<K, V> {
/** /**
* Defines entries to add * Defines entries to add
* *
* @param k1 - 1st key to add * @param k1 1st key to add
* @param v1 - 1st value to add * @param v1 1st value to add
* @param k2 - 2nd key to add * @param k2 2nd key to add
* @param v2 - 2nd value to add * @param v2 2nd value to add
* @param <K> - key type * @param <K> key type
* @param <V> - value type * @param <V> value type
* @return arguments object * @return arguments object
*/ */
static <K, V> StreamAddArgs<K, V> entries(K k1, V v1, K k2, V v2) { static <K, V> StreamAddArgs<K, V> entries(K k1, V v1, K k2, V v2) {
@ -82,14 +82,14 @@ public interface StreamAddArgs<K, V> {
/** /**
* Defines entries to add * Defines entries to add
* *
* @param k1 - 1st key to add * @param k1 1st key to add
* @param v1 - 1st value to add * @param v1 1st value to add
* @param k2 - 2nd key to add * @param k2 2nd key to add
* @param v2 - 2nd value to add * @param v2 2nd value to add
* @param k3 - 3rd key to add * @param k3 3rd key to add
* @param v3 - 3rd value to add * @param v3 3rd value to add
* @param <K> - key type * @param <K> key type
* @param <V> - value type * @param <V> value type
* @return arguments object * @return arguments object
*/ */
static <K, V> StreamAddArgs<K, V> entries(K k1, V v1, K k2, V v2, K k3, V v3) { static <K, V> StreamAddArgs<K, V> entries(K k1, V v1, K k2, V v2, K k3, V v3) {
@ -103,16 +103,16 @@ public interface StreamAddArgs<K, V> {
/** /**
* Defines entries to add * Defines entries to add
* *
* @param k1 - 1st key to add * @param k1 1st key to add
* @param v1 - 1st value to add * @param v1 1st value to add
* @param k2 - 2nd key to add * @param k2 2nd key to add
* @param v2 - 2nd value to add * @param v2 2nd value to add
* @param k3 - 3rd key to add * @param k3 3rd key to add
* @param v3 - 3rd value to add * @param v3 3rd value to add
* @param k4 - 4th key to add * @param k4 4th key to add
* @param v4 - 4th key to add * @param v4 4th key to add
* @param <K> - key type * @param <K> key type
* @param <V> - value type * @param <V> value type
* @return arguments object * @return arguments object
*/ */
static <K, V> StreamAddArgs<K, V> entries(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4) { static <K, V> StreamAddArgs<K, V> entries(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4) {
@ -127,18 +127,18 @@ public interface StreamAddArgs<K, V> {
/** /**
* Defines entries to add * Defines entries to add
* *
* @param k1 - 1st key to add * @param k1 1st key to add
* @param v1 - 1st value to add * @param v1 1st value to add
* @param k2 - 2nd key to add * @param k2 2nd key to add
* @param v2 - 2nd value to add * @param v2 2nd value to add
* @param k3 - 3rd key to add * @param k3 3rd key to add
* @param v3 - 3rd value to add * @param v3 3rd value to add
* @param k4 - 4th key to add * @param k4 4th key to add
* @param v4 - 4th key to add * @param v4 4th key to add
* @param k5 - 5th key to add * @param k5 5th key to add
* @param v5 - 5th key to add * @param v5 5th key to add
* @param <K> - key type * @param <K> key type
* @param <V> - value type * @param <V> value type
* @return arguments object * @return arguments object
*/ */
static <K, V> StreamAddArgs<K, V> entries(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5) { static <K, V> StreamAddArgs<K, V> 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<K, V> {
/** /**
* Defines entries to add * Defines entries to add
* *
* @param entries - entries map to add * @param entries entries map to add
* @param <K> - key type * @param <K> key type
* @param <V> - value type * @param <V> value type
* @return arguments object * @return arguments object
*/ */
static <K, V> StreamAddArgs<K, V> entries(Map<K, V> entries) { static <K, V> StreamAddArgs<K, V> entries(Map<K, V> entries) {

57
redisson/src/main/java/org/redisson/api/stream/StreamMultiReadArgs.java
Unescape Escape View File

@ -33,15 +33,16 @@ public interface StreamMultiReadArgs {
/** /**
* Defines stream data size limit. * Defines stream data size limit.
* *
* @param count - stream data size limit * @param count stream data size limit
* @return arguments object * @return arguments object
*/ */
StreamMultiReadArgs count(int count); StreamMultiReadArgs count(int count);
/** /**
* Defines time interval to wait for stream data availability. * Defines time interval to wait for stream data availability.
* <code>0</code> is used to wait infinitely.
* *
* @param timeout - timeout duration * @param timeout timeout duration
* @return arguments object * @return arguments object
*/ */
StreamMultiReadArgs timeout(Duration timeout); StreamMultiReadArgs timeout(Duration timeout);
@ -53,9 +54,9 @@ public interface StreamMultiReadArgs {
* Read stream data from all defined streams * Read stream data from all defined streams
* with ids greater than defined ids. * with ids greater than defined ids.
* *
* @param id1 - last stream id of current stream * @param id1 last stream id of current stream
* @param stream2 - name of 2nd stream * @param stream2 name of 2nd stream
* @param id2 - last stream id of 2nd stream * @param id2 last stream id of 2nd stream
* @return arguments object * @return arguments object
*/ */
static StreamMultiReadArgs greaterThan(StreamMessageId id1, static StreamMultiReadArgs greaterThan(StreamMessageId id1,
@ -70,11 +71,11 @@ public interface StreamMultiReadArgs {
* Read stream data from all defined streams * Read stream data from all defined streams
* with ids greater than defined ids. * with ids greater than defined ids.
* *
* @param id1 - last stream id of current stream * @param id1 last stream id of current stream
* @param stream2 - name of 2nd stream * @param stream2 name of 2nd stream
* @param id2 - last stream id of 2nd stream * @param id2 last stream id of 2nd stream
* @param stream3 - name of 3rd stream * @param stream3 name of 3rd stream
* @param id3 - last stream id of 3rd stream * @param id3 last stream id of 3rd stream
* @return arguments object * @return arguments object
*/ */
static StreamMultiReadArgs greaterThan(StreamMessageId id1, static StreamMultiReadArgs greaterThan(StreamMessageId id1,
@ -93,13 +94,13 @@ public interface StreamMultiReadArgs {
* Read stream data from all defined streams * Read stream data from all defined streams
* with ids greater than defined ids. * with ids greater than defined ids.
* *
* @param id1 - last stream id of current stream * @param id1 last stream id of current stream
* @param stream2 - name of 2nd stream * @param stream2 name of 2nd stream
* @param id2 - last stream id of 2nd stream * @param id2 last stream id of 2nd stream
* @param stream3 - name of 3rd stream * @param stream3 name of 3rd stream
* @param id3 - last stream id of 3rd stream * @param id3 last stream id of 3rd stream
* @param stream4 - name of 4th stream * @param stream4 name of 4th stream
* @param id4 - last stream id of 4th stream * @param id4 last stream id of 4th stream
* @return arguments object * @return arguments object
*/ */
static StreamMultiReadArgs greaterThan(StreamMessageId id1, static StreamMultiReadArgs greaterThan(StreamMessageId id1,
@ -120,15 +121,15 @@ public interface StreamMultiReadArgs {
* Read stream data from all defined streams * Read stream data from all defined streams
* with ids greater than defined ids. * with ids greater than defined ids.
* *
* @param id1 - last stream id of current stream * @param id1 last stream id of current stream
* @param stream2 - name of 2nd stream * @param stream2 name of 2nd stream
* @param id2 - last stream id of 2nd stream * @param id2 last stream id of 2nd stream
* @param stream3 - name of 3rd stream * @param stream3 name of 3rd stream
* @param id3 - last stream id of 3rd stream * @param id3 last stream id of 3rd stream
* @param stream4 - name of 4th stream * @param stream4 name of 4th stream
* @param id4 - last stream id of 4th stream * @param id4 last stream id of 4th stream
* @param stream5 - name of 4th stream * @param stream5 name of 4th stream
* @param id5 - last stream id of 4th stream * @param id5 last stream id of 4th stream
* @return arguments object * @return arguments object
*/ */
static StreamMultiReadArgs greaterThan(StreamMessageId id1, static StreamMultiReadArgs greaterThan(StreamMessageId id1,
@ -151,8 +152,8 @@ public interface StreamMultiReadArgs {
* Read stream data from all defined streams * Read stream data from all defined streams
* with ids greater than defined ids. * with ids greater than defined ids.
* *
* @param id1 - last stream id of current stream * @param id1 last stream id of current stream
* @param offsets - last stream id mapped by stream name * @param offsets last stream id mapped by stream name
* @return arguments object * @return arguments object
*/ */
static StreamMultiReadArgs greaterThan(StreamMessageId id1, Map<String, StreamMessageId> offsets) { static StreamMultiReadArgs greaterThan(StreamMessageId id1, Map<String, StreamMessageId> offsets) {

57
redisson/src/main/java/org/redisson/api/stream/StreamMultiReadGroupArgs.java
Unescape Escape View File

@ -40,15 +40,16 @@ public interface StreamMultiReadGroupArgs {
/** /**
* Defines stream data size limit. * Defines stream data size limit.
* *
* @param count - stream data size limit * @param count stream data size limit
* @return arguments object * @return arguments object
*/ */
StreamMultiReadGroupArgs count(int count); StreamMultiReadGroupArgs count(int count);
/** /**
* Defines time interval to wait for stream data availability. * Defines time interval to wait for stream data availability.
* <code>0</code> is used to wait infinitely.
* *
* @param timeout - timeout duration * @param timeout timeout duration
* @return arguments object * @return arguments object
*/ */
StreamMultiReadGroupArgs timeout(Duration timeout); StreamMultiReadGroupArgs timeout(Duration timeout);
@ -57,9 +58,9 @@ public interface StreamMultiReadGroupArgs {
* Defines to return messages of all Streams * Defines to return messages of all Streams
* with ids greater than defined message ids. * with ids greater than defined message ids.
* *
* @param id1 - last stream id of current stream * @param id1 last stream id of current stream
* @param stream2 - name of 2nd stream * @param stream2 name of 2nd stream
* @param id2 - last stream id of 2nd stream * @param id2 last stream id of 2nd stream
* @return arguments object * @return arguments object
*/ */
static StreamMultiReadGroupArgs greaterThan(StreamMessageId id1, static StreamMultiReadGroupArgs greaterThan(StreamMessageId id1,
@ -71,11 +72,11 @@ public interface StreamMultiReadGroupArgs {
* Defines to return messages of all Streams * Defines to return messages of all Streams
* with ids greater than defined message ids. * with ids greater than defined message ids.
* *
* @param id1 - last stream id of current stream * @param id1 last stream id of current stream
* @param stream2 - name of 2nd stream * @param stream2 name of 2nd stream
* @param id2 - last stream id of 2nd stream * @param id2 last stream id of 2nd stream
* @param stream3 - name of 3rd stream * @param stream3 name of 3rd stream
* @param id3 - last stream id of 3rd stream * @param id3 last stream id of 3rd stream
* @return arguments object * @return arguments object
*/ */
static StreamMultiReadGroupArgs greaterThan(StreamMessageId id1, static StreamMultiReadGroupArgs greaterThan(StreamMessageId id1,
@ -91,13 +92,13 @@ public interface StreamMultiReadGroupArgs {
* Defines to return messages of all Streams * Defines to return messages of all Streams
* with ids greater than defined message ids. * with ids greater than defined message ids.
* *
* @param id1 - last stream id of current stream * @param id1 last stream id of current stream
* @param stream2 - name of 2nd stream * @param stream2 name of 2nd stream
* @param id2 - last stream id of 2nd stream * @param id2 last stream id of 2nd stream
* @param stream3 - name of 3rd stream * @param stream3 name of 3rd stream
* @param id3 - last stream id of 3rd stream * @param id3 last stream id of 3rd stream
* @param stream4 - name of 4th stream * @param stream4 name of 4th stream
* @param id4 - last stream id of 4th stream * @param id4 last stream id of 4th stream
* @return arguments object * @return arguments object
*/ */
static StreamMultiReadGroupArgs greaterThan(StreamMessageId id1, static StreamMultiReadGroupArgs greaterThan(StreamMessageId id1,
@ -115,15 +116,15 @@ public interface StreamMultiReadGroupArgs {
* Defines to return messages of all Streams * Defines to return messages of all Streams
* with ids greater than defined message ids. * with ids greater than defined message ids.
* *
* @param id1 - last stream id of current stream * @param id1 last stream id of current stream
* @param stream2 - name of 2nd stream * @param stream2 name of 2nd stream
* @param id2 - last stream id of 2nd stream * @param id2 last stream id of 2nd stream
* @param stream3 - name of 3rd stream * @param stream3 name of 3rd stream
* @param id3 - last stream id of 3rd stream * @param id3 last stream id of 3rd stream
* @param stream4 - name of 4th stream * @param stream4 name of 4th stream
* @param id4 - last stream id of 4th stream * @param id4 last stream id of 4th stream
* @param stream5 - name of 4th stream * @param stream5 name of 4th stream
* @param id5 - last stream id of 4th stream * @param id5 last stream id of 4th stream
* @return arguments object * @return arguments object
*/ */
static StreamMultiReadGroupArgs greaterThan(StreamMessageId id1, static StreamMultiReadGroupArgs greaterThan(StreamMessageId id1,
@ -143,8 +144,8 @@ public interface StreamMultiReadGroupArgs {
* Defines to return messages of all Streams * Defines to return messages of all Streams
* with ids greater than defined message ids. * with ids greater than defined message ids.
* *
* @param id - last stream id of current stream * @param id last stream id of current stream
* @param offsets - last stream id mapped by stream name * @param offsets last stream id mapped by stream name
* @return arguments object * @return arguments object
*/ */
static StreamMultiReadGroupArgs greaterThan(StreamMessageId id, Map<String, StreamMessageId> offsets) { static StreamMultiReadGroupArgs greaterThan(StreamMessageId id, Map<String, StreamMessageId> offsets) {

1
redisson/src/main/java/org/redisson/api/stream/StreamReadArgs.java
Unescape Escape View File

@ -37,6 +37,7 @@ public interface StreamReadArgs {
/** /**
* Defines time interval to wait for stream data availability. * Defines time interval to wait for stream data availability.
* <code>0</code> is used to wait infinitely.
* *
* @param timeout timeout duration * @param timeout timeout duration
* @return arguments object * @return arguments object

7
redisson/src/main/java/org/redisson/api/stream/StreamReadGroupArgs.java
Unescape Escape View File

@ -37,15 +37,16 @@ public interface StreamReadGroupArgs {
/** /**
* Defines stream data size limit. * Defines stream data size limit.
* *
* @param count - stream data size limit * @param count stream data size limit
* @return arguments object * @return arguments object
*/ */
StreamReadGroupArgs count(int count); StreamReadGroupArgs count(int count);
/** /**
* Defines time interval to wait for stream data availability. * Defines time interval to wait for stream data availability.
* <code>0</code> is used to wait infinitely.
* *
* @param timeout - timeout duration * @param timeout timeout duration
* @return arguments object * @return arguments object
*/ */
StreamReadGroupArgs timeout(Duration timeout); StreamReadGroupArgs timeout(Duration timeout);
@ -64,7 +65,7 @@ public interface StreamReadGroupArgs {
* Defines to return messages of current Stream * Defines to return messages of current Stream
* with ids greater than defined message id. * with ids greater than defined message id.
* *
* @param id - message id * @param id message id
* @return arguments object * @return arguments object
*/ */
static StreamReadGroupArgs greaterThan(StreamMessageId id) { static StreamReadGroupArgs greaterThan(StreamMessageId id) {

Write Preview
Loading…
Cancel
Save