Skip to content

Commit

Permalink
javadocs fixed
Browse files Browse the repository at this point in the history
  • Loading branch information
Nikita committed Sep 27, 2016
1 parent f657a42 commit c39e624
Show file tree
Hide file tree
Showing 66 changed files with 435 additions and 368 deletions.
32 changes: 12 additions & 20 deletions redisson/src/main/java/org/redisson/CronSchedule.java
Expand Up @@ -39,8 +39,8 @@ public class CronSchedule {
/** /**
* Creates cron expression object with defined expression string * Creates cron expression object with defined expression string
* *
* @param expression * @param expression of cron
* @return * @return object
* @throws IllegalArgumentException * @throws IllegalArgumentException
* wrapping a ParseException if the expression is invalid * wrapping a ParseException if the expression is invalid
*/ */
Expand All @@ -52,9 +52,9 @@ public static CronSchedule of(String expression) {
* Creates cron expression which schedule task execution * Creates cron expression which schedule task execution
* every day at the given time * every day at the given time
* *
* @param hour * @param hour of schedule
* @param minute * @param minute of schedule
* @return * @return object
* @throws IllegalArgumentException * @throws IllegalArgumentException
* wrapping a ParseException if the expression is invalid * wrapping a ParseException if the expression is invalid
*/ */
Expand All @@ -68,18 +68,10 @@ public static CronSchedule dailyAtHourAndMinute(int hour, int minute) {
* every given days of the week at the given time. * every given days of the week at the given time.
* Use Calendar object constants to define day. * Use Calendar object constants to define day.
* *
* @see Calendar#SUNDAY * @param hour of schedule
* @see Calendar#MONDAY * @param minute of schedule
* @see Calendar#TUESDAY
* @see Calendar#WEDNESDAY
* @see Calendar#THURSDAY
* @see Calendar#FRIDAY
* @see Calendar#SATURDAY
*
* @param hour
* @param minute
* @param daysOfWeek - Calendar object constants * @param daysOfWeek - Calendar object constants
* @return * @return object
*/ */
public static CronSchedule weeklyOnDayAndHourAndMinute(int hour, int minute, Integer... daysOfWeek) { public static CronSchedule weeklyOnDayAndHourAndMinute(int hour, int minute, Integer... daysOfWeek) {
if (daysOfWeek == null || daysOfWeek.length == 0) { if (daysOfWeek == null || daysOfWeek.length == 0) {
Expand All @@ -98,10 +90,10 @@ public static CronSchedule weeklyOnDayAndHourAndMinute(int hour, int minute, Int
* Creates cron expression which schedule task execution * Creates cron expression which schedule task execution
* every given day of the month at the given time * every given day of the month at the given time
* *
* @param hour * @param hour of schedule
* @param minute * @param minute of schedule
* @param daysOfWeek * @param dayOfMonth of schedule
* @return * @return object
*/ */
public static CronSchedule monthlyOnDayAndHourAndMinute(int dayOfMonth, int hour, int minute) { public static CronSchedule monthlyOnDayAndHourAndMinute(int dayOfMonth, int hour, int minute) {
String expression = String.format("0 %d %d %d * ?", minute, hour, dayOfMonth); String expression = String.format("0 %d %d %d * ?", minute, hour, dayOfMonth);
Expand Down
Expand Up @@ -23,8 +23,7 @@
* *
* @author Nikita Koksharov * @author Nikita Koksharov
* *
* @param <K> * @param <V> value
* @param <V>
*/ */
public class PubSubMessageListener<V> implements RedisPubSubListener<Object> { public class PubSubMessageListener<V> implements RedisPubSubListener<Object> {


Expand Down
Expand Up @@ -15,7 +15,6 @@
*/ */
package org.redisson; package org.redisson;


import org.redisson.api.listener.MessageListener;
import org.redisson.api.listener.PatternMessageListener; import org.redisson.api.listener.PatternMessageListener;
import org.redisson.client.RedisPubSubListener; import org.redisson.client.RedisPubSubListener;
import org.redisson.client.protocol.pubsub.PubSubType; import org.redisson.client.protocol.pubsub.PubSubType;
Expand All @@ -24,8 +23,7 @@
* *
* @author Nikita Koksharov * @author Nikita Koksharov
* *
* @param <K> * @param <V> value
* @param <V>
*/ */
public class PubSubPatternMessageListener<V> implements RedisPubSubListener<V> { public class PubSubPatternMessageListener<V> implements RedisPubSubListener<V> {


Expand Down
Expand Up @@ -23,8 +23,7 @@
* *
* @author Nikita Koksharov * @author Nikita Koksharov
* *
* @param <K> * @param <V> value
* @param <V>
*/ */
public class PubSubPatternStatusListener<V> implements RedisPubSubListener<V> { public class PubSubPatternStatusListener<V> implements RedisPubSubListener<V> {


Expand Down
Expand Up @@ -23,8 +23,7 @@
* *
* @author Nikita Koksharov * @author Nikita Koksharov
* *
* @param <K> * @param <V> value
* @param <V>
*/ */
public class PubSubStatusListener<V> implements RedisPubSubListener<V> { public class PubSubStatusListener<V> implements RedisPubSubListener<V> {


Expand Down
3 changes: 2 additions & 1 deletion redisson/src/main/java/org/redisson/Redisson.java
Expand Up @@ -135,7 +135,7 @@ public static RedissonClient create() {
/** /**
* Create sync/async Redisson instance with provided config * Create sync/async Redisson instance with provided config
* *
* @param config * @param config for Redisson
* @return Redisson instance * @return Redisson instance
*/ */
public static RedissonClient create(Config config) { public static RedissonClient create(Config config) {
Expand Down Expand Up @@ -163,6 +163,7 @@ public static RedissonReactiveClient createReactive() {
/** /**
* Create reactive Redisson instance with provided config * Create reactive Redisson instance with provided config
* *
* @param config for Redisson
* @return Redisson instance * @return Redisson instance
*/ */
public static RedissonReactiveClient createReactive(Config config) { public static RedissonReactiveClient createReactive(Config config) {
Expand Down
Expand Up @@ -45,7 +45,7 @@
* *
* @author Nikita Koksharov * @author Nikita Koksharov
* *
* @param <T> * @param <T> type of object
*/ */
public class RedissonBloomFilter<T> extends RedissonExpirable implements RBloomFilter<T> { public class RedissonBloomFilter<T> extends RedissonExpirable implements RBloomFilter<T> {


Expand Down
2 changes: 1 addition & 1 deletion redisson/src/main/java/org/redisson/RedissonGeo.java
Expand Up @@ -47,7 +47,7 @@
* *
* @author Nikita Koksharov * @author Nikita Koksharov
* *
* @param <V> * @param <V> value
*/ */
public class RedissonGeo<V> extends RedissonExpirable implements RGeo<V> { public class RedissonGeo<V> extends RedissonExpirable implements RGeo<V> {


Expand Down
Expand Up @@ -30,7 +30,7 @@
* *
* @author Nikita Koksharov * @author Nikita Koksharov
* *
* @param <V> * @param <V> value
*/ */
public class RedissonHyperLogLog<V> extends RedissonExpirable implements RHyperLogLog<V> { public class RedissonHyperLogLog<V> extends RedissonExpirable implements RHyperLogLog<V> {


Expand Down
2 changes: 1 addition & 1 deletion redisson/src/main/java/org/redisson/RedissonMultiLock.java
Expand Up @@ -46,7 +46,7 @@ public class RedissonMultiLock implements Lock {
* Creates instance with multiple {@link RLock} objects. * Creates instance with multiple {@link RLock} objects.
* Each RLock object could be created by own Redisson instance. * Each RLock object could be created by own Redisson instance.
* *
* @param locks * @param locks - array of locks
*/ */
public RedissonMultiLock(RLock... locks) { public RedissonMultiLock(RLock... locks) {
if (locks.length == 0) { if (locks.length == 0) {
Expand Down
6 changes: 3 additions & 3 deletions redisson/src/main/java/org/redisson/RedissonNode.java
Expand Up @@ -170,7 +170,7 @@ private void retrieveAdresses() {
/** /**
* Create Redisson node instance with provided config * Create Redisson node instance with provided config
* *
* @param config * @param config of RedissonNode
* @return RedissonNode instance * @return RedissonNode instance
*/ */
public static RedissonNode create(RedissonNodeConfig config) { public static RedissonNode create(RedissonNodeConfig config) {
Expand All @@ -180,8 +180,8 @@ public static RedissonNode create(RedissonNodeConfig config) {
/** /**
* Create Redisson node instance with provided config and Redisson instance * Create Redisson node instance with provided config and Redisson instance
* *
* @param config * @param config of RedissonNode
* @param redisson * @param redisson instance
* @return RedissonNode instance * @return RedissonNode instance
*/ */
public static RedissonNode create(RedissonNodeConfig config, Redisson redisson) { public static RedissonNode create(RedissonNodeConfig config, Redisson redisson) {
Expand Down
2 changes: 1 addition & 1 deletion redisson/src/main/java/org/redisson/RedissonRedLock.java
Expand Up @@ -38,7 +38,7 @@ public class RedissonRedLock extends RedissonMultiLock {
* Creates instance with multiple {@link RLock} objects. * Creates instance with multiple {@link RLock} objects.
* Each RLock object could be created by own Redisson instance. * Each RLock object could be created by own Redisson instance.
* *
* @param locks * @param locks - array of locks
*/ */
public RedissonRedLock(RLock... locks) { public RedissonRedLock(RLock... locks) {
super(locks); super(locks);
Expand Down
8 changes: 2 additions & 6 deletions redisson/src/main/java/org/redisson/RedissonSetCache.java
Expand Up @@ -15,7 +15,6 @@
*/ */
package org.redisson; package org.redisson;


import java.io.IOException;
import java.net.InetSocketAddress; import java.net.InetSocketAddress;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Arrays; import java.util.Arrays;
Expand All @@ -37,11 +36,9 @@
import org.redisson.client.protocol.decoder.ListScanResult; import org.redisson.client.protocol.decoder.ListScanResult;
import org.redisson.command.CommandAsyncExecutor; import org.redisson.command.CommandAsyncExecutor;


import io.netty.util.concurrent.Future;

/** /**
* <p>Set-based cache with ability to set TTL for each entry via * <p>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.
* </p> * </p>
* *
* <p>Current Redis implementation doesn't have set entry eviction functionality. * <p>Current Redis implementation doesn't have set entry eviction functionality.
Expand All @@ -51,11 +48,10 @@
* In addition there is {@link org.redisson.EvictionScheduler}. This scheduler * In addition there is {@link org.redisson.EvictionScheduler}. This scheduler
* deletes expired entries in time interval between 5 seconds to 2 hours.</p> * deletes expired entries in time interval between 5 seconds to 2 hours.</p>
* *
* <p>If eviction is not required then it's better to use {@link org.redisson.reactive.RedissonSet}.</p> * <p>If eviction is not required then it's better to use {@link org.redisson.api.RSet}.</p>
* *
* @author Nikita Koksharov * @author Nikita Koksharov
* *
* @param <K> key
* @param <V> value * @param <V> value
*/ */
public class RedissonSetCache<V> extends RedissonExpirable implements RSetCache<V> { public class RedissonSetCache<V> extends RedissonExpirable implements RSetCache<V> {
Expand Down
2 changes: 1 addition & 1 deletion redisson/src/main/java/org/redisson/RedissonSortedSet.java
Expand Up @@ -44,7 +44,7 @@
* *
* @author Nikita Koksharov * @author Nikita Koksharov
* *
* @param <V> * @param <V> value
*/ */
public class RedissonSortedSet<V> extends RedissonObject implements RSortedSet<V> { public class RedissonSortedSet<V> extends RedissonObject implements RSortedSet<V> {


Expand Down
6 changes: 6 additions & 0 deletions redisson/src/main/java/org/redisson/api/RCollectionAsync.java
Expand Up @@ -17,6 +17,12 @@


import java.util.Collection; import java.util.Collection;


/**
*
* @author Nikita Koksharov
*
* @param <V> type of value
*/
public interface RCollectionAsync<V> extends RExpirableAsync { public interface RCollectionAsync<V> extends RExpirableAsync {


/** /**
Expand Down
Expand Up @@ -19,6 +19,12 @@


import org.reactivestreams.Publisher; import org.reactivestreams.Publisher;


/**
*
* @author Nikita Koksharov
*
* @param <V> value
*/
public interface RCollectionReactive<V> extends RExpirableReactive { public interface RCollectionReactive<V> extends RExpirableReactive {


Publisher<V> iterator(); Publisher<V> iterator();
Expand Down
6 changes: 6 additions & 0 deletions redisson/src/main/java/org/redisson/api/RHyperLogLog.java
Expand Up @@ -17,6 +17,12 @@


import java.util.Collection; import java.util.Collection;


/**
*
* @author Nikita Koksharov
*
* @param <V> value
*/
public interface RHyperLogLog<V> extends RExpirable, RHyperLogLogAsync<V> { public interface RHyperLogLog<V> extends RExpirable, RHyperLogLogAsync<V> {


boolean add(V obj); boolean add(V obj);
Expand Down
Expand Up @@ -17,6 +17,12 @@


import java.util.Collection; import java.util.Collection;


/**
*
* @author Nikita Koksharov
*
* @param <V> value
*/
public interface RHyperLogLogAsync<V> extends RExpirableAsync { public interface RHyperLogLogAsync<V> extends RExpirableAsync {


RFuture<Boolean> addAsync(V obj); RFuture<Boolean> addAsync(V obj);
Expand Down
44 changes: 22 additions & 22 deletions redisson/src/main/java/org/redisson/api/RSet.java
Expand Up @@ -29,14 +29,14 @@ public interface RSet<V> extends Set<V>, RExpirable, RSetAsync<V> {
/** /**
* Removes and returns random element from set * Removes and returns random element from set
* *
* @return * @return value
*/ */
V removeRandom(); V removeRandom();


/** /**
* Returns random element from set * Returns random element from set
* *
* @return * @return value
*/ */
V random(); V random();


Expand All @@ -53,61 +53,61 @@ public interface RSet<V> extends Set<V>, RExpirable, RSetAsync<V> {
/** /**
* Read all elements at once * Read all elements at once
* *
* @return * @return values
*/ */
Set<V> readAll(); Set<V> readAll();


/** /**
* Union sets specified by name and write to current set. * Union sets specified by name and write to current set.
* If current set already exists, it is overwritten. * If current set already exists, it is overwritten.
* *
* @param names * @param names - name of sets
* @return * @return size of union
*/ */
int union(String... names); int union(String... names);


/** /**
* Union sets specified by name with current set. * Union sets specified by name with current set
* Without current set state change. * without current set state change.
* *
* @param names * @param names - name of sets
* @return * @return values
*/ */
Set<V> readUnion(String... names); Set<V> readUnion(String... names);


/** /**
* Diff sets specified by name and write to current set. * Diff sets specified by name and write to current set.
* If current set already exists, it is overwritten. * If current set already exists, it is overwritten.
* *
* @param names * @param names - name of sets
* @return * @return values
*/ */
int diff(String... names); int diff(String... names);


/** /**
* Diff sets specified by name with current set. * Diff sets specified by name with current set.
* Without current set state change. * Without current set state change.
* *
* @param names * @param names - name of sets
* @return * @return values
*/ */


Set<V> readDiff(String... names); Set<V> readDiff(String... names);
/** /**
* Intersection sets specified by name and write to current set. * Intersection sets specified by name and write to current set.
* If current set already exists, it is overwritten. * If current set already exists, it is overwritten.
* *
* @param names * @param names - name of sets
* @return * @return size of intersection
*/ */
int intersection(String... names); int intersection(String... names);


/** /**
* Intersection sets specified by name with current set. * Intersection sets specified by name with current set
* Without current set state change. * without current set state change.
* *
* @param names * @param names - name of sets
* @return * @return values
*/ */
Set<V> readIntersection(String... names); Set<V> readIntersection(String... names);


Expand Down

0 comments on commit c39e624

Please sign in to comment.