DATAREDIS-532 - Enhance JavaDoc and convert links to Redis documentation.

Extend JavaDoc documentation for Command/Connection/Operation interfaces. Align method ordering in operation interfaces with connection/commands interfaces.

Author: mp911de

src/main/java/org/springframework/data/redis/connection/HyperLogLogCommands.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2014 the original author or authors.
+ * Copyright 2014-2017 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,32 +19,36 @@
  * {@literal HyperLogLog} specific commands supported by Redis.
  * 
  * @author Christoph Strobl
+ * @author Mark Paluch
  * @since 1.5
  */
 public interface HyperLogLogCommands {
 
 /**
  * Adds given {@literal values} to the HyperLogLog stored at given {@literal key}.
  * 
- * @param key
- * @param values
+ * @param key must not be {@literal null}.
+ * @param values must not be {@literal null}.
  * @return
+ * @see <a href="http://redis.io/commands/pfadd">Redis Documentation: PFADD</a>
  */
 Long pfAdd(byte[] key, byte[]... values);
 
 /**
  * Return the approximated cardinality of the structures observed by the HyperLogLog at {@literal key(s)}.
  * 
- * @param keys
+ * @param keys must not be {@literal null}.
  * @return
+ * @see <a href="http://redis.io/commands/pfcount">Redis Documentation: PFCOUNT</a>
  */
 Long pfCount(byte[]... keys);
 
 /**
  * Merge N different HyperLogLogs at {@literal sourceKeys} into a single {@literal destinationKey}.
  * 
- * @param destinationKey
- * @param sourceKeys
+ * @param destinationKey must not be {@literal null}.
+ * @param sourceKeys must not be {@literal null}.
+ * @see <a href="http://redis.io/commands/pfmerge">Redis Documentation: PFMERGE</a>
  */
 void pfMerge(byte[] destinationKey, byte[]... sourceKeys);
 

src/main/java/org/springframework/data/redis/connection/RedisClusterCommands.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2015 the original author or authors.
+ * Copyright 2015-2017 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,6 +36,7 @@ public interface RedisClusterCommands {
  * Retrieve cluster node information such as {@literal id}, {@literal host}, {@literal port} and {@literal slots}.
  * 
  * @return never {@literal null}.
+ * @see <a href="https://redis.io/commands/cluster-nodes">Redis Documentation: CLUSTER NODES</a>
  */
 Iterable<RedisClusterNode> clusterGetNodes();
 
@@ -44,13 +45,15 @@ public interface RedisClusterCommands {
  * 
  * @param master must not be {@literal null}.
  * @return never {@literal null}.
+ * @see <a href="https://redis.io/commands/cluster-slaves">Redis Documentation: CLUSTER SLAVES</a>
  */
 Collection<RedisClusterNode> clusterGetSlaves(RedisClusterNode master);
 
 /**
  * Retrieve information about masters and their connected slaves.
  * 
  * @return never {@literal null}.
+ * @see <a href="https://redis.io/commands/cluster-slaves">Redis Documentation: CLUSTER SLAVES</a>
  */
 Map<RedisClusterNode, Collection<RedisClusterNode>> clusterGetMasterSlaveMap();
 
@@ -59,6 +62,7 @@ public interface RedisClusterCommands {
  * 
  * @param key must not be {@literal null}.
  * @return
+ * @see <a href="https://redis.io/commands/cluster-keyslot">Redis Documentation: CLUSTER KEYSLOT</a>
  */
 Integer clusterGetSlotForKey(byte[] key);
 
@@ -82,6 +86,7 @@ public interface RedisClusterCommands {
  * Get cluster information.
  * 
  * @return
+ * @see <a href="https://redis.io/commands/cluster-info">Redis Documentation: CLUSTER INFO</a>
  */
 ClusterInfo clusterGetClusterInfo();
 
@@ -90,6 +95,7 @@ public interface RedisClusterCommands {
  * 
  * @param node must not be {@literal null}.
  * @param slots
+ * @see <a href="https://redis.io/commands/cluster-addslots">Redis Documentation: CLUSTER ADDSLOTS</a>
  */
 void clusterAddSlots(RedisClusterNode node, int... slots);
 
@@ -98,6 +104,7 @@ public interface RedisClusterCommands {
  * 
  * @param node must not be {@literal null}.
  * @param range must not be {@literal null}.
+ * @see <a href="https://redis.io/commands/cluster-addslots">Redis Documentation: CLUSTER ADDSLOTS</a>
  */
 void clusterAddSlots(RedisClusterNode node, SlotRange range);
 
@@ -106,6 +113,7 @@ public interface RedisClusterCommands {
  * 
  * @param slot
  * @return
+ * @see <a href="https://redis.io/commands/cluster-countkeysinslot">Redis Documentation: CLUSTER COUNTKEYSINSLOT</a>
  */
 Long clusterCountKeysInSlot(int slot);
 
@@ -114,6 +122,7 @@ public interface RedisClusterCommands {
  * 
  * @param node must not be {@literal null}.
  * @param slots
+ * @see <a href="https://redis.io/commands/cluster-delslots">Redis Documentation: CLUSTER DELSLOTS</a>
  */
 void clusterDeleteSlots(RedisClusterNode node, int... slots);
 
@@ -122,13 +131,15 @@ public interface RedisClusterCommands {
  * 
  * @param node must not be {@literal null}.
  * @param range must not be {@literal null}.
+ * @see <a href="https://redis.io/commands/cluster-delslots">Redis Documentation: CLUSTER DELSLOTS</a>
  */
 void clusterDeleteSlotsInRange(RedisClusterNode node, SlotRange range);
 
 /**
  * Remove given {@literal node} from cluster.
  * 
  * @param node must not be {@literal null}.
+ * @see <a href="https://redis.io/commands/cluster-forget">Redis Documentation: CLUSTER FORGET</a>
  */
 void clusterForget(RedisClusterNode node);
 
@@ -137,13 +148,15 @@ public interface RedisClusterCommands {
  *
  * @param node must contain {@link RedisClusterNode#getHost() host} and {@link RedisClusterNode#getPort()} and must
  * not be {@literal null}.
+ * @see <a href="https://redis.io/commands/cluster-meet">Redis Documentation: CLUSTER MEET</a>
  */
 void clusterMeet(RedisClusterNode node);
 
 /**
  * @param node must not be {@literal null}.
  * @param slot
  * @param mode must not be{@literal null}.
+ * @see <a href="https://redis.io/commands/cluster-setslot">Redis Documentation: CLUSTER SETSLOT</a>
  */
 void clusterSetSlot(RedisClusterNode node, int slot, AddSlots mode);
 
@@ -153,6 +166,7 @@ public interface RedisClusterCommands {
  * @param slot
  * @param count must not be {@literal null}.
  * @return
+ * @see <a href="https://redis.io/commands/cluster-getkeysinslot">Redis Documentation: CLUSTER GETKEYSINSLOT</a>
  */
 List<byte[]> clusterGetKeysInSlot(int slot, Integer count);
 
@@ -161,6 +175,7 @@ public interface RedisClusterCommands {
  * 
  * @param master must not be {@literal null}.
  * @param slave must not be {@literal null}.
+ * @see <a href="https://redis.io/commands/cluster-replicate">Redis Documentation: CLUSTER REPLICATE</a>
  */
 void clusterReplicate(RedisClusterNode master, RedisClusterNode slave);
 

src/main/java/org/springframework/data/redis/connection/RedisConnectionCommands.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2014 the original author or authors.
+ * Copyright 2011-2017 the original author or authors.
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,34 +20,32 @@
  * 
  * @author Costin Leau
  * @author Christoph Strobl
+ * @author Mark Paluch
  */
 public interface RedisConnectionCommands {
 
 /**
  * Select the DB with given positive {@code dbIndex}.
- * <p>
- * See http://redis.io/commands/select
- * 
- * @param dbIndex
+ *
+ * @param dbIndex the database index.
+ * @see <a href="http://redis.io/commands/select">Redis Documentation: SELECT</a>
  */
 void select(int dbIndex);
 
 /**
  * Returns {@code message} via server roundtrip.
- * <p>
- * See http://redis.io/commands/echo
- * 
- * @param message
+ *
+ * @param message the message to echo.
  * @return
+ * @see <a href="http://redis.io/commands/echo">Redis Documentation: ECHO</a>
  */
 byte[] echo(byte[] message);
 
 /**
  * Test connection.
- * <p>
- * See http://redis.io/commands/ping
- * 
+ *
  * @return Server response message - usually {@literal PONG}.
+ * @see <a href="http://redis.io/commands/ping">Redis Documentation: PING</a>
  */
 String ping();
 }

src/main/java/org/springframework/data/redis/connection/RedisGeoCommands.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016 the original author or authors.
+ * Copyright 2016-2017 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,6 +15,9 @@
  */
 package org.springframework.data.redis.connection;
 
+import lombok.Data;
+import lombok.RequiredArgsConstructor;
+
 import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
@@ -28,14 +31,12 @@
 import org.springframework.data.geo.Point;
 import org.springframework.util.Assert;
 
-import lombok.Data;
-import lombok.RequiredArgsConstructor;
-
 /**
  * Geo-specific Redis commands.
  *
  * @author Ninad Divadkar
  * @author Christoph Strobl
+ * @author Mark Paluch
  * @since 1.8
  */
 public interface RedisGeoCommands {
@@ -47,7 +48,7 @@ public interface RedisGeoCommands {
  * @param point must not be {@literal null}.
  * @param member must not be {@literal null}.
  * @return Number of elements added.
- * @see <a href="http://redis.io/commands/geoadd">http://redis.io/commands/geoadd</a>
+ * @see <a href="http://redis.io/commands/geoadd">Redis Documentation: GEOADD</a>
  */
 Long geoAdd(byte[] key, Point point, byte[] member);
 
@@ -57,7 +58,7 @@ public interface RedisGeoCommands {
  * @param key must not be {@literal null}.
  * @param location must not be {@literal null}.
  * @return Number of elements added.
- * @see <a href="http://redis.io/commands/geoadd">http://redis.io/commands/geoadd</a>
+ * @see <a href="http://redis.io/commands/geoadd">Redis Documentation: GEOADD</a>
  */
 Long geoAdd(byte[] key, GeoLocation<byte[]> location);
 
@@ -67,7 +68,7 @@ public interface RedisGeoCommands {
  * @param key must not be {@literal null}.
  * @param memberCoordinateMap must not be {@literal null}.
  * @return Number of elements added.
- * @see <a href="http://redis.io/commands/geoadd">http://redis.io/commands/geoadd</a>
+ * @see <a href="http://redis.io/commands/geoadd">Redis Documentation: GEOADD</a>
  */
 Long geoAdd(byte[] key, Map<byte[], Point> memberCoordinateMap);
 
@@ -77,7 +78,7 @@ public interface RedisGeoCommands {
  * @param key must not be {@literal null}.
  * @param locations must not be {@literal null}.
  * @return Number of elements added.
- * @see <a href="http://redis.io/commands/geoadd">http://redis.io/commands/geoadd</a>
+ * @see <a href="http://redis.io/commands/geoadd">Redis Documentation: GEOADD</a>
  */
 Long geoAdd(byte[] key, Iterable<GeoLocation<byte[]>> locations);
 
@@ -88,7 +89,7 @@ public interface RedisGeoCommands {
  * @param member1 must not be {@literal null}.
  * @param member2 must not be {@literal null}.
  * @return can be {@literal null}.
- * @see <a href="http://redis.io/commands/geodist">http://redis.io/commands/geodist</a>
+ * @see <a href="http://redis.io/commands/geodist">Redis Documentation: GEODIST</a>
  */
 Distance geoDist(byte[] key, byte[] member1, byte[] member2);
 
@@ -100,7 +101,7 @@ public interface RedisGeoCommands {
  * @param member2 must not be {@literal null}.
  * @param metric must not be {@literal null}.
  * @return can be {@literal null}.
- * @see <a href="http://redis.io/commands/geodist">http://redis.io/commands/geodist</a>
+ * @see <a href="http://redis.io/commands/geodist">Redis Documentation: GEODIST</a>
  */
 Distance geoDist(byte[] key, byte[] member1, byte[] member2, Metric metric);
 
@@ -110,7 +111,7 @@ public interface RedisGeoCommands {
  * @param key must not be {@literal null}.
  * @param members must not be {@literal null}.
  * @return never {@literal null}.
- * @see <a href="http://redis.io/commands/geohash">http://redis.io/commands/geohash</a>
+ * @see <a href="http://redis.io/commands/geohash">Redis Documentation: GEOHASH</a>
  */
 List<String> geoHash(byte[] key, byte[]... members);
 
@@ -120,7 +121,7 @@ public interface RedisGeoCommands {
  * @param key must not be {@literal null}.
  * @param members must not be {@literal null}.
  * @return never {@literal null}.
- * @see <a href="http://redis.io/commands/geopos">http://redis.io/commands/geopos</a>
+ * @see <a href="http://redis.io/commands/geopos">Redis Documentation: GEOPOS</a>
  */
 List<Point> geoPos(byte[] key, byte[]... members);
 
@@ -130,7 +131,7 @@ public interface RedisGeoCommands {
  * @param key must not be {@literal null}.
  * @param within must not be {@literal null}.
  * @return never {@literal null}.
- * @see <a href="http://redis.io/commands/georadius">http://redis.io/commands/georadius</a>
+ * @see <a href="http://redis.io/commands/georadius">Redis Documentation: GEORADIUS</a>
  */
 GeoResults<GeoLocation<byte[]>> geoRadius(byte[] key, Circle within);
 
@@ -141,7 +142,7 @@ public interface RedisGeoCommands {
  * @param within must not be {@literal null}.
  * @param args must not be {@literal null}.
  * @return never {@literal null}.
- * @see <a href="http://redis.io/commands/georadius">http://redis.io/commands/georadius</a>
+ * @see <a href="http://redis.io/commands/georadius">Redis Documentation: GEORADIUS</a>
  */
 GeoResults<GeoLocation<byte[]>> geoRadius(byte[] key, Circle within, GeoRadiusCommandArgs args);
 
@@ -153,7 +154,7 @@ public interface RedisGeoCommands {
  * @param member must not be {@literal null}.
  * @param radius
  * @return never {@literal null}.
- * @see <a href="http://redis.io/commands/georadiusbymember">http://redis.io/commands/georadiusbymember</a>
+ * @see <a href="http://redis.io/commands/georadiusbymember">Redis Documentation: GEORADIUSBYMEMBER</a>
  */
 GeoResults<GeoLocation<byte[]>> geoRadiusByMember(byte[] key, byte[] member, double radius);
 
@@ -165,7 +166,7 @@ public interface RedisGeoCommands {
  * @param member must not be {@literal null}.
  * @param radius must not be {@literal null}.
  * @return never {@literal null}.
- * @see <a href="http://redis.io/commands/georadiusbymember">http://redis.io/commands/georadiusbymember</a>
+ * @see <a href="http://redis.io/commands/georadiusbymember">Redis Documentation: GEORADIUSBYMEMBER</a>
  */
 GeoResults<GeoLocation<byte[]>> geoRadiusByMember(byte[] key, byte[] member, Distance radius);
 
@@ -178,7 +179,7 @@ public interface RedisGeoCommands {
  * @param radius must not be {@literal null}.
  * @param args must not be {@literal null}.
  * @return never {@literal null}.
- * @see <a href="http://redis.io/commands/georadiusbymember">http://redis.io/commands/georadiusbymember</a>
+ * @see <a href="http://redis.io/commands/georadiusbymember">Redis Documentation: GEORADIUSBYMEMBER</a>
  */
 GeoResults<GeoLocation<byte[]>> geoRadiusByMember(byte[] key, byte[] member, Distance radius,
 GeoRadiusCommandArgs args);
@@ -189,6 +190,7 @@ GeoResults<GeoLocation<byte[]>> geoRadiusByMember(byte[] key, byte[] member, Dis
  * @param key must not be {@literal null}.
  * @param members must not be {@literal null}.
  * @return Number of elements removed.
+ * @see <a href="http://redis.io/commands/zrem">Redis Documentation: ZREM</a>
  */
 Long geoRemove(byte[] key, byte[]... members);