Add javadocs for trim options

Signed-off-by: Andrew Carbonetto <[email protected]>
Bit-Quill · Apr 1, 2024 · 3df1021 · 3df1021
1 parent f4735dd
commit 3df1021
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/java/client/src/main/java/glide/api/models/commands/StreamAddOptions.java b/java/client/src/main/java/glide/api/models/commands/StreamAddOptions.java
@@ -51,7 +51,7 @@ public abstract static class StreamTrimOptions {
 
         protected abstract String getThreshold();
 
-        public List<String> addTrimOptions() {
+        protected List<String> getRedisApi() {
             List<String> optionArgs = new ArrayList<>();
 
             optionArgs.add(this.getMethod());
@@ -67,6 +67,7 @@ public List<String> addTrimOptions() {
         }
     }
 
+    /** Option to trim the stream according to minimum ID. */
     public static class MinId extends StreamTrimOptions {
         /** Trim the stream according to entry ID. Equivalent to <code>MINID</code> in the Redis API. */
         private final String threshold;
@@ -106,6 +107,7 @@ protected String getThreshold() {
         }
     }
 
+    /** Option to trim the stream according to maximum stream length. */
     public static class MaxLen extends StreamTrimOptions {
         /**
          * Trim the stream according to length.<br>
@@ -161,7 +163,7 @@ public String[] toArgs() {
         }
 
         if (trim != null) {
-            optionArgs.addAll(trim.addTrimOptions());
+            optionArgs.addAll(trim.getRedisApi());
         }
 
         if (id != null) {