fix #12, Add doc for nil (#14)

Signed-off-by: bodong.ybd <[email protected]>

Author: yangbodong22011

src/main/java/io/valkey/Jedis.java

@@ -77,7 +77,7 @@ public interface ControlBinaryCommands extends AccessControlLogBinaryCommands, C
    * See for details: <a href="https://redis.io/commands/memory-usage">MEMORY USAGE key</a>
    *
    * @param key The key in Redis server
-   * @return The memory usage in bytes, or nil when the key does not exist
+   * @return The memory usage in bytes, or nil(Java's null) when the key does not exist
    */
   Long memoryUsage(byte[] key);
 
@@ -89,7 +89,7 @@ public interface ControlBinaryCommands extends AccessControlLogBinaryCommands, C
    * See for details: <a href="https://redis.io/commands/memory-usage">MEMORY USAGE key SAMPLES count</a>
    *
    * @param key The key in Redis server
-   * @return The memory usage in bytes, or nil when the key does not exist
+   * @return The memory usage in bytes, or nil(Java's null) when the key does not exist
    */
   Long memoryUsage(byte[] key, int samples);
 

src/main/java/io/valkey/commands/ControlBinaryCommands.java

@@ -78,7 +78,7 @@ public interface ControlCommands extends AccessControlLogCommands, ClientCommand
    * See for details: <a href="https://redis.io/commands/memory-usage">MEMORY USAGE key</a>
    *
    * @param key The key in Redis server
-   * @return The memory usage in bytes, or {@code nil} when the key does not exist
+   * @return The memory usage in bytes, or {@code nil(Java's null)} when the key does not exist
    */
   Long memoryUsage(String key);
 
@@ -90,7 +90,7 @@ public interface ControlCommands extends AccessControlLogCommands, ClientCommand
    * See for details: <a href="https://redis.io/commands/memory-usage">MEMORY USAGE key SAMPLES count</a>
    *
    * @param key The key in Redis server
-   * @return The memory usage in bytes, or {@code nil} when the key does not exist
+   * @return The memory usage in bytes, or {@code nil(Java's null)} when the key does not exist
    */
   Long memoryUsage(String key, int samples);
 

src/main/java/io/valkey/commands/ControlCommands.java

@@ -608,7 +608,7 @@ public interface KeyCommands {
    * Return a randomly selected key from the currently selected DB.
    * <p>
    * Time complexity: O(1)
-   * @return The random key, or {@code nil} when the database is empty
+   * @return The random key, or {@code nil(Java's null)} when the database is empty
    */
   String randomKey();
 

src/main/java/io/valkey/commands/KeyCommands.java

@@ -116,7 +116,7 @@ public interface ListCommands {
    * and so on.
    * <p>
    * If the value stored at key is not of list type an error is returned. If the index is out of
-   * range a 'nil' reply is returned.
+   * range a 'nil(Java's null)' reply is returned.
    * <p>
    * Note that even if the average time complexity is O(n) asking for the first or the last element
    * of the list is O(1).
@@ -168,7 +168,7 @@ public interface ListCommands {
    * if the list contains the elements "a","b","c" LPOP will return "a" and the list will become
    * "b","c".
    * <p>
-   * If the key does not exist or the list is already empty the special value 'nil' is returned.
+   * If the key does not exist or the list is already empty the special value 'nil(Java's null)' is returned.
    * @param key
    * @return The popped element
    */
@@ -180,19 +180,19 @@ public interface ListCommands {
    * "b","c".
    * @param key
    * @param count
-   * @return A list of popped elements, or 'nil' when key does not exist
+   * @return A list of popped elements, or 'nil(Java's null)' when key does not exist
    */
   List<String> lpop(String key, int count);
 
   /**
    * Returns the index of the first matching element inside a redis list. If the element is found,
    * its index (the zero-based position in the list) is returned. Otherwise, if no match is found,
-   * 'nil' is returned.
+   * 'nil(Java's null)' is returned.
    * <p>
    * Time complexity: O(N) where N is the number of elements in the list
    * @param key
    * @param element
-   * @return The index of first matching element in the list. Value will be 'nil' when the element
+   * @return The index of first matching element in the list. Value will be 'nil(Java's null)' when the element
    * is not present in the list
    */
   Long lpos(String key, String element);
@@ -211,13 +211,13 @@ public interface ListCommands {
    * @param key
    * @param element
    * @param params {@link LPosParams}
-   * @return The integer representing the matching element, or 'nil' if there is no match
+   * @return The integer representing the matching element, or 'nil(Java's null)' if there is no match
    */
   Long lpos(String key, String element, LPosParams params);
 
   /**
    * Returns the index of matching elements inside a Redis list. If the element is found, its index
-   * (the zero-based position in the list) is returned. Otherwise, if no match is found, nil is returned.
+   * (the zero-based position in the list) is returned. Otherwise, if no match is found, nil(Java's null) is returned.
    * <p>
    * Time complexity: O(N) where N is the number of elements in the list
    * @param key
@@ -243,7 +243,7 @@ public interface ListCommands {
    * "b","c".
    * @param key
    * @param count return up to count elements
-   * @return A list of count popped elements, or 'nil' when key does not exist.
+   * @return A list of count popped elements, or 'nil(Java's null)' when key does not exist.
    */
   List<String> rpop(String key, int count);
 
@@ -346,7 +346,7 @@ public interface ListCommands {
    * elements "a","b","c" and the destination list contains the elements "foo","bar" after an
    * RPOPLPUSH command the content of the two lists will be "a","b" and "c","foo","bar".
    * <p>
-   * If the key does not exist or the list is already empty the special value 'nil' is returned. If
+   * If the key does not exist or the list is already empty the special value 'nil(Java's null)' is returned. If
    * the srckey and dstkey are the same the operation is equivalent to removing the last element
    * from the list and pushing it as first element of the list, so it's a "list rotation" command.
    * <p>

src/main/java/io/valkey/commands/ListCommands.java

@@ -44,14 +44,14 @@ public interface SetCommands {
 
   /**
    * Remove a random element from a Set returning it as return value. If the Set is empty or the key
-   * does not exist, a nil object is returned.
+   * does not exist, a nil(Java's null) object is returned.
    * <p>
    * The {@link SetCommands#srandmember(String)} command does a similar work but the returned element is
    * not removed from the Set.
    * <p>
    * Time complexity O(1)
    * @param key
-   * @return The removed member, or nil when key does not exist
+   * @return The removed member, or nil(Java's null) when key does not exist
    */
   String spop(String key);
 
@@ -99,7 +99,7 @@ public interface SetCommands {
 
   /**
    * Return a random element from a Set, without removing the element. If the Set is empty or the
-   * key does not exist, a nil object is returned.
+   * key does not exist, a nil(Java's null) object is returned.
    * <p>
    * The {@link SetCommands#spop(String) SPOP} command does a similar work but the returned element
    * is popped (removed) from the Set.

src/main/java/io/valkey/commands/SetCommands.java

@@ -129,13 +129,13 @@ public interface SortedSetCommands {
    * Return the rank (or index) of member in the sorted set at key, with scores being ordered from
    * low to high.
    * <p>
-   * When the given member does not exist in the sorted set, the special value 'nil' is returned.
+   * When the given member does not exist in the sorted set, the special value 'nil(Java's null)' is returned.
    * The returned rank (or index) of the member is 0-based for both commands.
    * <p>
    * Time complexity O(log(N))
    * @param key
    * @param member
-   * @return The rank of the element as an integer reply if the element exists. A nil bulk reply
+   * @return The rank of the element as an integer reply if the element exists. A nil(Java's null) bulk reply
    * if there is no such element
    */
   Long zrank(String key, String member);
@@ -144,13 +144,13 @@ public interface SortedSetCommands {
    * Return the rank (or index) of member in the sorted set at key, with scores being ordered from
    * high to low.
    * <p>
-   * When the given member does not exist in the sorted set, the special value 'nil' is returned.
+   * When the given member does not exist in the sorted set, the special value 'nil(Java's null)' is returned.
    * The returned rank (or index) of the member is 0-based for both commands.
    * <p>
    * Time complexity O(log(N))
    * @param key
    * @param member
-   * @return The rank of the element as an integer reply if the element exists. A nil bulk reply
+   * @return The rank of the element as an integer reply if the element exists. A nil(Java's null) bulk reply
    * if there is no such element
    */
   Long zrevrank(String key, String member);
@@ -289,7 +289,7 @@ public interface SortedSetCommands {
 
   /**
    * Return the score of the specified element of the sorted set at key. If the specified element
-   * does not exist in the sorted set, or the key does not exist at all, a special 'nil' value is
+   * does not exist in the sorted set, or the key does not exist at all, a special 'nil(Java's null)' value is
    * returned.
    * <p>
    * Time complexity O(1)
@@ -301,7 +301,7 @@ public interface SortedSetCommands {
 
   /**
    * Return the scores associated with the specified members in the sorted set stored at key.
-   * For every member that does not exist in the sorted set, a nil value is returned.
+   * For every member that does not exist in the sorted set, a nil(Java's null) value is returned.
    * <p>
    * Time complexity O(N) where N is the number of members being requested
    * @param key

src/main/java/io/valkey/commands/SortedSetCommands.java

@@ -36,7 +36,7 @@ public interface StringCommands extends BitCommands {
 
   /**
    * <b><a href="http://redis.io/commands/get">Get Command</a></b>
-   * Get the value of the specified key. If the key does not exist the special value 'nil' is
+   * Get the value of the specified key. If the key does not exist the special value 'nil(Java's null)' is
    * returned. If the value stored at key is not a string an error is returned because GET can only
    * handle string values.
    * <p>
@@ -163,7 +163,7 @@ public interface StringCommands extends BitCommands {
   /**
    * <b><a href="http://redis.io/commands/mget">MGet Command</a></b>
    * Get the values of all the specified keys. If one or more keys don't exist or is not of type
-   * String, a 'nil' value is returned instead of the value of the specified key, but the operation
+   * String, a 'nil(Java's null)' value is returned instead of the value of the specified key, but the operation
    * never fails.
    * <p>
    * Time complexity: O(1) for every key