diff --git a/redisson/src/main/java/org/redisson/CronSchedule.java b/redisson/src/main/java/org/redisson/CronSchedule.java index 96f138ce4..448e23e7f 100644 --- a/redisson/src/main/java/org/redisson/CronSchedule.java +++ b/redisson/src/main/java/org/redisson/CronSchedule.java @@ -39,8 +39,8 @@ public class CronSchedule { /** * Creates cron expression object with defined expression string * - * @param expression - * @return + * @param expression of cron + * @return object * @throws IllegalArgumentException * wrapping a ParseException if the expression is invalid */ @@ -52,9 +52,9 @@ public class CronSchedule { * Creates cron expression which schedule task execution * every day at the given time * - * @param hour - * @param minute - * @return + * @param hour of schedule + * @param minute of schedule + * @return object * @throws IllegalArgumentException * wrapping a ParseException if the expression is invalid */ @@ -68,18 +68,10 @@ public class CronSchedule { * every given days of the week at the given time. * Use Calendar object constants to define day. * - * @see Calendar#SUNDAY - * @see Calendar#MONDAY - * @see Calendar#TUESDAY - * @see Calendar#WEDNESDAY - * @see Calendar#THURSDAY - * @see Calendar#FRIDAY - * @see Calendar#SATURDAY - * - * @param hour - * @param minute + * @param hour of schedule + * @param minute of schedule * @param daysOfWeek - Calendar object constants - * @return + * @return object */ public static CronSchedule weeklyOnDayAndHourAndMinute(int hour, int minute, Integer... daysOfWeek) { if (daysOfWeek == null || daysOfWeek.length == 0) { @@ -98,10 +90,10 @@ public class CronSchedule { * Creates cron expression which schedule task execution * every given day of the month at the given time * - * @param hour - * @param minute - * @param daysOfWeek - * @return + * @param hour of schedule + * @param minute of schedule + * @param dayOfMonth of schedule + * @return object */ public static CronSchedule monthlyOnDayAndHourAndMinute(int dayOfMonth, int hour, int minute) { String expression = String.format("0 %d %d %d * ?", minute, hour, dayOfMonth); diff --git a/redisson/src/main/java/org/redisson/PubSubMessageListener.java b/redisson/src/main/java/org/redisson/PubSubMessageListener.java index 3d205fa9e..412be84bf 100644 --- a/redisson/src/main/java/org/redisson/PubSubMessageListener.java +++ b/redisson/src/main/java/org/redisson/PubSubMessageListener.java @@ -23,8 +23,7 @@ import org.redisson.client.protocol.pubsub.PubSubType; * * @author Nikita Koksharov * - * @param - * @param + * @param value */ public class PubSubMessageListener implements RedisPubSubListener { diff --git a/redisson/src/main/java/org/redisson/PubSubPatternMessageListener.java b/redisson/src/main/java/org/redisson/PubSubPatternMessageListener.java index 14a0faf5a..56997aaed 100644 --- a/redisson/src/main/java/org/redisson/PubSubPatternMessageListener.java +++ b/redisson/src/main/java/org/redisson/PubSubPatternMessageListener.java @@ -15,7 +15,6 @@ */ package org.redisson; -import org.redisson.api.listener.MessageListener; import org.redisson.api.listener.PatternMessageListener; import org.redisson.client.RedisPubSubListener; import org.redisson.client.protocol.pubsub.PubSubType; @@ -24,8 +23,7 @@ import org.redisson.client.protocol.pubsub.PubSubType; * * @author Nikita Koksharov * - * @param - * @param + * @param value */ public class PubSubPatternMessageListener implements RedisPubSubListener { diff --git a/redisson/src/main/java/org/redisson/PubSubPatternStatusListener.java b/redisson/src/main/java/org/redisson/PubSubPatternStatusListener.java index 93702acb0..41b915e9f 100644 --- a/redisson/src/main/java/org/redisson/PubSubPatternStatusListener.java +++ b/redisson/src/main/java/org/redisson/PubSubPatternStatusListener.java @@ -23,8 +23,7 @@ import org.redisson.client.protocol.pubsub.PubSubType; * * @author Nikita Koksharov * - * @param - * @param + * @param value */ public class PubSubPatternStatusListener implements RedisPubSubListener { diff --git a/redisson/src/main/java/org/redisson/PubSubStatusListener.java b/redisson/src/main/java/org/redisson/PubSubStatusListener.java index 317b95ed9..43335f4c7 100644 --- a/redisson/src/main/java/org/redisson/PubSubStatusListener.java +++ b/redisson/src/main/java/org/redisson/PubSubStatusListener.java @@ -23,8 +23,7 @@ import org.redisson.client.protocol.pubsub.PubSubType; * * @author Nikita Koksharov * - * @param - * @param + * @param value */ public class PubSubStatusListener implements RedisPubSubListener { diff --git a/redisson/src/main/java/org/redisson/Redisson.java b/redisson/src/main/java/org/redisson/Redisson.java index 4d5429e5e..fc410447e 100755 --- a/redisson/src/main/java/org/redisson/Redisson.java +++ b/redisson/src/main/java/org/redisson/Redisson.java @@ -135,7 +135,7 @@ public class Redisson implements RedissonClient { /** * Create sync/async Redisson instance with provided config * - * @param config + * @param config for Redisson * @return Redisson instance */ public static RedissonClient create(Config config) { @@ -163,6 +163,7 @@ public class Redisson implements RedissonClient { /** * Create reactive Redisson instance with provided config * + * @param config for Redisson * @return Redisson instance */ public static RedissonReactiveClient createReactive(Config config) { diff --git a/redisson/src/main/java/org/redisson/RedissonBloomFilter.java b/redisson/src/main/java/org/redisson/RedissonBloomFilter.java index 7609707e2..88cbf8daa 100644 --- a/redisson/src/main/java/org/redisson/RedissonBloomFilter.java +++ b/redisson/src/main/java/org/redisson/RedissonBloomFilter.java @@ -45,7 +45,7 @@ import net.openhft.hashing.LongHashFunction; * * @author Nikita Koksharov * - * @param + * @param type of object */ public class RedissonBloomFilter extends RedissonExpirable implements RBloomFilter { diff --git a/redisson/src/main/java/org/redisson/RedissonGeo.java b/redisson/src/main/java/org/redisson/RedissonGeo.java index e2e915642..d5f3289f4 100644 --- a/redisson/src/main/java/org/redisson/RedissonGeo.java +++ b/redisson/src/main/java/org/redisson/RedissonGeo.java @@ -47,7 +47,7 @@ import org.redisson.connection.decoder.MapGetAllDecoder; * * @author Nikita Koksharov * - * @param + * @param value */ public class RedissonGeo extends RedissonExpirable implements RGeo { diff --git a/redisson/src/main/java/org/redisson/RedissonHyperLogLog.java b/redisson/src/main/java/org/redisson/RedissonHyperLogLog.java index 528c658e9..a0df9f192 100644 --- a/redisson/src/main/java/org/redisson/RedissonHyperLogLog.java +++ b/redisson/src/main/java/org/redisson/RedissonHyperLogLog.java @@ -30,7 +30,7 @@ import org.redisson.command.CommandAsyncExecutor; * * @author Nikita Koksharov * - * @param + * @param value */ public class RedissonHyperLogLog extends RedissonExpirable implements RHyperLogLog { diff --git a/redisson/src/main/java/org/redisson/RedissonMultiLock.java b/redisson/src/main/java/org/redisson/RedissonMultiLock.java index 1a5259000..c5007e988 100644 --- a/redisson/src/main/java/org/redisson/RedissonMultiLock.java +++ b/redisson/src/main/java/org/redisson/RedissonMultiLock.java @@ -46,7 +46,7 @@ public class RedissonMultiLock implements Lock { * Creates instance with multiple {@link RLock} objects. * Each RLock object could be created by own Redisson instance. * - * @param locks + * @param locks - array of locks */ public RedissonMultiLock(RLock... locks) { if (locks.length == 0) { diff --git a/redisson/src/main/java/org/redisson/RedissonNode.java b/redisson/src/main/java/org/redisson/RedissonNode.java index 5263a8b4c..cb941788b 100644 --- a/redisson/src/main/java/org/redisson/RedissonNode.java +++ b/redisson/src/main/java/org/redisson/RedissonNode.java @@ -170,7 +170,7 @@ public class RedissonNode { /** * Create Redisson node instance with provided config * - * @param config + * @param config of RedissonNode * @return RedissonNode instance */ public static RedissonNode create(RedissonNodeConfig config) { @@ -180,8 +180,8 @@ public class RedissonNode { /** * Create Redisson node instance with provided config and Redisson instance * - * @param config - * @param redisson + * @param config of RedissonNode + * @param redisson instance * @return RedissonNode instance */ public static RedissonNode create(RedissonNodeConfig config, Redisson redisson) { diff --git a/redisson/src/main/java/org/redisson/RedissonRedLock.java b/redisson/src/main/java/org/redisson/RedissonRedLock.java index de09713e8..86fd7feaa 100644 --- a/redisson/src/main/java/org/redisson/RedissonRedLock.java +++ b/redisson/src/main/java/org/redisson/RedissonRedLock.java @@ -38,7 +38,7 @@ public class RedissonRedLock extends RedissonMultiLock { * Creates instance with multiple {@link RLock} objects. * Each RLock object could be created by own Redisson instance. * - * @param locks + * @param locks - array of locks */ public RedissonRedLock(RLock... locks) { super(locks); diff --git a/redisson/src/main/java/org/redisson/RedissonSetCache.java b/redisson/src/main/java/org/redisson/RedissonSetCache.java index 881105eaa..d871b44ee 100644 --- a/redisson/src/main/java/org/redisson/RedissonSetCache.java +++ b/redisson/src/main/java/org/redisson/RedissonSetCache.java @@ -15,7 +15,6 @@ */ package org.redisson; -import java.io.IOException; import java.net.InetSocketAddress; import java.util.ArrayList; import java.util.Arrays; @@ -37,11 +36,9 @@ import org.redisson.client.protocol.convertor.BooleanReplayConvertor; import org.redisson.client.protocol.decoder.ListScanResult; import org.redisson.command.CommandAsyncExecutor; -import io.netty.util.concurrent.Future; - /** *

Set-based cache with ability to set TTL for each entry via - * {@link #put(Object, Object, long, TimeUnit)} method. + * {@link RSetCache#add(Object, long, TimeUnit)} method. *

* *

Current Redis implementation doesn't have set entry eviction functionality. @@ -51,11 +48,10 @@ import io.netty.util.concurrent.Future; * In addition there is {@link org.redisson.EvictionScheduler}. This scheduler * deletes expired entries in time interval between 5 seconds to 2 hours.

* - *

If eviction is not required then it's better to use {@link org.redisson.reactive.RedissonSet}.

+ *

If eviction is not required then it's better to use {@link org.redisson.api.RSet}.

* * @author Nikita Koksharov * - * @param key * @param value */ public class RedissonSetCache extends RedissonExpirable implements RSetCache { diff --git a/redisson/src/main/java/org/redisson/RedissonSortedSet.java b/redisson/src/main/java/org/redisson/RedissonSortedSet.java index cf470d7a5..66aafb704 100644 --- a/redisson/src/main/java/org/redisson/RedissonSortedSet.java +++ b/redisson/src/main/java/org/redisson/RedissonSortedSet.java @@ -44,7 +44,7 @@ import io.netty.channel.EventLoopGroup; * * @author Nikita Koksharov * - * @param + * @param value */ public class RedissonSortedSet extends RedissonObject implements RSortedSet { diff --git a/redisson/src/main/java/org/redisson/api/RCollectionAsync.java b/redisson/src/main/java/org/redisson/api/RCollectionAsync.java index cf458b079..a141a27d5 100644 --- a/redisson/src/main/java/org/redisson/api/RCollectionAsync.java +++ b/redisson/src/main/java/org/redisson/api/RCollectionAsync.java @@ -17,6 +17,12 @@ package org.redisson.api; import java.util.Collection; +/** + * + * @author Nikita Koksharov + * + * @param type of value + */ public interface RCollectionAsync extends RExpirableAsync { /** diff --git a/redisson/src/main/java/org/redisson/api/RCollectionReactive.java b/redisson/src/main/java/org/redisson/api/RCollectionReactive.java index becd2b95d..38911582a 100644 --- a/redisson/src/main/java/org/redisson/api/RCollectionReactive.java +++ b/redisson/src/main/java/org/redisson/api/RCollectionReactive.java @@ -19,6 +19,12 @@ import java.util.Collection; import org.reactivestreams.Publisher; +/** + * + * @author Nikita Koksharov + * + * @param value + */ public interface RCollectionReactive extends RExpirableReactive { Publisher iterator(); diff --git a/redisson/src/main/java/org/redisson/api/RHyperLogLog.java b/redisson/src/main/java/org/redisson/api/RHyperLogLog.java index f63351221..65323a51a 100644 --- a/redisson/src/main/java/org/redisson/api/RHyperLogLog.java +++ b/redisson/src/main/java/org/redisson/api/RHyperLogLog.java @@ -17,6 +17,12 @@ package org.redisson.api; import java.util.Collection; +/** + * + * @author Nikita Koksharov + * + * @param value + */ public interface RHyperLogLog extends RExpirable, RHyperLogLogAsync { boolean add(V obj); diff --git a/redisson/src/main/java/org/redisson/api/RHyperLogLogAsync.java b/redisson/src/main/java/org/redisson/api/RHyperLogLogAsync.java index ac5b6d10f..560d23a0c 100644 --- a/redisson/src/main/java/org/redisson/api/RHyperLogLogAsync.java +++ b/redisson/src/main/java/org/redisson/api/RHyperLogLogAsync.java @@ -17,6 +17,12 @@ package org.redisson.api; import java.util.Collection; +/** + * + * @author Nikita Koksharov + * + * @param value + */ public interface RHyperLogLogAsync extends RExpirableAsync { RFuture addAsync(V obj); diff --git a/redisson/src/main/java/org/redisson/api/RSet.java b/redisson/src/main/java/org/redisson/api/RSet.java index 6ec03b58b..f8e42c01b 100644 --- a/redisson/src/main/java/org/redisson/api/RSet.java +++ b/redisson/src/main/java/org/redisson/api/RSet.java @@ -29,14 +29,14 @@ public interface RSet extends Set, RExpirable, RSetAsync { /** * Removes and returns random element from set * - * @return + * @return value */ V removeRandom(); /** * Returns random element from set * - * @return + * @return value */ V random(); @@ -53,7 +53,7 @@ public interface RSet extends Set, RExpirable, RSetAsync { /** * Read all elements at once * - * @return + * @return values */ Set readAll(); @@ -61,17 +61,17 @@ public interface RSet extends Set, RExpirable, RSetAsync { * Union sets specified by name and write to current set. * If current set already exists, it is overwritten. * - * @param names - * @return + * @param names - name of sets + * @return size of union */ int union(String... names); /** - * Union sets specified by name with current set. - * Without current set state change. - * - * @param names - * @return + * Union sets specified by name with current set + * without current set state change. + * + * @param names - name of sets + * @return values */ Set readUnion(String... names); @@ -79,17 +79,17 @@ public interface RSet extends Set, RExpirable, RSetAsync { * Diff sets specified by name and write to current set. * If current set already exists, it is overwritten. * - * @param names - * @return + * @param names - name of sets + * @return values */ int diff(String... names); /** * Diff sets specified by name with current set. * Without current set state change. - * - * @param names - * @return + * + * @param names - name of sets + * @return values */ Set readDiff(String... names); @@ -97,17 +97,17 @@ public interface RSet extends Set, RExpirable, RSetAsync { * Intersection sets specified by name and write to current set. * If current set already exists, it is overwritten. * - * @param names - * @return + * @param names - name of sets + * @return size of intersection */ int intersection(String... names); /** - * Intersection sets specified by name with current set. - * Without current set state change. - * - * @param names - * @return + * Intersection sets specified by name with current set + * without current set state change. + * + * @param names - name of sets + * @return values */ Set readIntersection(String... names); diff --git a/redisson/src/main/java/org/redisson/api/RSetAsync.java b/redisson/src/main/java/org/redisson/api/RSetAsync.java index 71599e05e..9e8c0fd56 100644 --- a/redisson/src/main/java/org/redisson/api/RSetAsync.java +++ b/redisson/src/main/java/org/redisson/api/RSetAsync.java @@ -29,16 +29,16 @@ public interface RSetAsync extends RCollectionAsync { /** * Removes and returns random element from set * in async mode - * - * @return + * + * @return value */ RFuture removeRandomAsync(); /** * Returns random element from set * in async mode - * - * @return + * + * @return value */ RFuture randomAsync(); @@ -47,7 +47,7 @@ public interface RSetAsync extends RCollectionAsync { * * @param destination the destination set * @param member the member to move - * @return true if the element is moved, false if the element is not a + * @return true if the element is moved, false if the element is not a * member of this set or no operation was performed */ RFuture moveAsync(String destination, V member); @@ -55,7 +55,7 @@ public interface RSetAsync extends RCollectionAsync { /** * Read all elements at once * - * @return + * @return values */ RFuture> readAllAsync(); @@ -63,54 +63,54 @@ public interface RSetAsync extends RCollectionAsync { * Union sets specified by name and write to current set. * If current set already exists, it is overwritten. * - * @param names - * @return + * @param names - name of sets + * @return size of union */ - RFuture unionAsync(String... keys); + RFuture unionAsync(String... names); /** * Union sets specified by name with current set. * Without current set state change. * - * @param names - * @return + * @param names - name of sets + * @return values */ - RFuture> readUnionAsync(String... keys); + RFuture> readUnionAsync(String... names); /** * Diff sets specified by name and write to current set. * If current set already exists, it is overwritten. * - * @param names - * @return + * @param names - name of sets + * @return size of diff */ - RFuture diffAsync(String... keys); + RFuture diffAsync(String... names); /** * Diff sets specified by name with current set. * Without current set state change. - * - * @param names - * @return + * + * @param names - name of sets + * @return values */ - RFuture> readDiffAsync(String... keys); + RFuture> readDiffAsync(String... names); /** * Intersection sets specified by name and write to current set. * If current set already exists, it is overwritten. * - * @param names - * @return + * @param names - name of sets + * @return size of intersection */ - RFuture intersectionAsync(String... keys); + RFuture intersectionAsync(String... names); /** * Intersection sets specified by name with current set. * Without current set state change. - * - * @param names - * @return + * + * @param names - name of sets + * @return values */ - RFuture> readIntersectionAsync(String... keys); + RFuture> readIntersectionAsync(String... names); } diff --git a/redisson/src/main/java/org/redisson/api/RSetCache.java b/redisson/src/main/java/org/redisson/api/RSetCache.java index 79fa80dd0..8efe0addd 100644 --- a/redisson/src/main/java/org/redisson/api/RSetCache.java +++ b/redisson/src/main/java/org/redisson/api/RSetCache.java @@ -29,11 +29,10 @@ import java.util.concurrent.TimeUnit; * In addition there is {@link org.redisson.EvictionScheduler}. This scheduler * deletes expired entries in time interval between 5 seconds to 2 hours.

* - *

If eviction is not required then it's better to use {@link org.redisson.reactive.RedissonSet}.

+ *

If eviction is not required then it's better to use {@link org.redisson.api.RSet}.

* * @author Nikita Koksharov * - * @param key * @param value */ public interface RSetCache extends Set, RExpirable, RSetCacheAsync { @@ -42,11 +41,10 @@ public interface RSetCache extends Set, RExpirable, RSetCacheAsync { * Stores value with specified time to live. * Value expires after specified time to live. * - * @param key - * @param value + * @param value to add * @param ttl - time to live for key\value entry. * If 0 then stores infinitely. - * @param unit + * @param unit - time unit * @return true if value has been added. false * if value already been in collection. */ @@ -57,6 +55,7 @@ public interface RSetCache extends Set, RExpirable, RSetCacheAsync { * This number can reflects expired elements too * due to non realtime cleanup process. * + * @return size of set */ @Override int size(); @@ -64,7 +63,7 @@ public interface RSetCache extends Set, RExpirable, RSetCacheAsync { /** * Read all elements at once * - * @return + * @return values */ Set readAll(); diff --git a/redisson/src/main/java/org/redisson/api/RSetCacheAsync.java b/redisson/src/main/java/org/redisson/api/RSetCacheAsync.java index 31cea9a8e..9736f2cdb 100644 --- a/redisson/src/main/java/org/redisson/api/RSetCacheAsync.java +++ b/redisson/src/main/java/org/redisson/api/RSetCacheAsync.java @@ -31,11 +31,10 @@ public interface RSetCacheAsync extends RCollectionAsync { * Stores value with specified time to live. * Value expires after specified time to live. * - * @param key - * @param value + * @param value to add * @param ttl - time to live for key\value entry. * If 0 then stores infinitely. - * @param unit + * @param unit - time unit * @return true if value has been added. false * if value already been in collection. */ @@ -46,6 +45,7 @@ public interface RSetCacheAsync extends RCollectionAsync { * This number can reflects expired elements too * due to non realtime cleanup process. * + * @return size of set */ @Override RFuture sizeAsync(); @@ -53,7 +53,7 @@ public interface RSetCacheAsync extends RCollectionAsync { /** * Read all elements at once * - * @return + * @return values */ RFuture> readAllAsync(); diff --git a/redisson/src/main/java/org/redisson/api/RSetReactive.java b/redisson/src/main/java/org/redisson/api/RSetReactive.java index b5b91a9c6..02297e0cb 100644 --- a/redisson/src/main/java/org/redisson/api/RSetReactive.java +++ b/redisson/src/main/java/org/redisson/api/RSetReactive.java @@ -32,7 +32,7 @@ public interface RSetReactive extends RCollectionReactive { * Removes and returns random element from set * in async mode * - * @return + * @return value */ Publisher removeRandom(); @@ -40,7 +40,7 @@ public interface RSetReactive extends RCollectionReactive { * Returns random element from set * in async mode * - * @return + * @return value */ Publisher random(); @@ -58,8 +58,8 @@ public interface RSetReactive extends RCollectionReactive { * Union sets specified by name and write to current set. * If current set already exists, it is overwritten. * - * @param names - * @return + * @param names - name of sets + * @return size of union */ Publisher union(String... names); @@ -67,8 +67,8 @@ public interface RSetReactive extends RCollectionReactive { * Union sets specified by name with current set. * Without current set state change. * - * @param names - * @return + * @param names - name of sets + * @return size of union */ Publisher> readUnion(String... names); @@ -76,8 +76,8 @@ public interface RSetReactive extends RCollectionReactive { * Diff sets specified by name and write to current set. * If current set already exists, it is overwritten. * - * @param names - * @return + * @param names - name of sets + * @return size of diff */ Publisher diff(String... names); @@ -85,8 +85,8 @@ public interface RSetReactive extends RCollectionReactive { * Intersection sets specified by name and write to current set. * If current set already exists, it is overwritten. * - * @param names - * @return + * @param names - name of sets + * @return size of intersection */ Publisher intersection(String... names); @@ -94,8 +94,8 @@ public interface RSetReactive extends RCollectionReactive { * Intersection sets specified by name with current set. * Without current set state change. * - * @param names - * @return + * @param names - name of sets + * @return values */ Publisher> readIntersection(String... names); diff --git a/redisson/src/main/java/org/redisson/api/RSortedSet.java b/redisson/src/main/java/org/redisson/api/RSortedSet.java index abf3655fe..dc72886d6 100644 --- a/redisson/src/main/java/org/redisson/api/RSortedSet.java +++ b/redisson/src/main/java/org/redisson/api/RSortedSet.java @@ -27,7 +27,7 @@ public interface RSortedSet extends SortedSet, RObject { /** * Sets new comparator only if current set is empty * - * @param comparator + * @param comparator for values * @return true if new comparator setted * false otherwise */ diff --git a/redisson/src/main/java/org/redisson/api/RTopic.java b/redisson/src/main/java/org/redisson/api/RTopic.java index cb709df82..5cc2e2cec 100644 --- a/redisson/src/main/java/org/redisson/api/RTopic.java +++ b/redisson/src/main/java/org/redisson/api/RTopic.java @@ -32,14 +32,14 @@ public interface RTopic extends RTopicAsync { /** * Get topic channel names * - * @return + * @return channel names */ List getChannelNames(); /** * Publish the message to all subscribers of this topic * - * @param message + * @param message to send * @return the number of clients that received the message */ long publish(M message); @@ -49,7 +49,7 @@ public interface RTopic extends RTopicAsync { * MessageListener.onMessage is called when any message * is published on this topic. * - * @param listener + * @param listener for messages * @return locally unique listener id * @see org.redisson.api.listener.MessageListener */ @@ -58,8 +58,8 @@ public interface RTopic extends RTopicAsync { /** * Subscribes to status changes of this topic * - * @param listener - * @return + * @param listener for messages + * @return listener id * @see org.redisson.api.listener.StatusListener */ int addListener(StatusListener listener); @@ -67,7 +67,7 @@ public interface RTopic extends RTopicAsync { /** * Removes the listener by id for listening this topic * - * @param listenerId + * @param listenerId - listener id */ void removeListener(int listenerId); diff --git a/redisson/src/main/java/org/redisson/api/RTopicAsync.java b/redisson/src/main/java/org/redisson/api/RTopicAsync.java index 6229cad53..b676bb807 100644 --- a/redisson/src/main/java/org/redisson/api/RTopicAsync.java +++ b/redisson/src/main/java/org/redisson/api/RTopicAsync.java @@ -27,7 +27,7 @@ public interface RTopicAsync { /** * Publish the message to all subscribers of this topic asynchronously * - * @param message + * @param message to send * @return the RFuture object with number of clients that received the message */ RFuture publishAsync(M message); diff --git a/redisson/src/main/java/org/redisson/api/RTopicReactive.java b/redisson/src/main/java/org/redisson/api/RTopicReactive.java index fd1433f7b..52b5432f3 100644 --- a/redisson/src/main/java/org/redisson/api/RTopicReactive.java +++ b/redisson/src/main/java/org/redisson/api/RTopicReactive.java @@ -35,7 +35,7 @@ public interface RTopicReactive { /** * Publish the message to all subscribers of this topic asynchronously * - * @param message + * @param message to send * @return the Future object with number of clients that received the message */ Publisher publish(M message); diff --git a/redisson/src/main/java/org/redisson/api/listener/MessageListener.java b/redisson/src/main/java/org/redisson/api/listener/MessageListener.java index 9d28e65dc..9b4a0c529 100644 --- a/redisson/src/main/java/org/redisson/api/listener/MessageListener.java +++ b/redisson/src/main/java/org/redisson/api/listener/MessageListener.java @@ -31,6 +31,7 @@ public interface MessageListener extends EventListener { /** * Invokes on every message in topic * + * @param channel of topic * @param msg topic message */ void onMessage(String channel, M msg); diff --git a/redisson/src/main/java/org/redisson/api/listener/PatternMessageListener.java b/redisson/src/main/java/org/redisson/api/listener/PatternMessageListener.java index 8ace2607d..ac4d8797a 100644 --- a/redisson/src/main/java/org/redisson/api/listener/PatternMessageListener.java +++ b/redisson/src/main/java/org/redisson/api/listener/PatternMessageListener.java @@ -31,6 +31,8 @@ public interface PatternMessageListener extends EventListener { /** * Invokes on every message in topic * + * @param pattern of channel name + * @param channel of topic * @param msg topic message */ void onMessage(String pattern, String channel, M msg); diff --git a/redisson/src/main/java/org/redisson/api/listener/StatusListener.java b/redisson/src/main/java/org/redisson/api/listener/StatusListener.java index 138c1abca..77088c38f 100644 --- a/redisson/src/main/java/org/redisson/api/listener/StatusListener.java +++ b/redisson/src/main/java/org/redisson/api/listener/StatusListener.java @@ -30,14 +30,14 @@ public interface StatusListener extends EventListener { * Executes then Redisson successfully subscribed to channel. * Invoked during re-connection * - * @param channel + * @param channel to subscribe */ void onSubscribe(String channel); /** * Executes then Redisson successfully unsubscribed from channel. * - * @param channel + * @param channel to unsubscribe */ void onUnsubscribe(String channel); diff --git a/redisson/src/main/java/org/redisson/client/RedisConnection.java b/redisson/src/main/java/org/redisson/client/RedisConnection.java index 193450496..0d5b37070 100644 --- a/redisson/src/main/java/org/redisson/client/RedisConnection.java +++ b/redisson/src/main/java/org/redisson/client/RedisConnection.java @@ -223,7 +223,8 @@ public class RedisConnection implements RedisCommands { /** * Access to Netty channel. * This method is provided to use in debug info only. - * + * + * @return channel */ public Channel getChannel() { return channel; diff --git a/redisson/src/main/java/org/redisson/client/codec/Codec.java b/redisson/src/main/java/org/redisson/client/codec/Codec.java index cfb90d08c..c7813c284 100644 --- a/redisson/src/main/java/org/redisson/client/codec/Codec.java +++ b/redisson/src/main/java/org/redisson/client/codec/Codec.java @@ -29,42 +29,42 @@ public interface Codec { /** * Returns object decoder used for hash map values in HMAP Redis structure * - * @return + * @return decoder */ Decoder getMapValueDecoder(); /** * Returns object encoder used for hash map values in HMAP Redis structure * - * @return + * @return encoder */ Encoder getMapValueEncoder(); /** * Returns object decoder used for hash map keys in HMAP Redis structure * - * @return + * @return decoder */ Decoder getMapKeyDecoder(); /** * Returns object encoder used for hash map keys in HMAP Redis structure * - * @return + * @return encoder */ Encoder getMapKeyEncoder(); /** * Returns object decoder used for any objects stored Redis structure except HMAP * - * @return + * @return decoder */ Decoder getValueDecoder(); /** * Returns object encoder used for any objects stored Redis structure except HMAP * - * @return + * @return encoder */ Encoder getValueEncoder(); diff --git a/redisson/src/main/java/org/redisson/codec/CborJacksonCodec.java b/redisson/src/main/java/org/redisson/codec/CborJacksonCodec.java index dfe6c0923..c9440de69 100644 --- a/redisson/src/main/java/org/redisson/codec/CborJacksonCodec.java +++ b/redisson/src/main/java/org/redisson/codec/CborJacksonCodec.java @@ -21,7 +21,7 @@ import com.fasterxml.jackson.dataformat.cbor.CBORFactory; /** * * @author Faye Li - * @date 2015-10-16 + * */ public class CborJacksonCodec extends JsonJacksonCodec { diff --git a/redisson/src/main/java/org/redisson/codec/LZ4Codec.java b/redisson/src/main/java/org/redisson/codec/LZ4Codec.java index e53f4ebde..c0a358261 100644 --- a/redisson/src/main/java/org/redisson/codec/LZ4Codec.java +++ b/redisson/src/main/java/org/redisson/codec/LZ4Codec.java @@ -30,8 +30,8 @@ import net.jpountz.lz4.LZ4SafeDecompressor; /** * LZ4 compression codec. - * Uses inner Codec to convert object to binary stream. - * FstCodec used by default. + * Uses inner Codec to convert object to binary stream. + * FstCodec used by default. * * https://github.com/jpountz/lz4-java * diff --git a/redisson/src/main/java/org/redisson/codec/SnappyCodec.java b/redisson/src/main/java/org/redisson/codec/SnappyCodec.java index bb6ef4a28..7dea45be8 100644 --- a/redisson/src/main/java/org/redisson/codec/SnappyCodec.java +++ b/redisson/src/main/java/org/redisson/codec/SnappyCodec.java @@ -28,8 +28,8 @@ import io.netty.buffer.Unpooled; /** * Snappy compression codec. - * Uses inner Codec to convert object to binary stream. - * FstCodec used by default. + * Uses inner Codec to convert object to binary stream. + * FstCodec used by default. * * https://github.com/xerial/snappy-java * diff --git a/redisson/src/main/java/org/redisson/config/BaseConfig.java b/redisson/src/main/java/org/redisson/config/BaseConfig.java index 817e93642..f4b98a65f 100644 --- a/redisson/src/main/java/org/redisson/config/BaseConfig.java +++ b/redisson/src/main/java/org/redisson/config/BaseConfig.java @@ -15,6 +15,12 @@ */ package org.redisson.config; +/** + * + * @author Nikita Koksharov + * + * @param config type + */ class BaseConfig> { /** @@ -106,7 +112,8 @@ class BaseConfig> { * Subscriptions per Redis connection limit * Default is 5 * - * @param subscriptionsPerConnection + * @param subscriptionsPerConnection amount + * @return config */ public T setSubscriptionsPerConnection(int subscriptionsPerConnection) { this.subscriptionsPerConnection = subscriptionsPerConnection; @@ -121,7 +128,8 @@ class BaseConfig> { * Password for Redis authentication. Should be null if not needed * Default is null * - * @param password + * @param password for connection + * @return config */ public T setPassword(String password) { this.password = password; @@ -139,7 +147,8 @@ class BaseConfig> { * Default is 3 attempts * * @see #timeout - * @param retryAttempts + * @param retryAttempts - retry attempts + * @return config */ public T setRetryAttempts(int retryAttempts) { this.retryAttempts = retryAttempts; @@ -157,6 +166,7 @@ class BaseConfig> { * * @see retryAttempts * @param retryInterval - time in milliseconds + * @return config */ public T setRetryInterval(int retryInterval) { this.retryInterval = retryInterval; @@ -173,6 +183,7 @@ class BaseConfig> { * Default is 3000 milliseconds * * @param timeout in milliseconds + * @return config */ public T setTimeout(int timeout) { this.timeout = timeout; @@ -187,7 +198,8 @@ class BaseConfig> { * Setup connection name during connection init * via CLIENT SETNAME command * - * @param name + * @param clientName - name of client + * @return config */ public T setClientName(String clientName) { this.clientName = clientName; @@ -199,9 +211,10 @@ class BaseConfig> { } /** - * Ping timeout used in Node.ping and Node.pingAll operation + * Ping timeout used in Node.ping and Node.pingAll operation * - * @param ping timeout in milliseconds + * @param pingTimeout - timeout in milliseconds + * @return config */ public T setPingTimeout(int pingTimeout) { this.pingTimeout = pingTimeout; @@ -218,7 +231,7 @@ class BaseConfig> { * Default is 10000 milliseconds. * * @param connectTimeout - timeout in milliseconds - * @return + * @return config */ public T setConnectTimeout(int connectTimeout) { this.connectTimeout = connectTimeout; @@ -235,7 +248,7 @@ class BaseConfig> { * then it will closed and removed from pool. * * @param idleConnectionTimeout - timeout in milliseconds - * @return + * @return config */ public T setIdleConnectionTimeout(int idleConnectionTimeout) { this.idleConnectionTimeout = idleConnectionTimeout; @@ -257,6 +270,8 @@ class BaseConfig> { * * @see #failedAttempts * + * @param slaveRetryTimeout - retry timeout in milliseconds + * @return config */ public T setReconnectionTimeout(int slaveRetryTimeout) { @@ -275,6 +290,8 @@ class BaseConfig> { *

* Default is 3 * + * @param slaveFailedAttempts - attempts + * @return config */ public T setFailedAttempts(int slaveFailedAttempts) { this.failedAttempts = slaveFailedAttempts; diff --git a/redisson/src/main/java/org/redisson/config/BaseMasterSlaveServersConfig.java b/redisson/src/main/java/org/redisson/config/BaseMasterSlaveServersConfig.java index 55e49dc2b..6f9f23984 100644 --- a/redisson/src/main/java/org/redisson/config/BaseMasterSlaveServersConfig.java +++ b/redisson/src/main/java/org/redisson/config/BaseMasterSlaveServersConfig.java @@ -18,6 +18,12 @@ package org.redisson.config; import org.redisson.connection.balancer.LoadBalancer; import org.redisson.connection.balancer.RoundRobinLoadBalancer; +/** + * + * @author Nikita Koksharov + * + * @param config type + */ public class BaseMasterSlaveServersConfig> extends BaseConfig { /** @@ -79,8 +85,8 @@ public class BaseMasterSlaveServersConfig * @see #setSlaveConnectionMinimumIdleSize(int) * - * @param slaveConnectionPoolSize - * @return + * @param slaveConnectionPoolSize - size of pool + * @return config */ public T setSlaveConnectionPoolSize(int slaveConnectionPoolSize) { this.slaveConnectionPoolSize = slaveConnectionPoolSize; @@ -96,6 +102,9 @@ public class BaseMasterSlaveServersConfig250 * * @see #setMasterConnectionMinimumIdleSize(int) + * + * @param masterConnectionPoolSize - pool size + * @return config * */ public T setMasterConnectionPoolSize(int masterConnectionPoolSize) { @@ -110,11 +119,12 @@ public class BaseMasterSlaveServersConfig50 *

* @see #setSlaveSubscriptionConnectionMinimumIdleSize(int) - * + * + * @param slaveSubscriptionConnectionPoolSize - pool size + * @return config */ public T setSlaveSubscriptionConnectionPoolSize(int slaveSubscriptionConnectionPoolSize) { this.slaveSubscriptionConnectionPoolSize = slaveSubscriptionConnectionPoolSize; @@ -146,7 +158,9 @@ public class BaseMasterSlaveServersConfig5 *

* @see #setSlaveConnectionPoolSize(int) - * + * + * @param slaveConnectionMinimumIdleSize - pool size + * @return config */ public T setSlaveConnectionMinimumIdleSize(int slaveConnectionMinimumIdleSize) { this.slaveConnectionMinimumIdleSize = slaveConnectionMinimumIdleSize; @@ -162,7 +176,9 @@ public class BaseMasterSlaveServersConfig5 *

* @see #setMasterConnectionPoolSize(int) - * + * + * @param masterConnectionMinimumIdleSize - pool size + * @return config */ public T setMasterConnectionMinimumIdleSize(int masterConnectionMinimumIdleSize) { this.masterConnectionMinimumIdleSize = masterConnectionMinimumIdleSize; @@ -178,7 +194,9 @@ public class BaseMasterSlaveServersConfig1 *

* @see #setSlaveSubscriptionConnectionPoolSize(int) - * + * + * @param slaveSubscriptionConnectionMinimumIdleSize - pool size + * @return config */ public T setSlaveSubscriptionConnectionMinimumIdleSize(int slaveSubscriptionConnectionMinimumIdleSize) { this.slaveSubscriptionConnectionMinimumIdleSize = slaveSubscriptionConnectionMinimumIdleSize; @@ -193,8 +211,8 @@ public class BaseMasterSlaveServersConfig * Default is SLAVE * - * @param readMode - * @return + * @param readMode param + * @return config */ public T setReadMode(ReadMode readMode) { this.readMode = readMode; diff --git a/redisson/src/main/java/org/redisson/config/ClusterServersConfig.java b/redisson/src/main/java/org/redisson/config/ClusterServersConfig.java index c4c74dd01..dbe81d257 100644 --- a/redisson/src/main/java/org/redisson/config/ClusterServersConfig.java +++ b/redisson/src/main/java/org/redisson/config/ClusterServersConfig.java @@ -46,7 +46,7 @@ public class ClusterServersConfig extends BaseMasterSlaveServersConfighost:port * * @param addresses in host:port format - * @return + * @return config */ public ClusterServersConfig addNodeAddress(String ... addresses) { for (String address : addresses) { @@ -68,7 +68,7 @@ public class ClusterServersConfig extends BaseMasterSlaveServersConfig + * Default value is true * - * @return boolean + * @return true if Redisson Reference feature enabled */ public boolean isRedissonReferenceEnabled() { return redissonReferenceEnabled; @@ -188,8 +191,10 @@ public class Config { /** * Config option for enabling Redisson Reference feature - * Default value is TRUE - * @param redissonReferenceEnabled + *

+ * Default value is true + * + * @param redissonReferenceEnabled flag */ public void setRedissonReferenceEnabled(boolean redissonReferenceEnabled) { this.redissonReferenceEnabled = redissonReferenceEnabled; @@ -198,7 +203,7 @@ public class Config { /** * Init cluster servers configuration * - * @return + * @return config */ public ClusterServersConfig useClusterServers() { return useClusterServers(new ClusterServersConfig()); @@ -227,7 +232,7 @@ public class Config { /** * Init AWS Elasticache servers configuration. * - * @return + * @return ElasticacheServersConfig */ public ElasticacheServersConfig useElasticacheServers() { return useElasticacheServers(new ElasticacheServersConfig()); @@ -256,7 +261,7 @@ public class Config { /** * Init single server configuration. * - * @return + * @return SingleServerConfig */ public SingleServerConfig useSingleServer() { return useSingleServer(new SingleServerConfig()); @@ -285,18 +290,13 @@ public class Config { /** * Init sentinel servers configuration. * - * @return + * @return SentinelServersConfig */ public SentinelServersConfig useSentinelServers() { return useSentinelServers(new SentinelServersConfig()); } - /** - * Init sentinel servers configuration by config object. - * - * @return - */ - public SentinelServersConfig useSentinelServers(SentinelServersConfig sentinelServersConfig) { + SentinelServersConfig useSentinelServers(SentinelServersConfig sentinelServersConfig) { checkClusterServersConfig(); checkSingleServerConfig(); checkMasterSlaveServersConfig(); @@ -319,18 +319,13 @@ public class Config { /** * Init master/slave servers configuration. * - * @return + * @return MasterSlaveServersConfig */ public MasterSlaveServersConfig useMasterSlaveServers() { return useMasterSlaveServers(new MasterSlaveServersConfig()); } - /** - * Init master/slave servers configuration by config object. - * - * @return - */ - public MasterSlaveServersConfig useMasterSlaveServers(MasterSlaveServersConfig config) { + MasterSlaveServersConfig useMasterSlaveServers(MasterSlaveServersConfig config) { checkClusterServersConfig(); checkSingleServerConfig(); checkSentinelServersConfig(); @@ -367,8 +362,8 @@ public class Config { *

* 0 means current_processors_amount * 2 * - * @param threads - * @return + * @param threads amount + * @return config */ public Config setThreads(int threads) { this.threads = threads; @@ -410,8 +405,8 @@ public class Config { * Also used for epoll transport activation. * netty-transport-native-epoll library should be in classpath * - * @param useLinuxNativeEpoll - * @return + * @param useLinuxNativeEpoll flag + * @return config */ public Config setUseLinuxNativeEpoll(boolean useLinuxNativeEpoll) { this.useLinuxNativeEpoll = useLinuxNativeEpoll; @@ -429,8 +424,8 @@ public class Config { *

* 0 means current_processors_amount * 2 * - * @param nettyThreads - * @return + * @param nettyThreads amount + * @return config */ public Config setNettyThreads(int nettyThreads) { this.nettyThreads = nettyThreads; @@ -447,8 +442,8 @@ public class Config { * RRemoteService invocation handlers * and RExecutorService tasks. * - * @param executor - * @return + * @param executor object + * @return config */ public Config setExecutor(ExecutorService executor) { this.executor = executor; @@ -469,8 +464,8 @@ public class Config { * Only {@link io.netty.channel.epoll.EpollEventLoopGroup} or * {@link io.netty.channel.nio.NioEventLoopGroup} can be used. * - * @param eventLoopGroup - * @return + * @param eventLoopGroup object + * @return config */ public Config setEventLoopGroup(EventLoopGroup eventLoopGroup) { this.eventLoopGroup = eventLoopGroup; @@ -484,9 +479,9 @@ public class Config { /** * Read config object stored in JSON format from String * - * @param content - * @return - * @throws IOException + * @param content of config + * @return config + * @throws IOException error */ public static Config fromJSON(String content) throws IOException { ConfigSupport support = new ConfigSupport(); @@ -496,9 +491,9 @@ public class Config { /** * Read config object stored in JSON format from InputStream * - * @param inputStream - * @return - * @throws IOException + * @param inputStream object + * @return config + * @throws IOException error */ public static Config fromJSON(InputStream inputStream) throws IOException { ConfigSupport support = new ConfigSupport(); @@ -508,9 +503,9 @@ public class Config { /** * Read config object stored in JSON format from File * - * @param file - * @return - * @throws IOException + * @param file object + * @return config + * @throws IOException error */ public static Config fromJSON(File file) throws IOException { ConfigSupport support = new ConfigSupport(); @@ -520,9 +515,9 @@ public class Config { /** * Read config object stored in JSON format from URL * - * @param url - * @return - * @throws IOException + * @param url object + * @return config + * @throws IOException error */ public static Config fromJSON(URL url) throws IOException { ConfigSupport support = new ConfigSupport(); @@ -532,9 +527,9 @@ public class Config { /** * Read config object stored in JSON format from Reader * - * @param reader - * @return - * @throws IOException + * @param reader object + * @return config + * @throws IOException error */ public static Config fromJSON(Reader reader) throws IOException { ConfigSupport support = new ConfigSupport(); @@ -544,8 +539,8 @@ public class Config { /** * Convert current configuration to JSON format * - * @return - * @throws IOException + * @return config in json format + * @throws IOException error */ public String toJSON() throws IOException { ConfigSupport support = new ConfigSupport(); @@ -555,9 +550,9 @@ public class Config { /** * Read config object stored in YAML format from String * - * @param content - * @return - * @throws IOException + * @param content of config + * @return config + * @throws IOException error */ public static Config fromYAML(String content) throws IOException { ConfigSupport support = new ConfigSupport(); @@ -567,9 +562,9 @@ public class Config { /** * Read config object stored in YAML format from InputStream * - * @param inputStream - * @return - * @throws IOException + * @param inputStream object + * @return config + * @throws IOException error */ public static Config fromYAML(InputStream inputStream) throws IOException { ConfigSupport support = new ConfigSupport(); @@ -579,9 +574,9 @@ public class Config { /** * Read config object stored in YAML format from File * - * @param file - * @return - * @throws IOException + * @param file object + * @return config + * @throws IOException error */ public static Config fromYAML(File file) throws IOException { ConfigSupport support = new ConfigSupport(); @@ -591,9 +586,9 @@ public class Config { /** * Read config object stored in YAML format from URL * - * @param url - * @return - * @throws IOException + * @param url object + * @return config + * @throws IOException error */ public static Config fromYAML(URL url) throws IOException { ConfigSupport support = new ConfigSupport(); @@ -603,9 +598,9 @@ public class Config { /** * Read config object stored in YAML format from Reader * - * @param reader - * @return - * @throws IOException + * @param reader object + * @return config + * @throws IOException error */ public static Config fromYAML(Reader reader) throws IOException { ConfigSupport support = new ConfigSupport(); @@ -615,8 +610,8 @@ public class Config { /** * Convert current configuration to YAML format * - * @return - * @throws IOException + * @return config in yaml format + * @throws IOException error */ public String toYAML() throws IOException { ConfigSupport support = new ConfigSupport(); diff --git a/redisson/src/main/java/org/redisson/config/ElasticacheServersConfig.java b/redisson/src/main/java/org/redisson/config/ElasticacheServersConfig.java index 2660b4861..8e35a5d50 100644 --- a/redisson/src/main/java/org/redisson/config/ElasticacheServersConfig.java +++ b/redisson/src/main/java/org/redisson/config/ElasticacheServersConfig.java @@ -58,7 +58,7 @@ public class ElasticacheServersConfig extends BaseMasterSlaveServersConfighost:port * * @param addresses in host:port format - * @return + * @return config */ public ElasticacheServersConfig addNodeAddress(String ... addresses) { for (String address : addresses) { @@ -80,7 +80,7 @@ public class ElasticacheServersConfig extends BaseMasterSlaveServersConfig0 * - * @param database + * @param database number + * @return config */ public ElasticacheServersConfig setDatabase(int database) { this.database = database; diff --git a/redisson/src/main/java/org/redisson/config/MasterSlaveServersConfig.java b/redisson/src/main/java/org/redisson/config/MasterSlaveServersConfig.java index de58ce067..1cb5a7485 100644 --- a/redisson/src/main/java/org/redisson/config/MasterSlaveServersConfig.java +++ b/redisson/src/main/java/org/redisson/config/MasterSlaveServersConfig.java @@ -54,7 +54,8 @@ public class MasterSlaveServersConfig extends BaseMasterSlaveServersConfig0 * - * @param database + * @param database number + * @return config */ public MasterSlaveServersConfig setDatabase(int database) { this.database = database; diff --git a/redisson/src/main/java/org/redisson/config/RedissonNodeConfig.java b/redisson/src/main/java/org/redisson/config/RedissonNodeConfig.java index 95a7d0506..4facf4e65 100644 --- a/redisson/src/main/java/org/redisson/config/RedissonNodeConfig.java +++ b/redisson/src/main/java/org/redisson/config/RedissonNodeConfig.java @@ -49,8 +49,8 @@ public class RedissonNodeConfig extends Config { /** * Executor service workers amount per service name * - * @param workers - * @return + * @param workers mapping + * @return config */ public RedissonNodeConfig setExecutorServiceWorkers(Map workers) { this.executorServiceWorkers = workers; @@ -67,8 +67,8 @@ public class RedissonNodeConfig extends Config { /** * Redisson node initializer * - * @param redissonNodeInitializer - * @return + * @param redissonNodeInitializer object + * @return config */ public RedissonNodeConfig setRedissonNodeInitializer(RedissonNodeInitializer redissonNodeInitializer) { this.redissonNodeInitializer = redissonNodeInitializer; @@ -78,9 +78,9 @@ public class RedissonNodeConfig extends Config { /** * Read config object stored in JSON format from File * - * @param file - * @return - * @throws IOException + * @param file object + * @return config + * @throws IOException error */ public static RedissonNodeConfig fromJSON(File file) throws IOException { ConfigSupport support = new ConfigSupport(); @@ -90,9 +90,9 @@ public class RedissonNodeConfig extends Config { /** * Read config object stored in YAML format from File * - * @param file - * @return - * @throws IOException + * @param file object + * @return config + * @throws IOException error */ public static RedissonNodeConfig fromYAML(File file) throws IOException { ConfigSupport support = new ConfigSupport(); diff --git a/redisson/src/main/java/org/redisson/config/SentinelServersConfig.java b/redisson/src/main/java/org/redisson/config/SentinelServersConfig.java index 17e9e8694..c86abd8cf 100644 --- a/redisson/src/main/java/org/redisson/config/SentinelServersConfig.java +++ b/redisson/src/main/java/org/redisson/config/SentinelServersConfig.java @@ -45,8 +45,8 @@ public class SentinelServersConfig extends BaseMasterSlaveServersConfig0 * - * @param database + * @param database number + * @return config */ public SentinelServersConfig setDatabase(int database) { this.database = database; diff --git a/redisson/src/main/java/org/redisson/config/SingleServerConfig.java b/redisson/src/main/java/org/redisson/config/SingleServerConfig.java index fdb94208a..5aaece686 100644 --- a/redisson/src/main/java/org/redisson/config/SingleServerConfig.java +++ b/redisson/src/main/java/org/redisson/config/SingleServerConfig.java @@ -21,6 +21,11 @@ import java.util.List; import org.redisson.misc.URIBuilder; +/** + * + * @author Nikita Koksharov + * + */ public class SingleServerConfig extends BaseConfig { /** @@ -86,9 +91,11 @@ public class SingleServerConfig extends BaseConfig { /** * Redis connection pool size - * Default is 250 + *

+ * Default is 250 * - * @param connectionPoolSize + * @param connectionPoolSize - pool size + * @return config */ public SingleServerConfig setConnectionPoolSize(int connectionPoolSize) { this.connectionPoolSize = connectionPoolSize; @@ -100,10 +107,11 @@ public class SingleServerConfig extends BaseConfig { /** * Redis subscription-connection pool size limit + *

* Default is 50 * - * @param connectionPoolSize - * @return + * @param subscriptionConnectionPoolSize - pool size + * @return config */ public SingleServerConfig setSubscriptionConnectionPoolSize(int subscriptionConnectionPoolSize) { this.subscriptionConnectionPoolSize = subscriptionConnectionPoolSize; @@ -116,7 +124,8 @@ public class SingleServerConfig extends BaseConfig { /** * Set server address. Use follow format -- host:port * - * @param address + * @param address of Redis + * @return config */ public SingleServerConfig setAddress(String address) { if (address != null) { @@ -141,8 +150,8 @@ public class SingleServerConfig extends BaseConfig { * * Default is false * - * @param dnsMonitoring - * @return + * @param dnsMonitoring flag + * @return config */ public SingleServerConfig setDnsMonitoring(boolean dnsMonitoring) { this.dnsMonitoring = dnsMonitoring; @@ -157,8 +166,8 @@ public class SingleServerConfig extends BaseConfig { * * Default is 5000 * - * @param dnsMonitoringInterval - * @return + * @param dnsMonitoringInterval time + * @return config */ public SingleServerConfig setDnsMonitoringInterval(long dnsMonitoringInterval) { this.dnsMonitoringInterval = dnsMonitoringInterval; @@ -170,8 +179,11 @@ public class SingleServerConfig extends BaseConfig { /** * Minimum idle subscription connection amount. - * + *

* Default is 1 + * + * @param subscriptionConnectionMinimumIdleSize - connections amount + * @return config * */ public SingleServerConfig setSubscriptionConnectionMinimumIdleSize(int subscriptionConnectionMinimumIdleSize) { @@ -184,9 +196,11 @@ public class SingleServerConfig extends BaseConfig { /** * Minimum idle Redis connection amount. - * + *

* Default is 5 * + * @param connectionMinimumIdleSize - connections amount + * @return config */ public SingleServerConfig setConnectionMinimumIdleSize(int connectionMinimumIdleSize) { this.connectionMinimumIdleSize = connectionMinimumIdleSize; @@ -200,7 +214,8 @@ public class SingleServerConfig extends BaseConfig { * Database index used for Redis connection * Default is 0 * - * @param database + * @param database index + * @return config */ public SingleServerConfig setDatabase(int database) { this.database = database; diff --git a/redisson/src/main/java/org/redisson/connection/CRC16.java b/redisson/src/main/java/org/redisson/connection/CRC16.java index a2db447e9..712cfa4aa 100644 --- a/redisson/src/main/java/org/redisson/connection/CRC16.java +++ b/redisson/src/main/java/org/redisson/connection/CRC16.java @@ -46,12 +46,6 @@ public class CRC16 { private CRC16() { } - /** - * Create a CRC16 checksum from the bytes. - * - * @param bytes - * @return CRC16 as interger value - */ public static int crc16(byte[] bytes) { int crc = 0x0000; diff --git a/redisson/src/main/java/org/redisson/connection/MasterSlaveEntry.java b/redisson/src/main/java/org/redisson/connection/MasterSlaveEntry.java index 8447af8c8..bad7ef82a 100644 --- a/redisson/src/main/java/org/redisson/connection/MasterSlaveEntry.java +++ b/redisson/src/main/java/org/redisson/connection/MasterSlaveEntry.java @@ -312,7 +312,9 @@ public class MasterSlaveEntry { * Freeze slave with host:port from slaves list. * Re-attach pub/sub listeners from it to other slave. * Shutdown old master client. - * + * + * @param host of Redis + * @param port of Redis */ public void changeMaster(String host, int port) { ClientConnectionsEntry oldMaster = masterEntry; diff --git a/redisson/src/main/java/org/redisson/connection/balancer/RandomLoadBalancer.java b/redisson/src/main/java/org/redisson/connection/balancer/RandomLoadBalancer.java index ab6c77c7d..358cf3a37 100644 --- a/redisson/src/main/java/org/redisson/connection/balancer/RandomLoadBalancer.java +++ b/redisson/src/main/java/org/redisson/connection/balancer/RandomLoadBalancer.java @@ -21,6 +21,11 @@ import java.util.Random; import org.redisson.connection.ClientConnectionsEntry; +/** + * + * @author Nikita Koksharov + * + */ public class RandomLoadBalancer implements LoadBalancer { private final Random random = new SecureRandom(); diff --git a/redisson/src/main/java/org/redisson/connection/balancer/RoundRobinLoadBalancer.java b/redisson/src/main/java/org/redisson/connection/balancer/RoundRobinLoadBalancer.java index b1a83b0ac..a8bebf87d 100644 --- a/redisson/src/main/java/org/redisson/connection/balancer/RoundRobinLoadBalancer.java +++ b/redisson/src/main/java/org/redisson/connection/balancer/RoundRobinLoadBalancer.java @@ -20,6 +20,11 @@ import java.util.concurrent.atomic.AtomicInteger; import org.redisson.connection.ClientConnectionsEntry; +/** + * + * @author Nikita Koksharov + * + */ public class RoundRobinLoadBalancer implements LoadBalancer { private final AtomicInteger index = new AtomicInteger(-1); diff --git a/redisson/src/main/java/org/redisson/executor/CronExpression.java b/redisson/src/main/java/org/redisson/executor/CronExpression.java index d5016af02..3fe3effdb 100644 --- a/redisson/src/main/java/org/redisson/executor/CronExpression.java +++ b/redisson/src/main/java/org/redisson/executor/CronExpression.java @@ -117,9 +117,6 @@ public final class CronExpression implements Serializable, Cloneable { * * @param cronExpression String representation of the cron expression the * new object should represent - * @throws java.text.ParseException - * if the string expression cannot be parsed into a valid - * CronExpression */ public CronExpression(String cronExpression) { if (cronExpression == null) { @@ -235,6 +232,8 @@ public final class CronExpression implements Serializable, Cloneable { /** * Returns the time zone for which this CronExpression * will be resolved. + * + * @return time zone */ public TimeZone getTimeZone() { if (timeZone == null) { @@ -247,6 +246,8 @@ public final class CronExpression implements Serializable, Cloneable { /** * Sets the time zone for which this CronExpression * will be resolved. + * + * @param timeZone object */ public void setTimeZone(TimeZone timeZone) { this.timeZone = timeZone; @@ -1434,19 +1435,11 @@ public final class CronExpression implements Serializable, Cloneable { } } - /** - * NOT YET IMPLEMENTED: Returns the time before the given time - * that the CronExpression matches. - */ public Date getTimeBefore(Date endTime) { // FUTURE_TODO: implement QUARTZ-423 return null; } - /** - * NOT YET IMPLEMENTED: Returns the final time that the - * CronExpression will match. - */ public Date getFinalFireTime() { // FUTURE_TODO: implement QUARTZ-423 return null; diff --git a/redisson/src/main/java/org/redisson/executor/RedissonScheduledFuture.java b/redisson/src/main/java/org/redisson/executor/RedissonScheduledFuture.java index 4dbf1a7f9..6c53c0db4 100644 --- a/redisson/src/main/java/org/redisson/executor/RedissonScheduledFuture.java +++ b/redisson/src/main/java/org/redisson/executor/RedissonScheduledFuture.java @@ -25,7 +25,7 @@ import org.redisson.misc.PromiseDelegator; * * @author Nikita Koksharov * - * @param + * @param value */ public class RedissonScheduledFuture extends PromiseDelegator implements RScheduledFuture { diff --git a/redisson/src/main/java/org/redisson/liveobject/misc/ClassUtils.java b/redisson/src/main/java/org/redisson/liveobject/misc/ClassUtils.java index ea2267215..f711f3acd 100644 --- a/redisson/src/main/java/org/redisson/liveobject/misc/ClassUtils.java +++ b/redisson/src/main/java/org/redisson/liveobject/misc/ClassUtils.java @@ -60,6 +60,12 @@ public class ClassUtils { * findConstructor() method and has the similar limitations that it doesn't * do a real widening scope search and simply processes the methods in * order. + * + * @param type param + * @param name of class + * @param parms classes + * + * @return Method object */ public static Method searchForMethod(Class type, String name, Class[] parms) { try { @@ -107,6 +113,9 @@ public class ClassUtils { * If this specified class represents a primitive type (int, float, etc.) * then it is translated into its wrapper type (Integer, Float, etc.). If * the passed class is not a primitive then it is just returned. + * + * @param primitive class + * @return class */ private static Class translateFromPrimitive(Class primitive) { if (!primitive.isPrimitive()) { diff --git a/redisson/src/main/java/org/redisson/liveobject/provider/ResolverProvider.java b/redisson/src/main/java/org/redisson/liveobject/provider/ResolverProvider.java index 08a289e6f..212a71416 100644 --- a/redisson/src/main/java/org/redisson/liveobject/provider/ResolverProvider.java +++ b/redisson/src/main/java/org/redisson/liveobject/provider/ResolverProvider.java @@ -40,9 +40,9 @@ public interface ResolverProvider { * To register a resolver based on the the class it can provide value to, * the resolver type, the resolver instance to be cached. * - * @param cls - * @param resolverClass - * @param resolver + * @param cls object + * @param resolverClass object + * @param resolver object */ void registerResolver(Class cls, Class resolverClass, Resolver resolver); diff --git a/redisson/src/main/java/org/redisson/liveobject/resolver/RIdResolver.java b/redisson/src/main/java/org/redisson/liveobject/resolver/RIdResolver.java index 16114ef36..4b894dcc2 100644 --- a/redisson/src/main/java/org/redisson/liveobject/resolver/RIdResolver.java +++ b/redisson/src/main/java/org/redisson/liveobject/resolver/RIdResolver.java @@ -32,7 +32,7 @@ public interface RIdResolver extends Resolver{ * * @param cls the class of the LiveObject. * @param annotation the RId annotation used in the class. - * @param redisson + * @param redisson instance * @return resolved RId field value. */ public V resolve(Class cls, A annotation, String idFieldName, RedissonClient redisson); diff --git a/redisson/src/main/java/org/redisson/liveobject/resolver/Resolver.java b/redisson/src/main/java/org/redisson/liveobject/resolver/Resolver.java index 146c1f701..bbb33ee51 100644 --- a/redisson/src/main/java/org/redisson/liveobject/resolver/Resolver.java +++ b/redisson/src/main/java/org/redisson/liveobject/resolver/Resolver.java @@ -34,10 +34,10 @@ public interface Resolver { * * Actual behavior may vary depending on implementation * - * @param value - * @param annotation - * @param idFieldName - * @param redisson + * @param value object + * @param annotation object + * @param idFieldName name of field + * @param redisson instance * @return resolved value */ public V resolve(T value, A annotation, String idFieldName, RedissonClient redisson); diff --git a/redisson/src/main/java/org/redisson/misc/AbstractCacheMap.java b/redisson/src/main/java/org/redisson/misc/AbstractCacheMap.java index 78ab10e52..75fecc81c 100644 --- a/redisson/src/main/java/org/redisson/misc/AbstractCacheMap.java +++ b/redisson/src/main/java/org/redisson/misc/AbstractCacheMap.java @@ -32,8 +32,8 @@ import io.netty.util.internal.PlatformDependent; * * @author Nikita Koksharov * - * @param - * @param + * @param key + * @param value */ public abstract class AbstractCacheMap implements Cache { diff --git a/redisson/src/main/java/org/redisson/misc/BiHashMap.java b/redisson/src/main/java/org/redisson/misc/BiHashMap.java index 5aafb0d72..a2129907e 100644 --- a/redisson/src/main/java/org/redisson/misc/BiHashMap.java +++ b/redisson/src/main/java/org/redisson/misc/BiHashMap.java @@ -25,8 +25,8 @@ import java.util.Set; * This is not a concurrent map. * * @author Rui Gu (https://github.com/jackygurui) - * @param - * @param + * @param key + * @param value */ public class BiHashMap implements Map { diff --git a/redisson/src/main/java/org/redisson/misc/Cache.java b/redisson/src/main/java/org/redisson/misc/Cache.java index f3a64c4ca..2856da98b 100644 --- a/redisson/src/main/java/org/redisson/misc/Cache.java +++ b/redisson/src/main/java/org/redisson/misc/Cache.java @@ -22,8 +22,8 @@ import java.util.concurrent.TimeUnit; * * @author Nikita Koksharov * - * @param - * @param + * @param key + * @param valu */ public interface Cache extends Map { diff --git a/redisson/src/main/java/org/redisson/misc/LFUCacheMap.java b/redisson/src/main/java/org/redisson/misc/LFUCacheMap.java index 49b6a2d1d..720b46088 100644 --- a/redisson/src/main/java/org/redisson/misc/LFUCacheMap.java +++ b/redisson/src/main/java/org/redisson/misc/LFUCacheMap.java @@ -25,8 +25,8 @@ import java.util.concurrent.atomic.AtomicLong; * * @author Nikita Koksharov * - * @param - * @param + * @param key + * @param value */ public class LFUCacheMap extends AbstractCacheMap { diff --git a/redisson/src/main/java/org/redisson/misc/LRUCacheMap.java b/redisson/src/main/java/org/redisson/misc/LRUCacheMap.java index 112190b6c..8ba4368c1 100644 --- a/redisson/src/main/java/org/redisson/misc/LRUCacheMap.java +++ b/redisson/src/main/java/org/redisson/misc/LRUCacheMap.java @@ -23,8 +23,8 @@ import java.util.concurrent.ConcurrentLinkedQueue; * * @author Nikita Koksharov * - * @param - * @param + * @param key + * @param value */ public class LRUCacheMap extends AbstractCacheMap { diff --git a/redisson/src/main/java/org/redisson/misc/NoneCacheMap.java b/redisson/src/main/java/org/redisson/misc/NoneCacheMap.java index e6533defa..9b71681f0 100644 --- a/redisson/src/main/java/org/redisson/misc/NoneCacheMap.java +++ b/redisson/src/main/java/org/redisson/misc/NoneCacheMap.java @@ -19,8 +19,8 @@ package org.redisson.misc; * * @author Nikita Koksharov * - * @param - * @param + * @param key + * @param value */ public class NoneCacheMap extends AbstractCacheMap { diff --git a/redisson/src/main/java/org/redisson/misc/RPromise.java b/redisson/src/main/java/org/redisson/misc/RPromise.java index 1f94ee9c8..ec52b8086 100644 --- a/redisson/src/main/java/org/redisson/misc/RPromise.java +++ b/redisson/src/main/java/org/redisson/misc/RPromise.java @@ -24,14 +24,15 @@ import io.netty.util.concurrent.Promise; * * @author Nikita Koksharov * - * @param + * @param type */ public interface RPromise extends RFuture { /** * Marks this future as a success and notifies all * listeners. - * + * + * @param result object * @return {@code true} if and only if successfully marked this future as * a success. Otherwise {@code false} because this future is * already marked as either a success or a failure. @@ -41,7 +42,8 @@ public interface RPromise extends RFuture { /** * Marks this future as a failure and notifies all * listeners. - * + * + * @param cause object * @return {@code true} if and only if successfully marked this future as * a failure. Otherwise {@code false} because this future is * already marked as either a success or a failure. diff --git a/redisson/src/main/java/org/redisson/misc/RedissonPromise.java b/redisson/src/main/java/org/redisson/misc/RedissonPromise.java index ecc76eee3..765266595 100644 --- a/redisson/src/main/java/org/redisson/misc/RedissonPromise.java +++ b/redisson/src/main/java/org/redisson/misc/RedissonPromise.java @@ -29,7 +29,7 @@ import io.netty.util.concurrent.Promise; * * @author Nikita Koksharov * - * @param + * @param type of object */ public class RedissonPromise implements RPromise { diff --git a/redisson/src/main/java/org/redisson/pubsub/TransferListener.java b/redisson/src/main/java/org/redisson/pubsub/TransferListener.java index 52728ee12..72ad48722 100644 --- a/redisson/src/main/java/org/redisson/pubsub/TransferListener.java +++ b/redisson/src/main/java/org/redisson/pubsub/TransferListener.java @@ -24,7 +24,7 @@ import io.netty.util.concurrent.FutureListener; * * @author Nikita Koksharov * - * @param + * @param type */ public class TransferListener implements FutureListener { diff --git a/redisson/src/main/java/org/redisson/reactive/RedissonSetCacheReactive.java b/redisson/src/main/java/org/redisson/reactive/RedissonSetCacheReactive.java index 2717981f2..cac153850 100644 --- a/redisson/src/main/java/org/redisson/reactive/RedissonSetCacheReactive.java +++ b/redisson/src/main/java/org/redisson/reactive/RedissonSetCacheReactive.java @@ -34,7 +34,7 @@ import org.redisson.command.CommandReactiveExecutor; /** *

Set-based cache with ability to set TTL for each entry via - * {@link #put(Object, Object, long, TimeUnit)} method. + * {@link #add(Object, long, TimeUnit)} method. * And therefore has an complex lua-scripts inside. * Uses map(value_hash, value) to tie with sorted set which contains expiration record for every value with TTL. *

@@ -46,11 +46,10 @@ import org.redisson.command.CommandReactiveExecutor; * In addition there is {@link org.redisson.EvictionScheduler}. This scheduler * deletes expired entries in time interval between 5 seconds to 2 hours.

* - *

If eviction is not required then it's better to use {@link org.redisson.reactive.RedissonSet}.

+ *

If eviction is not required then it's better to use {@link org.redisson.api.RSet}.

* * @author Nikita Koksharov * - * @param key * @param value */ public class RedissonSetCacheReactive extends RedissonExpirableReactive implements RSetCacheReactive { diff --git a/redisson/src/main/java/org/redisson/spring/cache/CacheConfig.java b/redisson/src/main/java/org/redisson/spring/cache/CacheConfig.java index 3f2b199a9..ad1c2485e 100644 --- a/redisson/src/main/java/org/redisson/spring/cache/CacheConfig.java +++ b/redisson/src/main/java/org/redisson/spring/cache/CacheConfig.java @@ -47,10 +47,7 @@ public class CacheConfig { * * @param ttl - time to live for key\value entry in milliseconds. * If 0 then time to live doesn't affect entry expiration. - * @param ttlUnit * @param maxIdleTime - max idle time for key\value entry in milliseconds. - * If 0 then max idle time doesn't affect entry expiration. - * @param maxIdleUnit *

* if maxIdleTime and ttl params are equal to 0 * then entry stores infinitely. @@ -92,9 +89,9 @@ public class CacheConfig { /** * Read config objects stored in JSON format from String * - * @param content - * @return - * @throws IOException + * @param content of config + * @return config + * @throws IOException error */ public static Map fromJSON(String content) throws IOException { return new CacheConfigSupport().fromJSON(content); @@ -103,9 +100,9 @@ public class CacheConfig { /** * Read config objects stored in JSON format from InputStream * - * @param inputStream - * @return - * @throws IOException + * @param inputStream of config + * @return config + * @throws IOException error */ public static Map fromJSON(InputStream inputStream) throws IOException { return new CacheConfigSupport().fromJSON(inputStream); @@ -114,9 +111,9 @@ public class CacheConfig { /** * Read config objects stored in JSON format from File * - * @param file - * @return - * @throws IOException + * @param file of config + * @return config + * @throws IOException error */ public static Map fromJSON(File file) throws IOException { return new CacheConfigSupport().fromJSON(file); @@ -125,9 +122,9 @@ public class CacheConfig { /** * Read config objects stored in JSON format from URL * - * @param url - * @return - * @throws IOException + * @param url of config + * @return config + * @throws IOException error */ public static Map fromJSON(URL url) throws IOException { return new CacheConfigSupport().fromJSON(url); @@ -136,9 +133,9 @@ public class CacheConfig { /** * Read config objects stored in JSON format from Reader * - * @param reader - * @return - * @throws IOException + * @param reader of config + * @return config + * @throws IOException error */ public static Map fromJSON(Reader reader) throws IOException { return new CacheConfigSupport().fromJSON(reader); @@ -147,19 +144,19 @@ public class CacheConfig { /** * Convert current configuration to JSON format * - * @return - * @throws IOException + * @return config object + * @throws IOException error */ - public static String toJSON(Map configs) throws IOException { - return new CacheConfigSupport().toJSON(configs); + public static String toJSON(Map config) throws IOException { + return new CacheConfigSupport().toJSON(config); } /** * Read config objects stored in YAML format from String * - * @param content - * @return - * @throws IOException + * @param content of config + * @return config + * @throws IOException error */ public static Map fromYAML(String content) throws IOException { return new CacheConfigSupport().fromYAML(content); @@ -168,9 +165,9 @@ public class CacheConfig { /** * Read config objects stored in YAML format from InputStream * - * @param inputStream - * @return - * @throws IOException + * @param inputStream of config + * @return config + * @throws IOException error */ public static Map fromYAML(InputStream inputStream) throws IOException { return new CacheConfigSupport().fromYAML(inputStream); @@ -179,9 +176,9 @@ public class CacheConfig { /** * Read config objects stored in YAML format from File * - * @param file - * @return - * @throws IOException + * @param file of config + * @return config + * @throws IOException error */ public static Map fromYAML(File file) throws IOException { return new CacheConfigSupport().fromYAML(file); @@ -190,9 +187,9 @@ public class CacheConfig { /** * Read config objects stored in YAML format from URL * - * @param url - * @return - * @throws IOException + * @param url of config + * @return config + * @throws IOException error */ public static Map fromYAML(URL url) throws IOException { return new CacheConfigSupport().fromYAML(url); @@ -201,9 +198,9 @@ public class CacheConfig { /** * Read config objects stored in YAML format from Reader * - * @param reader - * @return - * @throws IOException + * @param reader of config + * @return config + * @throws IOException error */ public static Map fromYAML(Reader reader) throws IOException { return new CacheConfigSupport().fromYAML(reader); @@ -212,11 +209,11 @@ public class CacheConfig { /** * Convert current configuration to YAML format * - * @return - * @throws IOException + * @return config in yaml format + * @throws IOException error */ - public static String toYAML(Map configs) throws IOException { - return new CacheConfigSupport().toYAML(configs); + public static String toYAML(Map config) throws IOException { + return new CacheConfigSupport().toYAML(config); } } diff --git a/redisson/src/main/java/org/redisson/spring/cache/RedissonSpringCacheManager.java b/redisson/src/main/java/org/redisson/spring/cache/RedissonSpringCacheManager.java index c127084b0..99fd12958 100644 --- a/redisson/src/main/java/org/redisson/spring/cache/RedissonSpringCacheManager.java +++ b/redisson/src/main/java/org/redisson/spring/cache/RedissonSpringCacheManager.java @@ -59,8 +59,8 @@ public class RedissonSpringCacheManager implements CacheManager, ResourceLoaderA * Creates CacheManager supplied by Redisson instance and * Cache config mapped by Cache name * - * @param redisson - * @param config + * @param redisson object + * @param config object */ public RedissonSpringCacheManager(RedissonClient redisson, Map config) { this(redisson, config, null); @@ -72,8 +72,9 @@ public class RedissonSpringCacheManager implements CacheManager, ResourceLoaderA *

* Each Cache instance share one Codec instance. * - * @param redisson - * @param config + * @param redisson object + * @param config object + * @param codec object */ public RedissonSpringCacheManager(RedissonClient redisson, Map config, Codec codec) { this.redisson = redisson; @@ -88,8 +89,8 @@ public class RedissonSpringCacheManager implements CacheManager, ResourceLoaderA * Loads the config file from the class path, interpreting plain paths as class path resource names * that include the package path (e.g. "mypackage/myresource.txt"). * - * @param redisson - * @param config + * @param redisson object + * @param configLocation path */ public RedissonSpringCacheManager(RedissonClient redisson, String configLocation) { this(redisson, configLocation, null); @@ -104,8 +105,9 @@ public class RedissonSpringCacheManager implements CacheManager, ResourceLoaderA * Loads the config file from the class path, interpreting plain paths as class path resource names * that include the package path (e.g. "mypackage/myresource.txt"). * - * @param redisson - * @param config + * @param redisson object + * @param configLocation path + * @param codec object */ public RedissonSpringCacheManager(RedissonClient redisson, String configLocation, Codec codec) { this.redisson = redisson; @@ -116,8 +118,7 @@ public class RedissonSpringCacheManager implements CacheManager, ResourceLoaderA /** * Set cache config location * - * @param config - * @throws IOException + * @param configLocation object */ public void setConfigLocation(String configLocation) { this.configLocation = configLocation; @@ -126,7 +127,7 @@ public class RedissonSpringCacheManager implements CacheManager, ResourceLoaderA /** * Set cache config mapped by cache name * - * @param config + * @param config object */ public void setConfig(Map config) { this.configMap = config; @@ -135,7 +136,7 @@ public class RedissonSpringCacheManager implements CacheManager, ResourceLoaderA /** * Set Redisson instance * - * @param config + * @param redisson instance */ public void setRedisson(RedissonClient redisson) { this.redisson = redisson; @@ -144,7 +145,7 @@ public class RedissonSpringCacheManager implements CacheManager, ResourceLoaderA /** * Set Codec instance shared between all Cache instances * - * @param codec + * @param codec object */ public void setCodec(Codec codec) { this.codec = codec;