javadoc parser compatibility fixed

redisson/src/main/java/org/redisson/api/RKeys.java

@@ -22,8 +22,8 @@ public interface RKeys extends RKeysAsync {
     /**
      * Get Redis object type by key
      * 
-     * @param name
-     * @return
+     * @param key - name of key
+     * @return type of key
      */
     RType getType(String key);
     
@@ -31,8 +31,8 @@ public interface RKeys extends RKeysAsync {
      * Get hash slot identifier for key.
      * Available for cluster nodes only
      *
-     * @param key
-     * @return
+     * @param key - name of key
+     * @return slot number
      */
     int getSlot(String key);
 
@@ -50,7 +50,7 @@ public interface RKeys extends RKeysAsync {
      *    h[ae]llo subscribes to hello and hallo, but not hillo
      * 
      * @param pattern - match pattern
-     * @return
+     * @return Iterable object
      */
     Iterable<String> getKeysByPattern(String pattern);
 
@@ -69,21 +69,21 @@ public interface RKeys extends RKeysAsync {
      *
      * @param pattern - match pattern
      * @param count - keys loaded per request to Redis
-     * @return
+     * @return Iterable object
      */
     Iterable<String> getKeysByPattern(String pattern, int count);
     
     /**
      * Get all keys using iterator. Keys traversing with SCAN operation
      *
-     * @return
+     * @return Iterable object
      */
     Iterable<String> getKeys();
 
     /**
      * Get random key
      *
-     * @return
+     * @return random key
      */
     String randomKey();
 
@@ -95,8 +95,8 @@ public interface RKeys extends RKeysAsync {
      *    h*llo subscribes to hllo and heeeello
      *    h[ae]llo subscribes to hello and hallo, but not hillo
      *
-     * @param pattern
-     * @return
+     * @param pattern - match pattern
+     * @return collection of keys
      */
     Collection<String> findKeysByPattern(String pattern);
 
@@ -110,7 +110,7 @@ public interface RKeys extends RKeysAsync {
      *    h*llo subscribes to hllo and heeeello
      *    h[ae]llo subscribes to hello and hallo, but not hillo
      *
-     * @param pattern
+     * @param pattern - match pattern 
      * @return number of removed keys
      */
     long deleteByPattern(String pattern);
@@ -126,7 +126,7 @@ public interface RKeys extends RKeysAsync {
     /**
      * Returns the number of keys in the currently-selected database
      *
-     * @return
+     * @return count of keys
      */
     long count();
 

redisson/src/main/java/org/redisson/api/RKeysAsync.java

@@ -22,8 +22,8 @@ public interface RKeysAsync {
     /**
      * Get Redis object type by key
      * 
-     * @param name
-     * @return
+     * @param key - name of key
+     * @return type of key
      */
     RFuture<RType> getTypeAsync(String key);
     
@@ -31,15 +31,15 @@ public interface RKeysAsync {
      * Get hash slot identifier for key in async mode.
      * Available for cluster nodes only
      *
-     * @param key
-     * @return
+     * @param key - name of key
+     * @return slot
      */
     RFuture<Integer> getSlotAsync(String key);
 
     /**
      * Get random key in async mode
      *
-     * @return
+     * @return random key
      */
     RFuture<String> randomKeyAsync();
 
@@ -51,8 +51,8 @@ public interface RKeysAsync {
      *    h*llo subscribes to hllo and heeeello
      *    h[ae]llo subscribes to hello and hallo, but not hillo
      *
-     * @param pattern
-     * @return
+     * @param pattern - match pattern
+     * @return collections of keys
      */
     RFuture<Collection<String>> findKeysByPatternAsync(String pattern);
 
@@ -66,7 +66,7 @@ public interface RKeysAsync {
      *    h*llo subscribes to hllo and heeeello
      *    h[ae]llo subscribes to hello and hallo, but not hillo
      *
-     * @param pattern
+     * @param pattern - match pattern
      * @return number of removed keys
      */
     RFuture<Long> deleteByPatternAsync(String pattern);
@@ -82,17 +82,19 @@ public interface RKeysAsync {
     /**
      * Returns the number of keys in the currently-selected database in async mode
      *
-     * @return
+     * @return number of keys
      */
     RFuture<Long> countAsync();
 
     /**
      * Delete all keys of currently selected database
+     * @return void
      */
     RFuture<Void> flushdbAsync();
 
     /**
      * Delete all keys of all existing databases
+     * @return void
      */
     RFuture<Void> flushallAsync();
 

redisson/src/main/java/org/redisson/api/RKeysReactive.java

@@ -26,8 +26,7 @@ public interface RKeysReactive {
      *
      * Uses <code>SCAN</code> Redis command.
      *
-     * @param pattern
-     * @return
+     * @return all keys
      */
     Publisher<String> getKeys();
 
@@ -41,8 +40,8 @@ public interface RKeysReactive {
      *    h*llo subscribes to hllo and heeeello
      *    h[ae]llo subscribes to hello and hallo, but not hillo
      *
-     * @param pattern
-     * @return
+     * @param pattern - match pattern
+     * @return keys
      */
     Publisher<String> getKeysByPattern(String pattern);
 
@@ -52,8 +51,8 @@ public interface RKeysReactive {
      *
      * Uses <code>KEYSLOT</code> Redis command.
      *
-     * @param key
-     * @return
+     * @param key - name of key
+     * @return slot number
      */
     Publisher<Integer> getSlot(String key);
 
@@ -67,8 +66,8 @@ public interface RKeysReactive {
      *    h*llo subscribes to hllo and heeeello
      *    h[ae]llo subscribes to hello and hallo, but not hillo
      *
-     * @param pattern
-     * @return
+     * @param pattern - match pattern
+     * @return collection of keys
      */
     Publisher<Collection<String>> findKeysByPattern(String pattern);
 
@@ -77,7 +76,7 @@ public interface RKeysReactive {
      *
      * Uses <code>RANDOM_KEY</code> Redis command.
      *
-     * @return
+     * @return random key
      */
     Publisher<String> randomKey();
 
@@ -91,8 +90,8 @@ public interface RKeysReactive {
      *    h*llo subscribes to hllo and heeeello
      *    h[ae]llo subscribes to hello and hallo, but not hillo
      *
-     * @param pattern
-     * @return
+     * @param pattern - match pattern
+     * @return deleted objects amount
      */
     Publisher<Long> deleteByPattern(String pattern);
 
@@ -102,7 +101,7 @@ public interface RKeysReactive {
      * Uses <code>DEL</code> Redis command.
      *
      * @param keys - object names
-     * @return
+     * @return deleted objects amount
      */
     Publisher<Long> delete(String ... keys);
 
@@ -110,7 +109,8 @@ public interface RKeysReactive {
      * Delete all the keys of the currently selected database
      *
      * Uses <code>FLUSHDB</code> Redis command.
-     *
+     * 
+     * @return void
      */
     Publisher<Void> flushdb();
 
@@ -119,6 +119,7 @@ public interface RKeysReactive {
      *
      * Uses <code>FLUSHALL</code> Redis command.
      *
+     * @return void
      */
     Publisher<Void> flushall();
 

redisson/src/main/java/org/redisson/api/RLexSortedSet.java

@@ -31,7 +31,7 @@ public interface RLexSortedSet extends RLexSortedSetAsync, Set<String>, RExpirab
     /**
      * Returns rank of value, with the scores ordered from high to low.
      * 
-     * @param o
+     * @param o - object
      * @return rank or <code>null</code> if value does not exist
      */
     Integer revRank(String o);
@@ -39,7 +39,7 @@ public interface RLexSortedSet extends RLexSortedSetAsync, Set<String>, RExpirab
     /**
      * Read all values at once.
      * 
-     * @return
+     * @return collection of values
      */
     Collection<String> readAll();
     

redisson/src/main/java/org/redisson/api/RLexSortedSetAsync.java

@@ -30,7 +30,7 @@ public interface RLexSortedSetAsync extends RCollectionAsync<String> {
     /**
      * Read all values at once.
      * 
-     * @return
+     * @return collection of values
      */
     RFuture<Collection<String>> readAllAsync();
     
@@ -65,7 +65,7 @@ public interface RLexSortedSetAsync extends RCollectionAsync<String> {
     /**
      * Returns rank of value, with the scores ordered from high to low.
      * 
-     * @param o
+     * @param o - value
      * @return rank or <code>null</code> if value does not exist
      */
     RFuture<Integer> revRankAsync(String o);

redisson/src/main/java/org/redisson/api/RList.java

@@ -30,8 +30,8 @@ public interface RList<V> extends List<V>, RExpirable, RListAsync<V>, RandomAcce
     /**
      * Add <code>element</code> after <code>elementToFind</code>
      * 
-     * @param elementToFind
-     * @param element
+     * @param elementToFind - object to find
+     * @param element - object to add
      * @return new list size
      */
     Integer addAfter(V elementToFind, V element);
@@ -39,8 +39,8 @@ public interface RList<V> extends List<V>, RExpirable, RListAsync<V>, RandomAcce
     /**
      * Add <code>element</code> before <code>elementToFind</code>
      * 
-     * @param elementToFind
-     * @param element
+     * @param elementToFind - object to find
+     * @param element - object to add
      * @return new list size
      */
     Integer addBefore(V elementToFind, V element);
@@ -50,8 +50,8 @@ public interface RList<V> extends List<V>, RExpirable, RListAsync<V>, RandomAcce
      * Works faster than {@link #set(int, Object)} but 
      * doesn't return previous element.
      * 
-     * @param index
-     * @param element
+     * @param index - index of object
+     * @param element - object to set
      */
     void fastSet(int index, V element);
 
@@ -60,7 +60,7 @@ public interface RList<V> extends List<V>, RExpirable, RListAsync<V>, RandomAcce
     /**
      * Read all elements at once
      *
-     * @return
+     * @return list of values
      */
     List<V> readAll();
 
@@ -68,9 +68,8 @@ public interface RList<V> extends List<V>, RExpirable, RListAsync<V>, RandomAcce
      * Trim list and remains elements only in specified range
      * <tt>fromIndex</tt>, inclusive, and <tt>toIndex</tt>, inclusive.
      *
-     * @param fromIndex
-     * @param toIndex
-     * @return
+     * @param fromIndex - from index
+     * @param toIndex - to index
      */
     void trim(int fromIndex, int toIndex);
 

redisson/src/main/java/org/redisson/api/RListAsync.java

@@ -31,8 +31,8 @@ public interface RListAsync<V> extends RCollectionAsync<V>, RandomAccess {
     /**
      * Add <code>element</code> after <code>elementToFind</code>
      * 
-     * @param elementToFind
-     * @param element
+     * @param elementToFind - object to find
+     * @param element - object to add
      * @return new list size
      */
     RFuture<Integer> addAfterAsync(V elementToFind, V element);
@@ -40,8 +40,8 @@ public interface RListAsync<V> extends RCollectionAsync<V>, RandomAccess {
     /**
      * Add <code>element</code> before <code>elementToFind</code>
      * 
-     * @param elementToFind
-     * @param element
+     * @param elementToFind - object to find
+     * @param element - object to add
      * @return new list size
      */
     RFuture<Integer> addBeforeAsync(V elementToFind, V element);
@@ -57,8 +57,9 @@ public interface RListAsync<V> extends RCollectionAsync<V>, RandomAccess {
      * Works faster than {@link #setAsync(int, Object)} but 
      * doesn't return previous element.
      * 
-     * @param index
-     * @param element
+     * @param index - index of object
+     * @param element - object
+     * @return void
      */
     RFuture<Void> fastSetAsync(int index, V element);
 
@@ -69,7 +70,7 @@ public interface RListAsync<V> extends RCollectionAsync<V>, RandomAccess {
     /**
      * Read all elements at once
      *
-     * @return
+     * @return list of values
      */
     RFuture<List<V>> readAllAsync();
 
@@ -77,9 +78,9 @@ public interface RListAsync<V> extends RCollectionAsync<V>, RandomAccess {
      * Trim list and remains elements only in specified range
      * <tt>fromIndex</tt>, inclusive, and <tt>toIndex</tt>, inclusive.
      *
-     * @param fromIndex
-     * @param toIndex
-     * @return
+     * @param fromIndex - from index
+     * @param toIndex - to index
+     * @return void
      */
     RFuture<Void> trimAsync(long fromIndex, long toIndex);
 

redisson/src/main/java/org/redisson/api/RMultimap.java

@@ -32,32 +32,42 @@ public interface RMultimap<K, V> extends RExpirable, RMultimapAsync<K, V> {
     /**
      * Returns the number of key-value pairs in this multimap.
      *
-     * @return
+     * @return size of multimap
      */
     int size();
 
     /**
      * Check is map empty
      *
-     * @return
+     * @return <code>true</code> if empty
      */
     boolean isEmpty();
 
     /**
      * Returns {@code true} if this multimap contains at least one key-value pair
      * with the key {@code key}.
+     * 
+     * @param key - map key
+     * @return <code>true</code> if contains a key
      */
     boolean containsKey(Object key);
 
     /**
      * Returns {@code true} if this multimap contains at least one key-value pair
      * with the value {@code value}.
+     * 
+     * @param value - map value
+     * @return <code>true</code> if contains a value
      */
     boolean containsValue(Object value);
 
     /**
      * Returns {@code true} if this multimap contains at least one key-value pair
      * with the key {@code key} and the value {@code value}.
+     * 
+     * @param key - map key
+     * @param value - map value
+     * @return <code>true</code> if contains an entry
      */
     boolean containsEntry(Object key, Object value);
 
@@ -69,6 +79,8 @@ public interface RMultimap<K, V> extends RExpirable, RMultimapAsync<K, V> {
      * multimap size by 1. Other implementations prohibit duplicates, and storing
      * a key-value pair that's already in the multimap has no effect.
      *
+     * @param key - map key
+     * @param value - map value
      * @return {@code true} if the method increased the size of the multimap, or
      *     {@code false} if the multimap already contained the key-value pair and
      *     doesn't allow duplicates
@@ -81,6 +93,8 @@ public interface RMultimap<K, V> extends RExpirable, RMultimapAsync<K, V> {
      * pairs in the multimap fit this description, which one is removed is
      * unspecified.
      *
+     * @param key - map key
+     * @param value - map value
      * @return {@code true} if the multimap changed
      */
     boolean remove(Object key, Object value);
@@ -95,7 +109,9 @@ public interface RMultimap<K, V> extends RExpirable, RMultimapAsync<K, V> {
      *   }}</pre>
      *
      * <p>In particular, this is a no-op if {@code values} is empty.
-     *
+     * 
+     * @param key - map key
+     * @param values - map values
      * @return {@code true} if the multimap changed
      */
     boolean putAll(K key, Iterable<? extends V> values);
@@ -107,6 +123,8 @@ public interface RMultimap<K, V> extends RExpirable, RMultimapAsync<K, V> {
      * <p>If {@code values} is empty, this is equivalent to
      * {@link #removeAll(Object) removeAll(key)}.
      *
+     * @param key - map key
+     * @param values - map values
      * @return the collection of replaced values, or an empty collection if no
      *     values were previously associated with the key. The collection
      *     <i>may</i> be modifiable, but updating it will have no effect on the
@@ -120,8 +138,9 @@ public interface RMultimap<K, V> extends RExpirable, RMultimapAsync<K, V> {
      * <p>Once this method returns, {@code key} will not be mapped to any values,
      * so it will not appear in {@link #keySet()}, {@link #asMap()}, or any other
      * views.
-     * <p>Use {@link #fastRemove()} if values are not needed.</p>
-     *
+     * <p>Use {@link RMultimap#fastRemove()} if values are not needed.</p>
+     * 
+     * @param key - map key
      * @return the values that were removed (possibly empty). The returned
      *     collection <i>may</i> be modifiable, but updating it will have no
      *     effect on the multimap.
@@ -141,6 +160,9 @@ public interface RMultimap<K, V> extends RExpirable, RMultimapAsync<K, V> {
      *
      * <p>Changes to the returned collection will update the underlying multimap,
      * and vice versa.
+     * 
+     * @param key - map key
+     * @return collection of values
      */
     Collection<V> get(K key);
 
@@ -148,8 +170,8 @@ public interface RMultimap<K, V> extends RExpirable, RMultimapAsync<K, V> {
      * Returns all elements at once. Result collection is <b>NOT</b> backed by map,
      * so changes are not reflected in map.
      *
-     * @param key
-     * @return
+     * @param key - map key
+     * @return collection of values 
      */
     Collection<V> getAll(K key);
 
@@ -160,11 +182,15 @@ public interface RMultimap<K, V> extends RExpirable, RMultimapAsync<K, V> {
      *
      * <p>Changes to the returned set will update the underlying multimap, and
      * vice versa. However, <i>adding</i> to the returned set is not possible.
+     * 
+     * @return set of keys
      */
     Set<K> keySet();
     
     /**
      *  Returns the count of distinct keys in this multimap.
+     *  
+     *  @return keys amount
      */
     int keySize();
 
@@ -176,6 +202,8 @@ public interface RMultimap<K, V> extends RExpirable, RMultimapAsync<K, V> {
      * <p>Changes to the returned collection will update the underlying multimap,
      * and vice versa. However, <i>adding</i> to the returned collection is not
      * possible.
+     * 
+     * @return collection of values
      */
     Collection<V> values();
 
@@ -186,6 +214,8 @@ public interface RMultimap<K, V> extends RExpirable, RMultimapAsync<K, V> {
      * <p>Changes to the returned collection or the entries it contains will
      * update the underlying multimap, and vice versa. However, <i>adding</i> to
      * the returned collection is not possible.
+     * 
+     * @return collection of entries
      */
     Collection<Map.Entry<K, V>> entries();
 
@@ -195,7 +225,7 @@ public interface RMultimap<K, V> extends RExpirable, RMultimapAsync<K, V> {
      * Works faster than <code>RMultimap.remove</code> but not returning
      * the value associated with <code>key</code>
      *
-     * @param keys
+     * @param keys - map keys
      * @return the number of keys that were removed from the hash, not including specified but non existing keys
      */
     long fastRemove(K ... keys);

redisson/src/main/java/org/redisson/api/RMultimapAsync.java

@@ -30,25 +30,35 @@ public interface RMultimapAsync<K, V> extends RExpirableAsync {
     /**
      * Returns the number of key-value pairs in this multimap.
      *
-     * @return
+     * @return size of multimap
      */
     RFuture<Integer> sizeAsync();
 
     /**
      * Returns {@code true} if this multimap contains at least one key-value pair
      * with the key {@code key}.
+     * 
+     * @param key - map key
+     * @return <code>true</code> if contains a key
      */
     RFuture<Boolean> containsKeyAsync(Object key);
 
     /**
      * Returns {@code true} if this multimap contains at least one key-value pair
      * with the value {@code value}.
+     * 
+     * @param value - map value
+     * @return <code>true</code> if contains a value
      */
     RFuture<Boolean> containsValueAsync(Object value);
 
     /**
      * Returns {@code true} if this multimap contains at least one key-value pair
      * with the key {@code key} and the value {@code value}.
+     * 
+     * @param key - map key
+     * @param value - map value
+     * @return <code>true</code> if contains an entry
      */
     RFuture<Boolean> containsEntryAsync(Object key, Object value);
 
@@ -60,6 +70,8 @@ public interface RMultimapAsync<K, V> extends RExpirableAsync {
      * multimap size by 1. Other implementations prohibit duplicates, and storing
      * a key-value pair that's already in the multimap has no effect.
      *
+     * @param key - map key
+     * @param value - map value
      * @return {@code true} if the method increased the size of the multimap, or
      *     {@code false} if the multimap already contained the key-value pair and
      *     doesn't allow duplicates
@@ -72,6 +84,8 @@ public interface RMultimapAsync<K, V> extends RExpirableAsync {
      * pairs in the multimap fit this description, which one is removed is
      * unspecified.
      *
+     * @param key - map key
+     * @param value - map value
      * @return {@code true} if the multimap changed
      */
     RFuture<Boolean> removeAsync(Object key, Object value);
@@ -89,6 +103,8 @@ public interface RMultimapAsync<K, V> extends RExpirableAsync {
      *
      * <p>In particular, this is a no-op if {@code values} is empty.
      *
+     * @param key - map key
+     * @param values - map values
      * @return {@code true} if the multimap changed
      */
     RFuture<Boolean> putAllAsync(K key, Iterable<? extends V> values);
@@ -100,6 +116,8 @@ public interface RMultimapAsync<K, V> extends RExpirableAsync {
      * <p>If {@code values} is empty, this is equivalent to
      * {@link #removeAll(Object) removeAll(key)}.
      *
+     * @param key - map key
+     * @param values - map values
      * @return the collection of replaced values, or an empty collection if no
      *     values were previously associated with the key. The collection
      *     <i>may</i> be modifiable, but updating it will have no effect on the
@@ -114,6 +132,7 @@ public interface RMultimapAsync<K, V> extends RExpirableAsync {
      * so it will not appear in {@link #keySet()}, {@link #asMap()}, or any other
      * views.
      *
+     * @param key - map key
      * @return the values that were removed (possibly empty). The returned
      *     collection <i>may</i> be modifiable, but updating it will have no
      *     effect on the multimap.
@@ -126,17 +145,17 @@ public interface RMultimapAsync<K, V> extends RExpirableAsync {
     /**
      * Returns the number of key-value pairs in this multimap.
      *
-     * @return
+     * @return keys amount
      */
     RFuture<Integer> keySizeAsync();
 
     /**
      * Removes <code>keys</code> from map by one operation
      *
-     * Works faster than <code>removeAll</code> but not returning
+     * Works faster than <code>RMultimap.remove</code> but not returning
      * the value associated with <code>key</code>
      *
-     * @param keys
+     * @param keys - map keys
      * @return the number of keys that were removed from the hash, not including specified but non existing keys
      */
     RFuture<Long> fastRemoveAsync(K ... keys);