diff --git a/redisson/src/main/java/org/redisson/RedissonFairLock.java b/redisson/src/main/java/org/redisson/RedissonFairLock.java
index 14e23e2b7..73dd905fe 100644
--- a/redisson/src/main/java/org/redisson/RedissonFairLock.java
+++ b/redisson/src/main/java/org/redisson/RedissonFairLock.java
@@ -32,7 +32,7 @@ import org.redisson.pubsub.LockPubSub;
* Distributed implementation of {@link java.util.concurrent.locks.Lock}
* Implements reentrant lock.
* Lock will be removed automatically if client disconnects.
- *
+ *
* Implements a fair locking so it guarantees an acquire order by threads.
*
* @author Nikita Koksharov
diff --git a/redisson/src/main/java/org/redisson/RedissonLock.java b/redisson/src/main/java/org/redisson/RedissonLock.java
index 1f600951f..d1a7e7baa 100644
--- a/redisson/src/main/java/org/redisson/RedissonLock.java
+++ b/redisson/src/main/java/org/redisson/RedissonLock.java
@@ -46,7 +46,7 @@ import io.netty.util.internal.PlatformDependent;
* Distributed implementation of {@link java.util.concurrent.locks.Lock}
* Implements reentrant lock.
* Lock will be removed automatically if client disconnects.
- *
+ *
* Implements a non-fair locking so doesn't guarantees an acquire order.
*
* @author Nikita Koksharov
diff --git a/redisson/src/main/java/org/redisson/RedissonSemaphore.java b/redisson/src/main/java/org/redisson/RedissonSemaphore.java
index 15579f404..bef6d3636 100644
--- a/redisson/src/main/java/org/redisson/RedissonSemaphore.java
+++ b/redisson/src/main/java/org/redisson/RedissonSemaphore.java
@@ -38,7 +38,7 @@ import io.netty.util.concurrent.FutureListener;
/**
* Distributed and concurrent implementation of {@link java.util.concurrent.Semaphore}.
- *
+ *
* Works in non-fair mode. Therefore order of acquiring is unpredictable.
*
* @author Nikita Koksharov
diff --git a/redisson/src/main/java/org/redisson/api/LocalCachedMapOptions.java b/redisson/src/main/java/org/redisson/api/LocalCachedMapOptions.java
index 62d76a4a1..8e3f72e26 100644
--- a/redisson/src/main/java/org/redisson/api/LocalCachedMapOptions.java
+++ b/redisson/src/main/java/org/redisson/api/LocalCachedMapOptions.java
@@ -46,7 +46,7 @@ public class LocalCachedMapOptions {
/**
* Creates a new instance of LocalCachedMapOptions with default options.
- *
+ *
* This is equivalent to:
*
* new LocalCachedMapOptions()
@@ -54,6 +54,9 @@ public class LocalCachedMapOptions {
* .evictionPolicy(EvictionPolicy.NONE)
* .invalidateEntryOnChange(true);
*
+ *
+ * @return LocalCachedMapOptions instance
+ *
*/
public static LocalCachedMapOptions defaults() {
return new LocalCachedMapOptions()
@@ -85,8 +88,8 @@ public class LocalCachedMapOptions {
/**
* Sets cache size. If size is 0
then cache is unbounded.
*
- * @param cacheSize
- * @return
+ * @param cacheSize - size of cache
+ * @return LocalCachedMapOptions instance
*/
public LocalCachedMapOptions cacheSize(int cacheSize) {
this.cacheSize = cacheSize;
@@ -99,7 +102,7 @@ public class LocalCachedMapOptions {
* @param value - if true
then invalidation message which removes corresponding entry from cache
* will be sent to all other RLocalCachedMap instances on each entry update/remove operation.
* if false
then invalidation message won't be sent
- * @return
+ * @return LocalCachedMapOptions instance
*/
public LocalCachedMapOptions invalidateEntryOnChange(boolean value) {
this.invalidateEntryOnChange = value;
@@ -113,7 +116,7 @@ public class LocalCachedMapOptions {
* LRU
- uses cache with LRU (least recently used) eviction policy.
*
LFU
- uses cache with LFU (least frequently used) eviction policy.
*
NONE
- doesn't use eviction policy, but timeToLive and maxIdleTime params are still working.
- * @return
+ * @return LocalCachedMapOptions instance
*/
public LocalCachedMapOptions evictionPolicy(EvictionPolicy evictionPolicy) {
if (evictionPolicy == null) {
@@ -125,10 +128,10 @@ public class LocalCachedMapOptions {
/**
* Sets time to live in milliseconds for each map entry in cache.
- * If value equals to 0 then timeout is not applied
+ * If value equals to 0
then timeout is not applied
*
- * @param timeToLiveInMillis
- * @return
+ * @param timeToLiveInMillis - time to live in milliseconds
+ * @return LocalCachedMapOptions instance
*/
public LocalCachedMapOptions timeToLive(long timeToLiveInMillis) {
this.timeToLiveInMillis = timeToLiveInMillis;
@@ -137,11 +140,11 @@ public class LocalCachedMapOptions {
/**
* Sets time to live for each map entry in cache.
- * If value equals to 0 then timeout is not applied
+ * If value equals to 0
then timeout is not applied
*
- * @param timeToLive
- * @param timeUnit
- * @return
+ * @param timeToLive - time to live
+ * @param timeUnit - time unit
+ * @return LocalCachedMapOptions instance
*/
public LocalCachedMapOptions timeToLive(long timeToLive, TimeUnit timeUnit) {
return timeToLive(timeUnit.toMillis(timeToLive));
@@ -149,10 +152,10 @@ public class LocalCachedMapOptions {
/**
* Sets max idle time in milliseconds for each map entry in cache.
- * If value equals to 0 then timeout is not applied
+ * If value equals to 0
then timeout is not applied
*
- * @param maxIdleInMillis
- * @return
+ * @param maxIdleInMillis - time to live in milliseconds
+ * @return LocalCachedMapOptions instance
*/
public LocalCachedMapOptions maxIdle(long maxIdleInMillis) {
this.maxIdleInMillis = maxIdleInMillis;
@@ -161,10 +164,11 @@ public class LocalCachedMapOptions {
/**
* Sets max idle time for each map entry in cache.
- * If value equals to 0 then timeout is not applied
+ * If value equals to 0
then timeout is not applied
*
- * @param maxIdleInMillis
- * @return
+ * @param maxIdle - max idle time
+ * @param timeUnit - time unit
+ * @return LocalCachedMapOptions instance
*/
public LocalCachedMapOptions maxIdle(long maxIdle, TimeUnit timeUnit) {
return timeToLive(timeUnit.toMillis(maxIdle));
diff --git a/redisson/src/main/java/org/redisson/api/Node.java b/redisson/src/main/java/org/redisson/api/Node.java
index 208e00197..0f1ed2541 100644
--- a/redisson/src/main/java/org/redisson/api/Node.java
+++ b/redisson/src/main/java/org/redisson/api/Node.java
@@ -28,16 +28,14 @@ public interface Node {
/**
* Returns node type
*
- * @see {@link NodeType}
- *
- * @return
+ * @return node type
*/
NodeType getType();
/**
* Get Redis node address
*
- * @return
+ * @return node address
*/
InetSocketAddress getAddr();
diff --git a/redisson/src/main/java/org/redisson/api/NodesGroup.java b/redisson/src/main/java/org/redisson/api/NodesGroup.java
index 7a73d741e..4b9c0cf98 100644
--- a/redisson/src/main/java/org/redisson/api/NodesGroup.java
+++ b/redisson/src/main/java/org/redisson/api/NodesGroup.java
@@ -30,24 +30,23 @@ public interface NodesGroup {
* Adds connection listener which will be triggered
* when Redisson has just been connected to or disconnected from redis server
*
- * @param connectionListener
+ * @param connectionListener - connection listener
+ * @return id of listener
*/
int addConnectionListener(ConnectionListener connectionListener);
/**
* Removes connection listener by id
*
- * @param listenerId
+ * @param listenerId - id of connection listener
*/
void removeConnectionListener(int listenerId);
/**
* Get all nodes by type
*
- * @see {@link NodeType}
- *
- * @param type
- * @return
+ * @param type - type of node
+ * @return collection of nodes
*/
Collection getNodes(NodeType type);
@@ -55,7 +54,7 @@ public interface NodesGroup {
* All Redis nodes used by Redisson.
* This collection may change during master change, cluster topology update and etc.
*
- * @return
+ * @return collection of nodes
*/
Collection getNodes();
diff --git a/redisson/src/main/java/org/redisson/api/RBatch.java b/redisson/src/main/java/org/redisson/api/RBatch.java
index 94d693379..32868333c 100644
--- a/redisson/src/main/java/org/redisson/api/RBatch.java
+++ b/redisson/src/main/java/org/redisson/api/RBatch.java
@@ -22,11 +22,11 @@ import org.redisson.client.codec.Codec;
/**
* Interface for using pipeline feature.
- *
+ *
* All method invocations on objects
* from this interface are batched to separate queue and could be executed later
* with execute()
or executeAsync()
methods.
- *
+ *
* Please be ware, atomicity is not guaranteed.
*
*
@@ -38,8 +38,9 @@ public interface RBatch {
/**
* Returns geospatial items holder instance by name
.
*
- * @param name
- * @return
+ * @param type of object
+ * @param name - name of object
+ * @return Geo object
*/
RGeoAsync getGeo(String name);
@@ -47,27 +48,32 @@ public interface RBatch {
* Returns geospatial items holder instance by name
* using provided codec for geospatial members.
*
- * @param name
- * @param geospatial member codec
- * @return
+ * @param type of value
+ * @param name - name of object
+ * @param codec - codec for value
+ * @return Geo object
*/
RGeoAsync getGeo(String name, Codec codec);
/**
* Returns Set based MultiMap instance by name.
*
- * @param name
- * @return
+ * @param type of key
+ * @param type of value
+ * @param name - name of object
+ * @return Multimap object
*/
RMultimapAsync getSetMultimap(String name);
/**
* Returns Set based MultiMap instance by name
* using provided codec for both map keys and values.
- *
- * @param name
- * @param codec
- * @return
+ *
+ * @param type of key
+ * @param type of value
+ * @param name - name of object
+ * @param codec - provided codec
+ * @return Multimap object
*/
RMultimapAsync getSetMultimap(String name, Codec codec);
@@ -77,8 +83,10 @@ public interface RBatch {
*
* If eviction is not required then it's better to use regular map {@link #getSetMultimap(String)}.
*
- * @param name
- * @return
+ * @param type of key
+ * @param type of value
+ * @param name - name of object
+ * @return SetMultimapCache object
*/
RMultimapCacheAsync getSetMultimapCache(String name);
@@ -89,8 +97,11 @@ public interface RBatch {
*
* If eviction is not required then it's better to use regular map {@link #getSetMultimap(String, Codec)}.
*
- * @param name
- * @return
+ * @param type of key
+ * @param type of value
+ * @param name - name of object
+ * @param codec - provided codec
+ * @return SetMultimapCache object
*/
RMultimapCacheAsync getSetMultimapCache(String name, Codec codec);
@@ -101,9 +112,9 @@ public interface RBatch {
*
* If eviction is not required then it's better to use regular map {@link #getSet(String, Codec)}.
*
- * @param name
- * @param codec
- * @return
+ * @param type of value
+ * @param name - name of object
+ * @return SetCache object
*/
RSetCacheAsync getSetCache(String name);
@@ -115,9 +126,10 @@ public interface RBatch {
*
* If eviction is not required then it's better to use regular map {@link #getSet(String, Codec)}.
*
- * @param name
- * @param codec
- * @return
+ * @param type of value
+ * @param name - name of object
+ * @param codec - codec for values
+ * @return SetCache object
*/
RSetCacheAsync getSetCache(String name, Codec codec);
@@ -128,9 +140,11 @@ public interface RBatch {
*
* If eviction is not required then it's better to use regular map {@link #getMap(String, Codec)}.
*
- * @param name
- * @param codec
- * @return
+ * @param type of key
+ * @param type of value
+ * @param name - name of object
+ * @param codec - codec for keys and values
+ * @return MapCache object
*/
RMapCacheAsync getMapCache(String name, Codec codec);
@@ -140,16 +154,19 @@ public interface RBatch {
*
* If eviction is not required then it's better to use regular map {@link #getMap(String)}.
*
- * @param name
- * @return
+ * @param type of key
+ * @param type of value
+ * @param name - name of object
+ * @return MapCache object
*/
RMapCacheAsync getMapCache(String name);
/**
* Returns object holder by name
*
- * @param name of object
- * @return
+ * @param type of object
+ * @param name - name of object
+ * @return Bucket object
*/
RBucketAsync getBucket(String name);
@@ -158,8 +175,9 @@ public interface RBatch {
/**
* Returns HyperLogLog object
*
- * @param name of object
- * @return
+ * @param type of object
+ * @param name - name of object
+ * @return HyperLogLog object
*/
RHyperLogLogAsync getHyperLogLog(String name);
@@ -168,8 +186,9 @@ public interface RBatch {
/**
* Returns list instance by name.
*
- * @param name of list
- * @return
+ * @param type of object
+ * @param name - name of object
+ * @return List object
*/
RListAsync getList(String name);
@@ -178,8 +197,10 @@ public interface RBatch {
/**
* Returns List based MultiMap instance by name.
*
- * @param name
- * @return
+ * @param type of key
+ * @param type of value
+ * @param name - name of object
+ * @return ListMultimap object
*/
RMultimapAsync getListMultimap(String name);
@@ -187,9 +208,11 @@ public interface RBatch {
* Returns List based MultiMap instance by name
* using provided codec for both map keys and values.
*
- * @param name
- * @param codec
- * @return
+ * @param type of key
+ * @param type of value
+ * @param name - name of object
+ * @param codec - codec for keys and values
+ * @return ListMultimap object
*/
RMultimapAsync getListMultimap(String name, Codec codec);
@@ -199,8 +222,10 @@ public interface RBatch {
*
* If eviction is not required then it's better to use regular map {@link #getSetMultimap(String)}.
*
- * @param name
- * @return
+ * @param type of key
+ * @param type of value
+ * @param name - name of object
+ * @return ListMultimapCache object
*/
RMultimapAsync getListMultimapCache(String name);
@@ -211,16 +236,21 @@ public interface RBatch {
*
* If eviction is not required then it's better to use regular map {@link #getSetMultimap(String, Codec)}.
*
- * @param name
- * @return
+ * @param type of key
+ * @param type of value
+ * @param name - name of object
+ * @param codec - codec for keys and values
+ * @return ListMultimapCache object
*/
RMultimapAsync getListMultimapCache(String name, Codec codec);
/**
* Returns map instance by name.
*
- * @param name of map
- * @return
+ * @param type of key
+ * @param type of value
+ * @param name - name of object
+ * @return Map object
*/
RMapAsync getMap(String name);
@@ -229,8 +259,9 @@ public interface RBatch {
/**
* Returns set instance by name.
*
- * @param name of set
- * @return
+ * @param type of value
+ * @param name - name of object
+ * @return Set object
*/
RSetAsync getSet(String name);
@@ -239,8 +270,9 @@ public interface RBatch {
/**
* Returns topic instance by name.
*
- * @param name of topic
- * @return
+ * @param type of message
+ * @param name - name of object
+ * @return Topic object
*/
RTopicAsync getTopic(String name);
@@ -249,8 +281,9 @@ public interface RBatch {
/**
* Returns queue instance by name.
*
- * @param name of queue
- * @return
+ * @param type of value
+ * @param name - name of object
+ * @return Queue object
*/
RQueueAsync getQueue(String name);
@@ -259,8 +292,9 @@ public interface RBatch {
/**
* Returns blocking queue instance by name.
*
- * @param name of queue
- * @return
+ * @param type of value
+ * @param name - name of object
+ * @return BlockingQueue object
*/
RBlockingQueueAsync getBlockingQueue(String name);
@@ -269,8 +303,9 @@ public interface RBatch {
/**
* Returns deque instance by name.
*
- * @param name of deque
- * @return
+ * @param type of value
+ * @param name - name of object
+ * @return Deque object
*/
RDequeAsync getDeque(String name);
@@ -278,9 +313,10 @@ public interface RBatch {
/**
* Returns blocking deque instance by name.
- *
- * @param name of queue
- * @return
+ *
+ * @param type of value
+ * @param name - name of object
+ * @return BlockingDeque object
*/
RBlockingDequeAsync getBlockingDeque(String name);
@@ -289,24 +325,25 @@ public interface RBatch {
/**
* Returns atomicLong instance by name.
*
- * @param name
- * @return
+ * @param name - name of object
+ * @return AtomicLong object
*/
RAtomicLongAsync getAtomicLong(String name);
/**
* Returns atomicDouble instance by name.
*
- * @param name
- * @return
+ * @param name - name of object
+ * @return AtomicDouble object
*/
RAtomicDoubleAsync getAtomicDouble(String name);
/**
* Returns Redis Sorted Set instance by name
- *
- * @param name
- * @return
+ *
+ * @param type of value
+ * @param name - name of object
+ * @return ScoredSortedSet object
*/
RScoredSortedSetAsync getScoredSortedSet(String name);
@@ -317,8 +354,8 @@ public interface RBatch {
* All elements are inserted with the same score during addition,
* in order to force lexicographical ordering
*
- * @param name
- * @return
+ * @param name - name of object
+ * @return LexSortedSet object
*/
RLexSortedSetAsync getLexSortedSet(String name);
@@ -327,7 +364,7 @@ public interface RBatch {
/**
* Returns script operations object
*
- * @return
+ * @return Script object
*/
RScriptAsync getScript();
@@ -335,7 +372,7 @@ public interface RBatch {
* Returns keys operations.
* Each of Redis/Redisson object associated with own key
*
- * @return
+ * @return Keys object
*/
RKeysAsync getKeys();
diff --git a/redisson/src/main/java/org/redisson/api/RBatchReactive.java b/redisson/src/main/java/org/redisson/api/RBatchReactive.java
index 2cd0e3594..89843ae47 100644
--- a/redisson/src/main/java/org/redisson/api/RBatchReactive.java
+++ b/redisson/src/main/java/org/redisson/api/RBatchReactive.java
@@ -40,9 +40,9 @@ public interface RBatchReactive {
*
* If eviction is not required then it's better to use regular map {@link #getSet(String, Codec)}.
*
- * @param name
- * @param codec
- * @return
+ * @param type of value
+ * @param name - name of object
+ * @return SetCache object
*/
RSetCacheReactive getSetCache(String name);
@@ -54,9 +54,10 @@ public interface RBatchReactive {
*
* If eviction is not required then it's better to use regular map {@link #getSet(String, Codec)}.
*
- * @param name
- * @param codec
- * @return
+ * @param type of value
+ * @param name - name of object
+ * @param codec - codec for values
+ * @return SetCache object
*/
RSetCacheReactive getSetCache(String name, Codec codec);
@@ -67,9 +68,11 @@ public interface RBatchReactive {
*
* If eviction is not required then it's better to use regular map {@link #getMap(String, Codec)}.
*
- * @param name
- * @param codec
- * @return
+ * @param type of key
+ * @param type of value
+ * @param name - name of object
+ * @param codec - codec for keys and values
+ * @return MapCache object
*/
RMapCacheReactive getMapCache(String name, Codec codec);
@@ -79,26 +82,30 @@ public interface RBatchReactive {
*
* If eviction is not required then it's better to use regular map {@link #getMap(String)}.
*
- * @param name
- * @return
+ * @param type of key
+ * @param type of value
+ * @param name - name of object
+ * @return MapCache object
*/
RMapCacheReactive getMapCache(String name);
/**
* Returns object holder by name
*
- * @param name of object
- * @return
+ * @param type of value
+ * @param name - name of object
+ * @return Bucket object
*/
RBucketReactive getBucket(String name);
RBucketReactive getBucket(String name, Codec codec);
/**
- * Returns HyperLogLog object
+ * Returns HyperLogLog object by name
*
- * @param name of object
- * @return
+ * @param type of value
+ * @param name - name of object
+ * @return HyperLogLog object
*/
RHyperLogLogReactive getHyperLogLog(String name);
@@ -107,8 +114,9 @@ public interface RBatchReactive {
/**
* Returns list instance by name.
*
- * @param name of list
- * @return
+ * @param type of value
+ * @param name - name of object
+ * @return List object
*/
RListReactive getList(String name);
@@ -117,8 +125,10 @@ public interface RBatchReactive {
/**
* Returns map instance by name.
*
- * @param name of map
- * @return
+ * @param type of key
+ * @param type of value
+ * @param name - name of object
+ * @return Map object
*/
RMapReactive getMap(String name);
@@ -126,9 +136,10 @@ public interface RBatchReactive {
/**
* Returns set instance by name.
- *
- * @param name of set
- * @return
+ *
+ * @param type of value
+ * @param name - name of object
+ * @return Set object
*/
RSetReactive getSet(String name);
@@ -137,8 +148,9 @@ public interface RBatchReactive {
/**
* Returns topic instance by name.
*
- * @param name of topic
- * @return
+ * @param type of message
+ * @param name - name of object
+ * @return Topic object
*/
RTopicReactive getTopic(String name);
@@ -147,8 +159,9 @@ public interface RBatchReactive {
/**
* Returns queue instance by name.
*
- * @param name of queue
- * @return
+ * @param type of value
+ * @param name - name of object
+ * @return Queue object
*/
RQueueReactive getQueue(String name);
@@ -156,9 +169,10 @@ public interface RBatchReactive {
/**
* Returns blocking queue instance by name.
- *
- * @param name of queue
- * @return
+ *
+ * @param type of value
+ * @param name - name of object
+ * @return BlockingQueue object
*/
RBlockingQueueReactive getBlockingQueue(String name);
@@ -166,9 +180,10 @@ public interface RBatchReactive {
/**
* Returns deque instance by name.
- *
- * @param name of deque
- * @return
+ *
+ * @param type of value
+ * @param name - name of object
+ * @return Deque object
*/
RDequeReactive getDequeReactive(String name);
@@ -176,17 +191,18 @@ public interface RBatchReactive {
/**
* Returns "atomic long" instance by name.
- *
- * @param name of the "atomic long"
- * @return
+ *
+ * @param name - name of object
+ * @return AtomicLong object
*/
RAtomicLongReactive getAtomicLongReactive(String name);
/**
* Returns Redis Sorted Set instance by name
- *
- * @param name
- * @return
+ *
+ * @param type of value
+ * @param name - name of object
+ * @return ScoredSortedSet object
*/
RScoredSortedSetReactive getScoredSortedSet(String name);
@@ -197,8 +213,8 @@ public interface RBatchReactive {
* All elements are inserted with the same score during addition,
* in order to force lexicographical ordering
*
- * @param name
- * @return
+ * @param name - name of object
+ * @return LexSortedSet object
*/
RLexSortedSetReactive getLexSortedSet(String name);
@@ -206,14 +222,14 @@ public interface RBatchReactive {
* Returns bitSet instance by name.
*
* @param name of bitSet
- * @return
+ * @return BitSet object
*/
RBitSetReactive getBitSet(String name);
/**
* Returns script operations object
*
- * @return
+ * @return Script object
*/
RScriptReactive getScript();
@@ -221,7 +237,7 @@ public interface RBatchReactive {
* Returns keys operations.
* Each of Redis/Redisson object associated with own key
*
- * @return
+ * @return Keys object
*/
RKeysReactive getKeys();
diff --git a/redisson/src/main/java/org/redisson/api/RBlockingDeque.java b/redisson/src/main/java/org/redisson/api/RBlockingDeque.java
index c6390333e..194ea02f2 100644
--- a/redisson/src/main/java/org/redisson/api/RBlockingDeque.java
+++ b/redisson/src/main/java/org/redisson/api/RBlockingDeque.java
@@ -30,7 +30,8 @@ public interface RBlockingDeque extends BlockingDeque, RBlockingQueue,
* Retrieves and removes first available head element of any queue,
* waiting up to the specified wait time if necessary for an element to become available
* in any of defined queues including queue own.
- *
+ *
+ * @param queueNames - names of queue
* @param timeout how long to wait before giving up, in units of
* {@code unit}
* @param unit a {@code TimeUnit} determining how to interpret the
@@ -45,7 +46,8 @@ public interface RBlockingDeque extends BlockingDeque, RBlockingQueue,
* Retrieves and removes first available tail element of any queue,
* waiting up to the specified wait time if necessary for an element to become available
* in any of defined queues including queue own.
- *
+ *
+ * @param queueNames - names of queue
* @param timeout how long to wait before giving up, in units of
* {@code unit}
* @param unit a {@code TimeUnit} determining how to interpret the
diff --git a/redisson/src/main/java/org/redisson/api/RBlockingDequeAsync.java b/redisson/src/main/java/org/redisson/api/RBlockingDequeAsync.java
index e2929d548..e405da925 100644
--- a/redisson/src/main/java/org/redisson/api/RBlockingDequeAsync.java
+++ b/redisson/src/main/java/org/redisson/api/RBlockingDequeAsync.java
@@ -31,13 +31,13 @@ public interface RBlockingDequeAsync extends RDequeAsync, RBlockingQueueAs
* waiting up to the specified wait time if necessary for an element to become available
* in any of defined queues including queue own.
*
+ * @param queueNames - names of queue
* @param timeout how long to wait before giving up, in units of
* {@code unit}
* @param unit a {@code TimeUnit} determining how to interpret the
* {@code timeout} parameter
* @return the head of this queue, or {@code null} if the
* specified waiting time elapses before an element is available
- * @throws InterruptedException if interrupted while waiting
*/
RFuture pollFirstFromAnyAsync(long timeout, TimeUnit unit, String ... queueNames);
@@ -45,14 +45,14 @@ public interface RBlockingDequeAsync extends RDequeAsync, RBlockingQueueAs
* Retrieves and removes first available tail element of any queue in async mode,
* waiting up to the specified wait time if necessary for an element to become available
* in any of defined queues including queue own.
- *
+ *
+ * @param queueNames - names of queue
* @param timeout how long to wait before giving up, in units of
* {@code unit}
* @param unit a {@code TimeUnit} determining how to interpret the
* {@code timeout} parameter
* @return the head of this queue, or {@code null} if the
* specified waiting time elapses before an element is available
- * @throws InterruptedException if interrupted while waiting
*/
RFuture pollLastFromAnyAsync(long timeout, TimeUnit unit, String ... queueNames);
diff --git a/redisson/src/main/java/org/redisson/api/RBlockingQueue.java b/redisson/src/main/java/org/redisson/api/RBlockingQueue.java
index 3b8726744..b39c79c5d 100644
--- a/redisson/src/main/java/org/redisson/api/RBlockingQueue.java
+++ b/redisson/src/main/java/org/redisson/api/RBlockingQueue.java
@@ -31,6 +31,7 @@ public interface RBlockingQueue extends BlockingQueue, RQueue, RBlockin
* waiting up to the specified wait time if necessary for an element to become available
* in any of defined queues including queue own.
*
+ * @param queueNames - names of queue
* @param timeout how long to wait before giving up, in units of
* {@code unit}
* @param unit a {@code TimeUnit} determining how to interpret the
diff --git a/redisson/src/main/java/org/redisson/api/RBlockingQueueAsync.java b/redisson/src/main/java/org/redisson/api/RBlockingQueueAsync.java
index 932d503f7..d52047bce 100644
--- a/redisson/src/main/java/org/redisson/api/RBlockingQueueAsync.java
+++ b/redisson/src/main/java/org/redisson/api/RBlockingQueueAsync.java
@@ -32,13 +32,13 @@ public interface RBlockingQueueAsync extends RQueueAsync {
* waiting up to the specified wait time if necessary for an element to become available
* in any of defined queues including queue own.
*
+ * @param queueNames - names of queue
* @param timeout how long to wait before giving up, in units of
* {@code unit}
* @param unit a {@code TimeUnit} determining how to interpret the
* {@code timeout} parameter
* @return Future object with the head of this queue, or {@code null} if the
* specified waiting time elapses before an element is available
- * @throws InterruptedException if interrupted while waiting
*/
RFuture pollFromAnyAsync(long timeout, TimeUnit unit, String ... queueNames);
@@ -104,7 +104,6 @@ public interface RBlockingQueueAsync extends RQueueAsync {
* {@code timeout} parameter
* @return the head of this queue, or {@code null} if the
* specified waiting time elapses before an element is available
- * @throws InterruptedException if interrupted while waiting
*/
RFuture pollAsync(long timeout, TimeUnit unit);
@@ -113,7 +112,6 @@ public interface RBlockingQueueAsync extends RQueueAsync {
* until an element becomes available.
*
* @return the head of this queue
- * @throws InterruptedException if interrupted while waiting
*/
RFuture takeAsync();
@@ -122,12 +120,12 @@ public interface RBlockingQueueAsync extends RQueueAsync {
* for space to become available.
*
* @param e the element to add
- * @throws InterruptedException if interrupted while waiting
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this queue
* @throws NullPointerException if the specified element is null
* @throws IllegalArgumentException if some property of the specified
* element prevents it from being added to this queue
+ * @return void
*/
RFuture putAsync(V e);
diff --git a/redisson/src/main/java/org/redisson/api/RBlockingQueueReactive.java b/redisson/src/main/java/org/redisson/api/RBlockingQueueReactive.java
index 61f7a2757..e3a8f1747 100644
--- a/redisson/src/main/java/org/redisson/api/RBlockingQueueReactive.java
+++ b/redisson/src/main/java/org/redisson/api/RBlockingQueueReactive.java
@@ -34,13 +34,13 @@ public interface RBlockingQueueReactive extends RQueueReactive {
* waiting up to the specified wait time if necessary for an element to become available
* in any of defined queues including queue own.
*
+ * @param queueNames - names of queue
* @param timeout how long to wait before giving up, in units of
* {@code unit}
* @param unit a {@code TimeUnit} determining how to interpret the
* {@code timeout} parameter
* @return Publisher object with the head of this queue, or {@code null} if the
* specified waiting time elapses before an element is available
- * @throws InterruptedException if interrupted while waiting
*/
Publisher pollFromAny(long timeout, TimeUnit unit, String ... queueNames);
diff --git a/redisson/src/main/java/org/redisson/api/RBloomFilter.java b/redisson/src/main/java/org/redisson/api/RBloomFilter.java
index 455c3ff13..b1bd46c5c 100644
--- a/redisson/src/main/java/org/redisson/api/RBloomFilter.java
+++ b/redisson/src/main/java/org/redisson/api/RBloomFilter.java
@@ -22,7 +22,7 @@ package org.redisson.api;
*
* @author Nikita Koksharov
*
- * @param
+ * @param - type of object
*/
public interface RBloomFilter extends RExpirable {
@@ -35,8 +35,8 @@ public interface RBloomFilter extends RExpirable {
* calculated from expectedInsertions
and falseProbability
* Stores config to Redis server.
*
- * @param expectedInsertions
- * @param falseProbability
+ * @param expectedInsertions - expected amount of insertions
+ * @param falseProbability - expected false probability
* @return true
if Bloom filter initialized
* false
if Bloom filter already has been initialized
*/
@@ -53,7 +53,7 @@ public interface RBloomFilter extends RExpirable {
/**
* Calculates probabilistic number of elements already added to Bloom filter.
*
- * @return
+ * @return probabilistic number of elements
*/
int count();
diff --git a/redisson/src/main/java/org/redisson/api/RBoundedBlockingQueueAsync.java b/redisson/src/main/java/org/redisson/api/RBoundedBlockingQueueAsync.java
index bbf4294e2..7d9fa9194 100644
--- a/redisson/src/main/java/org/redisson/api/RBoundedBlockingQueueAsync.java
+++ b/redisson/src/main/java/org/redisson/api/RBoundedBlockingQueueAsync.java
@@ -46,7 +46,6 @@ public interface RBoundedBlockingQueueAsync extends RBlockingQueueAsync {
* {@code timeout} parameter
* @return {@code true} if successful, or {@code false} if
* the specified waiting time elapses before space is available
- * @throws InterruptedException if interrupted while waiting
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this queue
* @throws NullPointerException if the specified element is null
diff --git a/redisson/src/main/java/org/redisson/api/RBuckets.java b/redisson/src/main/java/org/redisson/api/RBuckets.java
index 88d0e6d84..bda58ea38 100644
--- a/redisson/src/main/java/org/redisson/api/RBuckets.java
+++ b/redisson/src/main/java/org/redisson/api/RBuckets.java
@@ -30,18 +30,20 @@ public interface RBuckets {
* h[^e]llo matches hallo, hbllo, ... but not hello
* h[a-b]llo matches hallo and hbllo
* Use \ to escape special characters if you want to match them verbatim.
- *
- * @param pattern
- * @return
+ *
+ * @param type of value
+ * @param pattern - pattern of key
+ * @return List of bucket objects
*/
List> find(String pattern);
/**
* Returns Redis object mapped by key. Result Map is not contains
* key-value entry for null values.
- *
- * @param keys
- * @return
+ *
+ * @param type of value
+ * @param keys - keys
+ * @return Map with name of bucket as key and bucket as value
*/
Map get(String ... keys);
@@ -50,14 +52,15 @@ public interface RBuckets {
* If at least one of them is already exist then
* don't set none of them.
*
- * @param buckets
+ * @param buckets - map of buckets
+ * @return true
if object has been set overwise false
*/
boolean trySet(Map buckets);
/**
* Saves objects mapped by Redis key.
*
- * @param buckets
+ * @param buckets - map of buckets
*/
void set(Map buckets);
diff --git a/redisson/src/main/java/org/redisson/api/RCollectionAsync.java b/redisson/src/main/java/org/redisson/api/RCollectionAsync.java
index 213bc83bb..cf458b079 100644
--- a/redisson/src/main/java/org/redisson/api/RCollectionAsync.java
+++ b/redisson/src/main/java/org/redisson/api/RCollectionAsync.java
@@ -81,7 +81,7 @@ public interface RCollectionAsync extends RExpirableAsync {
/**
* Returns the number of elements in this collection.
*
- * @return
+ * @return size of collection
*/
RFuture sizeAsync();
diff --git a/redisson/src/main/java/org/redisson/api/RCountDownLatchAsync.java b/redisson/src/main/java/org/redisson/api/RCountDownLatchAsync.java
index 116ba10e6..a9c2c3cd7 100644
--- a/redisson/src/main/java/org/redisson/api/RCountDownLatchAsync.java
+++ b/redisson/src/main/java/org/redisson/api/RCountDownLatchAsync.java
@@ -19,7 +19,7 @@ package org.redisson.api;
* Distributed alternative to the {@link java.util.concurrent.CountDownLatch}
*
* It has an advantage over {@link java.util.concurrent.CountDownLatch} --
- * count can be set via {@link #trySetCount} method.
+ * count can be set via {@link #trySetCountAsync} method.
*
* @author Nikita Koksharov
*
@@ -35,6 +35,8 @@ public interface RCountDownLatchAsync extends RObjectAsync {
* thread scheduling purposes.
*
* If the current count equals zero then nothing happens.
+ *
+ * @return void
*/
RFuture countDownAsync();
@@ -51,8 +53,8 @@ public interface RCountDownLatchAsync extends RObjectAsync {
* Sets new count value only if previous count already has reached zero
* or is not set at all.
*
- * @param count - number of times {@link #countDown} must be invoked
- * before threads can pass through {@link #await}
+ * @param count - number of times countDown
must be invoked
+ * before threads can pass through await
* @return true
if new count setted
* false
if previous count has not reached zero
*/
diff --git a/redisson/src/main/java/org/redisson/api/RExecutorService.java b/redisson/src/main/java/org/redisson/api/RExecutorService.java
index 664eabe79..a64cefe8e 100644
--- a/redisson/src/main/java/org/redisson/api/RExecutorService.java
+++ b/redisson/src/main/java/org/redisson/api/RExecutorService.java
@@ -28,7 +28,7 @@ public interface RExecutorService extends ExecutorService, RExecutorServiceAsync
/**
* Returns executor name
*
- * @return
+ * @return name of service
*/
String getName();
@@ -43,6 +43,7 @@ public interface RExecutorService extends ExecutorService, RExecutorServiceAsync
* Register workers using custom executor to execute each task
*
* @param workers - workers amount
+ * @param executor - executor instance
*/
void registerWorkers(int workers, ExecutorService executor);
diff --git a/redisson/src/main/java/org/redisson/api/RExecutorServiceAsync.java b/redisson/src/main/java/org/redisson/api/RExecutorServiceAsync.java
index f5d99692a..e8e66c365 100644
--- a/redisson/src/main/java/org/redisson/api/RExecutorServiceAsync.java
+++ b/redisson/src/main/java/org/redisson/api/RExecutorServiceAsync.java
@@ -35,16 +35,17 @@ public interface RExecutorServiceAsync {
/**
* Submit task for execution in async mode with listeners support
*
- * @param task
- * @return
+ * @param type of return value
+ * @param task - task to execute
+ * @return Future object
*/
RFuture submitAsync(Callable task);
/**
* Submit task for execution in async mode with listeners support
*
- * @param task
- * @return
+ * @param task - task to execute
+ * @return Future object
*/
RFuture> submitAsync(Runnable task);
diff --git a/redisson/src/main/java/org/redisson/api/RFuture.java b/redisson/src/main/java/org/redisson/api/RFuture.java
index bc0a1c0f6..56c925e05 100644
--- a/redisson/src/main/java/org/redisson/api/RFuture.java
+++ b/redisson/src/main/java/org/redisson/api/RFuture.java
@@ -24,13 +24,15 @@ import io.netty.util.concurrent.FutureListener;
*
* @author Nikita Koksharov
*
- * @param
+ * @param type of value
*/
public interface RFuture extends java.util.concurrent.Future {
/**
* Returns {@code true} if and only if the I/O operation was completed
* successfully.
+ *
+ * @return {@code true} if future was completed successfully
*/
boolean isSuccess();
@@ -49,6 +51,8 @@ public interface RFuture extends java.util.concurrent.Future {
*
* As it is possible that a {@code null} value is used to mark the future as successful you also need to check
* if the future is really done with {@link #isDone()} and not relay on the returned {@code null} value.
+ *
+ * @return object
*/
V getNow();
@@ -56,6 +60,8 @@ public interface RFuture extends java.util.concurrent.Future {
* Waits for this future to be completed within the
* specified time limit.
*
+ * @param timeout - wait timeout
+ * @param unit - time unit
* @return {@code true} if and only if the future was completed within
* the specified time limit
*
@@ -68,6 +74,7 @@ public interface RFuture extends java.util.concurrent.Future {
* Waits for this future to be completed within the
* specified time limit.
*
+ * @param timeoutMillis - timeout value
* @return {@code true} if and only if the future was completed within
* the specified time limit
*
@@ -81,6 +88,9 @@ public interface RFuture extends java.util.concurrent.Future {
* specified listener is notified when this future is
* {@linkplain #isDone() done}. If this future is already
* completed, the specified listener is notified immediately.
+ *
+ * @param listener - listener for future object
+ * @return Future object
*/
RFuture addListener(FutureListener super V> listener);
@@ -89,6 +99,9 @@ public interface RFuture extends java.util.concurrent.Future {
* specified listeners are notified when this future is
* {@linkplain #isDone() done}. If this future is already
* completed, the specified listeners are notified immediately.
+ *
+ * @param listeners - listeners for future object
+ * @return Future object
*/
RFuture addListeners(FutureListener super V>... listeners);
@@ -98,6 +111,9 @@ public interface RFuture extends java.util.concurrent.Future {
* future is {@linkplain #isDone() done}. If the specified
* listener is not associated with this future, this method
* does nothing and returns silently.
+ *
+ * @param listener - listener for future object
+ * @return Future object
*/
RFuture removeListener(FutureListener super V> listener);
@@ -107,18 +123,27 @@ public interface RFuture extends java.util.concurrent.Future {
* future is {@linkplain #isDone() done}. If the specified
* listeners are not associated with this future, this method
* does nothing and returns silently.
+ *
+ * @param listeners - listeners for future object
+ * @return Future object
*/
RFuture removeListeners(FutureListener super V>... listeners);
/**
* Waits for this future until it is done, and rethrows the cause of the failure if this future
* failed.
+ *
+ * @throws InterruptedException
+ * if the current thread was interrupted
+ * @return Future object
*/
RFuture sync() throws InterruptedException;
/**
* Waits for this future until it is done, and rethrows the cause of the failure if this future
* failed.
+ *
+ * @return Future object
*/
RFuture syncUninterruptibly();
@@ -127,6 +152,7 @@ public interface RFuture extends java.util.concurrent.Future {
*
* @throws InterruptedException
* if the current thread was interrupted
+ * @return Future object
*/
RFuture await() throws InterruptedException;
@@ -134,6 +160,8 @@ public interface RFuture extends java.util.concurrent.Future {
* Waits for this future to be completed without
* interruption. This method catches an {@link InterruptedException} and
* discards it silently.
+ *
+ * @return Future object
*/
RFuture awaitUninterruptibly();
@@ -142,6 +170,8 @@ public interface RFuture extends java.util.concurrent.Future {
* specified time limit without interruption. This method catches an
* {@link InterruptedException} and discards it silently.
*
+ * @param timeout - timeout value
+ * @param unit - timeout unit value
* @return {@code true} if and only if the future was completed within
* the specified time limit
*/
@@ -151,7 +181,8 @@ public interface RFuture extends java.util.concurrent.Future {
* Waits for this future to be completed within the
* specified time limit without interruption. This method catches an
* {@link InterruptedException} and discards it silently.
- *
+ *
+ * @param timeoutMillis - timeout value
* @return {@code true} if and only if the future was completed within
* the specified time limit
*/
diff --git a/redisson/src/main/java/org/redisson/api/RGeo.java b/redisson/src/main/java/org/redisson/api/RGeo.java
index 03de38d09..9d55b3ceb 100644
--- a/redisson/src/main/java/org/redisson/api/RGeo.java
+++ b/redisson/src/main/java/org/redisson/api/RGeo.java
@@ -23,14 +23,16 @@ import java.util.Map;
*
* @author Nikita Koksharov
*
- * @param
+ * @param type of value
*/
public interface RGeo extends RExpirable, RGeoAsync {
/**
* Adds geospatial member.
*
- * @param entries
+ * @param longitude - longitude of object
+ * @param latitude - latitude of object
+ * @param member - object itself
* @return number of elements added to the sorted set,
* not including elements already existing for which
* the score was updated
@@ -40,7 +42,7 @@ public interface RGeo extends RExpirable, RGeoAsync {
/**
* Adds geospatial members.
*
- * @param entries
+ * @param entries - objects
* @return number of elements added to the sorted set,
* not including elements already existing for which
* the score was updated
@@ -50,28 +52,26 @@ public interface RGeo extends RExpirable, RGeoAsync {
/**
* Returns distance between members in GeoUnit
units.
*
- * @see {@link GeoUnit}
- *
- * @param firstMember
- * @param secondMember
- * @param geoUnit
- * @return
+ * @param firstMember - first object
+ * @param secondMember - second object
+ * @param geoUnit - geo unit
+ * @return distance
*/
Double dist(V firstMember, V secondMember, GeoUnit geoUnit);
/**
* Returns 11 characters Geohash string mapped by defined member.
*
- * @param members
- * @return
+ * @param members - objects
+ * @return hash mapped by object
*/
Map hash(V... members);
/**
* Returns geo-position mapped by defined member.
*
- * @param members
- * @return
+ * @param members - objects
+ * @return geo position mapped by object
*/
Map pos(V... members);
@@ -81,11 +81,11 @@ public interface RGeo extends RExpirable, RGeoAsync {
* and the maximum distance from the center (the radius)
* in GeoUnit
units.
*
- * @param longitude
- * @param latitude
- * @param radius
- * @param geoUnit
- * @return
+ * @param longitude - longitude of object
+ * @param latitude - latitude of object
+ * @param radius - radius in geo units
+ * @param geoUnit - geo unit
+ * @return list of objects
*/
List radius(double longitude, double latitude, double radius, GeoUnit geoUnit);
@@ -96,11 +96,11 @@ public interface RGeo extends RExpirable, RGeoAsync {
* and the maximum distance from the center (the radius)
* in GeoUnit
units.
*
- * @param longitude
- * @param latitude
- * @param radius
- * @param geoUnit
- * @return
+ * @param longitude - longitude of object
+ * @param latitude - latitude of object
+ * @param radius - radius in geo units
+ * @param geoUnit - geo unit
+ * @return distance mapped by object
*/
Map radiusWithDistance(double longitude, double latitude, double radius, GeoUnit geoUnit);
@@ -111,11 +111,11 @@ public interface RGeo extends RExpirable, RGeoAsync {
* and the maximum distance from the center (the radius)
* in