From f1d5e6755ecde76b1411c60f9a00437c76ec1f82 Mon Sep 17 00:00:00 2001
From: SanHalacogluImproving
 <144171266+SanHalacogluImproving@users.noreply.github.com>
Date: Tue, 5 Mar 2024 12:10:21 -0800
Subject: [PATCH] Java: Added examples to documentation for StringCommands.
 (#120) (#1068)

* Java: Added examples to documentation for StringCommands. (#120)

* Minor Documentation changes.

* Minor documentation changes.
---
 .../glide/api/commands/StringCommands.java    | 58 +++++++++++++++++++
 1 file changed, 58 insertions(+)

diff --git a/java/client/src/main/java/glide/api/commands/StringCommands.java b/java/client/src/main/java/glide/api/commands/StringCommands.java
index 97bb98fa31..7431927947 100644
--- a/java/client/src/main/java/glide/api/commands/StringCommands.java
+++ b/java/client/src/main/java/glide/api/commands/StringCommands.java
@@ -22,6 +22,14 @@ public interface StringCommands {
      * @param key The <code>key</code> to retrieve from the database.
      * @return Response from Redis. If <code>key</code> exists, returns the <code>value</code> of
      *     <code>key</code> as a <code>String</code>. Otherwise, return <code>null</code>.
+     * @example
+     *     <pre>{@code
+     * String payload = client.get("key").get();
+     * assert payload.equals("value");
+     *
+     * String payload = client.get("non_existing_key").get();
+     * assert payload.equals(null);
+     * }</pre>
      */
     CompletableFuture<String> get(String key);
 
@@ -32,6 +40,11 @@ public interface StringCommands {
      * @param key The <code>key</code> to store.
      * @param value The value to store with the given <code>key</code>.
      * @return Response from Redis containing <code>"OK"</code>.
+     * @example
+     *     <pre>{@code
+     * String payload = client.set("key", "value").get();
+     * assert payload.equals("OK");
+     * }</pre>
      */
     CompletableFuture<String> set(String key, String value);
 
@@ -47,6 +60,16 @@ public interface StringCommands {
      *     {@link ConditionalSet#ONLY_IF_EXISTS} or {@link ConditionalSet#ONLY_IF_DOES_NOT_EXIST}
      *     conditions, return <code>null</code>. If {@link SetOptionsBuilder#returnOldValue(boolean)}
      *     is set, return the old value as a <code>String</code>.
+     * @example
+     *     <pre>{@code
+     * String payload =
+     *         client.set("key", "value", SetOptions.builder()
+     *                 .conditionalSet(ONLY_IF_EXISTS)
+     *                 .expiry(SetOptions.Expiry.Seconds(5L))
+     *                 .build())
+     *                 .get();
+     * assert payload.equals("OK");
+     * }</pre>
      */
     CompletableFuture<String> set(String key, String value, SetOptions options);
 
@@ -58,6 +81,11 @@ public interface StringCommands {
      * @return An array of values corresponding to the provided <code>keys</code>.<br>
      *     If a <code>key</code>is not found, its corresponding value in the list will be <code>null
      *     </code>.
+     * @example
+     *     <pre>{@code
+     * String payload = client.mget(new String[] {"key1", "key2"}).get();
+     * assert payload.equals(new String[] {"value1", "value2"});
+     * }</pre>
      */
     CompletableFuture<String[]> mget(String[] keys);
 
@@ -67,6 +95,11 @@ public interface StringCommands {
      * @see <a href="https://redis.io/commands/mset/">redis.io</a> for details.
      * @param keyValueMap A key-value map consisting of keys and their respective values to set.
      * @return Always <code>OK</code>.
+     * @example
+     *     <pre>{@code
+     * String payload = client.mset(Map.of("key1", "value1", "key2", "value2"}).get();
+     * assert payload.equals("OK"));
+     * }</pre>
      */
     CompletableFuture<String> mset(Map<String, String> keyValueMap);
 
@@ -77,6 +110,11 @@ public interface StringCommands {
      * @see <a href="https://redis.io/commands/incr/">redis.io</a> for details.
      * @param key The key to increment its value.
      * @return The value of <code>key</code> after the increment.
+     * @example
+     *     <pre>{@code
+     * Long num = client.incr("key").get();
+     * assert num == 5L;
+     * }</pre>
      */
     CompletableFuture<Long> incr(String key);
 
@@ -88,6 +126,11 @@ public interface StringCommands {
      * @param key The key to increment its value.
      * @param amount The amount to increment.
      * @return The value of <code>key</code> after the increment.
+     * @example
+     *     <pre>{@code
+     * Long num = client.incrBy("key", 2).get();
+     * assert num == 7L;
+     * }</pre>
      */
     CompletableFuture<Long> incrBy(String key, long amount);
 
@@ -101,6 +144,11 @@ public interface StringCommands {
      * @param key The key to increment its value.
      * @param amount The amount to increment.
      * @return The value of <code>key</code> after the increment.
+     * @example
+     *     <pre>{@code
+     * Long num = client.incrByFloat("key", 0.5).get();
+     * assert num == 7.5;
+     * }</pre>
      */
     CompletableFuture<Double> incrByFloat(String key, double amount);
 
@@ -111,6 +159,11 @@ public interface StringCommands {
      * @see <a href="https://redis.io/commands/decr/">redis.io</a> for details.
      * @param key The key to decrement its value.
      * @return The value of <code>key</code> after the decrement.
+     * @example
+     *     <pre>{@code
+     * Long num = client.decr("key").get();
+     * assert num == 4L;
+     * }</pre>
      */
     CompletableFuture<Long> decr(String key);
 
@@ -122,6 +175,11 @@ public interface StringCommands {
      * @param key The key to decrement its value.
      * @param amount The amount to decrement.
      * @return The value of <code>key</code> after the decrement.
+     * @example
+     *     <pre>{@code
+     * Long num = client.decrBy("key", 2).get();
+     * assert num == 2L;
+     * }</pre>
      */
     CompletableFuture<Long> decrBy(String key, long amount);
 }