Deprecate more items that will be removed in Jedis 5

sazzad16 · Aug 22, 2023 · 358bd02 · 358bd02
1 parent 4916bd3
commit 358bd02
Show file tree

Hide file tree

Showing 20 changed files with 48 additions and 1 deletion.
diff --git a/src/main/java/redis/clients/jedis/BuilderFactory.java b/src/main/java/redis/clients/jedis/BuilderFactory.java
@@ -205,6 +205,10 @@ public String toString() {
     }
   };
 
+  /**
+   * @deprecated Use {@link BuilderFactory#BINARY}.
+   */
+  @Deprecated
   public static final Builder<byte[]> BYTE_ARRAY = new Builder<byte[]>() {
     @Override
     public byte[] build(Object data) {
@@ -217,6 +221,10 @@ public String toString() {
     }
   };
 
+  /**
+   * @deprecated {@link BuilderFactory#BINARY_LIST}.
+   */
+  @Deprecated
   public static final Builder<List<byte[]>> BYTE_ARRAY_LIST = new Builder<List<byte[]>>() {
     @Override
     @SuppressWarnings("unchecked")
@@ -335,6 +343,7 @@ public String toString() {
     }
   };
 
+  @Deprecated
   public static final Builder<Set<String>> STRING_ORDERED_SET = new Builder<Set<String>>() {
     @Override
     @SuppressWarnings("unchecked")

diff --git a/src/main/java/redis/clients/jedis/CommandObjects.java b/src/main/java/redis/clients/jedis/CommandObjects.java
@@ -3711,14 +3711,17 @@ public final CommandObject<List<Long>> jsonDebugMemory(String key, Path2 path) {
     return new CommandObject<>(commandArguments(JsonCommand.DEBUG).add("MEMORY").key(key).add(path), BuilderFactory.LONG_LIST);
   }
 
+  @Deprecated
   public final CommandObject<List<Object>> jsonResp(String key) {
     return new CommandObject<>(commandArguments(JsonCommand.RESP).key(key), BuilderFactory.ENCODED_OBJECT_LIST);
   }
 
+  @Deprecated
   public final CommandObject<List<Object>> jsonResp(String key, Path path) {
     return new CommandObject<>(commandArguments(JsonCommand.RESP).key(key).add(path), BuilderFactory.ENCODED_OBJECT_LIST);
   }
 
+  @Deprecated
   public final CommandObject<List<List<Object>>> jsonResp(String key, Path2 path) {
     return new CommandObject<>(commandArguments(JsonCommand.RESP).key(key).add(path), BuilderFactory.ENCODED_OBJECT_LIST_LIST);
   }

diff --git a/src/main/java/redis/clients/jedis/Queable.java b/src/main/java/redis/clients/jedis/Queable.java
@@ -3,6 +3,7 @@
 import java.util.LinkedList;
 import java.util.Queue;
 
+@Deprecated
 public class Queable {
 
   private final Queue<Response<?>> pipelinedResponses = new LinkedList<>();

diff --git a/src/main/java/redis/clients/jedis/UnifiedJedis.java b/src/main/java/redis/clients/jedis/UnifiedJedis.java
@@ -4162,16 +4162,19 @@ public List<Long> jsonDebugMemory(String key, Path2 path) {
   }
 
   @Override
+  @Deprecated
   public List<Object> jsonResp(String key) {
     return executeCommand(commandObjects.jsonResp(key));
   }
 
   @Override
+  @Deprecated
   public List<Object> jsonResp(String key, Path path) {
     return executeCommand(commandObjects.jsonResp(key, path));
   }
 
   @Override
+  @Deprecated
   public List<List<Object>> jsonResp(String key, Path2 path) {
     return executeCommand(commandObjects.jsonResp(key, path));
   }

diff --git a/src/main/java/redis/clients/jedis/json/RedisJsonCommands.java b/src/main/java/redis/clients/jedis/json/RedisJsonCommands.java
@@ -167,9 +167,12 @@ default <T> List<T> jsonMGet(Class<T> clazz, String... keys) {
 
   List<Long> jsonDebugMemory(String key, Path2 path);
 
+  @Deprecated
   List<Object> jsonResp(String key);
 
+  @Deprecated
   List<Object> jsonResp(String key, Path path);
 
+  @Deprecated
   List<List<Object>> jsonResp(String key, Path2 path);
 }
diff --git a/src/main/java/redis/clients/jedis/params/Params.java b/src/main/java/redis/clients/jedis/params/Params.java
@@ -9,6 +9,7 @@
 import redis.clients.jedis.args.Rawable;
 import redis.clients.jedis.util.SafeEncoder;
 
+@Deprecated
 public abstract class Params {
 
   private Map<String, Object> params;

diff --git a/src/main/java/redis/clients/jedis/params/SortingParams.java b/src/main/java/redis/clients/jedis/params/SortingParams.java
@@ -70,6 +70,7 @@ public SortingParams nosort() {
     return this;
   }
 
+  @Deprecated
   public Collection<byte[]> getParams() {
     return Collections.unmodifiableCollection(params);
   }

diff --git a/src/main/java/redis/clients/jedis/resps/KeyedListElement.java b/src/main/java/redis/clients/jedis/resps/KeyedListElement.java
@@ -5,7 +5,7 @@
 
 /**
  * This class is used to represent a List element when it is returned with respective key name.
- * @deprecated Use {@link KeyValue}.
+ * @deprecated This class will be removed in next major released. Use {@link KeyValue}.
  */
 @Deprecated
 public class KeyedListElement extends KeyValue<String, String> {

diff --git a/src/main/java/redis/clients/jedis/resps/KeyedZSetElement.java b/src/main/java/redis/clients/jedis/resps/KeyedZSetElement.java
@@ -4,7 +4,9 @@
 
 /**
  * This class is used to represent a SortedSet element when it is returned with respective key name.
+ * @deprecated This class will be removed in next major released.
  */
+@Deprecated
 public class KeyedZSetElement extends Tuple {
 
   private final String key;

diff --git a/src/main/java/redis/clients/jedis/search/Document.java b/src/main/java/redis/clients/jedis/search/Document.java
@@ -35,6 +35,7 @@ public Document(String id, Map<String, Object> fields, double score) {
     this(id, fields, score, null);
   }
 
+  @Deprecated
   public Document(String id, Map<String, Object> fields, double score, byte[] payload) {
     this.id = id;
     this.properties = new HashMap<>(fields);
@@ -46,10 +47,12 @@ public Iterable<Map.Entry<String, Object>> getProperties() {
     return properties.entrySet();
   }
 
+  @Deprecated
   public static Document load(String id, double score, byte[] payload, List<byte[]> fields) {
     return Document.load(id, score, payload, fields, true);
   }
 
+  @Deprecated
   public static Document load(String id, double score, byte[] payload, List<byte[]> fields, boolean decode) {
     Document ret = new Document(id, score);
     ret.payload = payload;
@@ -103,6 +106,7 @@ public double getScore() {
     return score;
   }
 
+  @Deprecated
   public byte[] getPayload() {
     return payload;
   }

diff --git a/src/main/java/redis/clients/jedis/search/FieldName.java b/src/main/java/redis/clients/jedis/search/FieldName.java
@@ -35,6 +35,7 @@ public FieldName as(String attribute) {
     return this;
   }
 
+  @Deprecated
   public int addCommandEncodedArguments(List<String> args) {
     args.add(name);
     if (attribute == null) {
@@ -46,6 +47,7 @@ public int addCommandEncodedArguments(List<String> args) {
     return 3;
   }
 
+  @Deprecated
   public int addCommandBinaryArguments(List<byte[]> args) {
     args.add(SafeEncoder.encode(name));
     if (attribute == null) {

diff --git a/src/main/java/redis/clients/jedis/search/IndexDefinition.java b/src/main/java/redis/clients/jedis/search/IndexDefinition.java
@@ -100,6 +100,7 @@ public IndexDefinition setScore(double score) {
     return this;
   }
 
+  @Deprecated
   public String getPayloadField() {
     return payloadField;
   }

diff --git a/src/main/java/redis/clients/jedis/search/Query.java b/src/main/java/redis/clients/jedis/search/Query.java
@@ -418,6 +418,7 @@ public Query setWithScores() {
     return this;
   }
 
+  @Deprecated
   public boolean getWithPayloads() {
     return _withPayloads;
   }

diff --git a/src/main/java/redis/clients/jedis/search/SearchResult.java b/src/main/java/redis/clients/jedis/search/SearchResult.java
@@ -35,6 +35,7 @@ public static class SearchResultBuilder extends Builder<SearchResult> {
     private final boolean hasPayloads;
     private final boolean decode;
 
+    @Deprecated
     public SearchResultBuilder(boolean hasContent, boolean hasScores, boolean hasPayloads, boolean decode) {
       this.hasContent = hasContent;
       this.hasScores = hasScores;

diff --git a/src/main/java/redis/clients/jedis/search/aggr/AggregationBuilder.java b/src/main/java/redis/clients/jedis/search/aggr/AggregationBuilder.java
@@ -167,6 +167,7 @@ public AggregationBuilder dialect(int dialect) {
     return this;
   }
 
+  @Deprecated
   public List<String> getArgs() {
     return Collections.unmodifiableList(args);
   }

diff --git a/src/main/java/redis/clients/jedis/search/aggr/AggregationResult.java b/src/main/java/redis/clients/jedis/search/aggr/AggregationResult.java
@@ -21,11 +21,13 @@ public class AggregationResult {
 
   private long cursorId = -1;
 
+  @Deprecated
   public AggregationResult(Object resp, long cursorId) {
     this(resp);
     this.cursorId = cursorId;
   }
 
+  @Deprecated
   public AggregationResult(Object resp) {
     List<Object> list = (List<Object>) SafeEncoder.encodeObject(resp);
 

diff --git a/src/main/java/redis/clients/jedis/search/aggr/Group.java b/src/main/java/redis/clients/jedis/search/aggr/Group.java
@@ -22,6 +22,7 @@ public Group reduce(Reducer r) {
     return this;
   }
 
+  @Deprecated
   public Group limit(Limit limit) {
     this.limit = limit;
     return this;
@@ -43,6 +44,7 @@ public void addArgs(List<String> args) {
     args.addAll(limit.getArgs());
   }
 
+  @Deprecated
   public List<String> getArgs() {
     List<String> args = new ArrayList<>();
     addArgs(args);

diff --git a/src/main/java/redis/clients/jedis/search/aggr/Limit.java b/src/main/java/redis/clients/jedis/search/aggr/Limit.java
@@ -6,7 +6,9 @@
 
 /**
  * Created by mnunberg on 2/22/18.
+ * @deprecated This class will be removed in next major released.
  */
+@Deprecated
 public class Limit {
 
   public static final Limit NO_LIMIT = new Limit(0, 0);

diff --git a/src/main/java/redis/clients/jedis/timeseries/TSKeyValue.java b/src/main/java/redis/clients/jedis/timeseries/TSKeyValue.java
@@ -3,6 +3,10 @@
 import java.util.Map;
 import redis.clients.jedis.util.KeyValue;
 
+/**
+ * @deprecated This class will be removed in next major released.
+ */
+@Deprecated
 public class TSKeyValue<V> extends KeyValue<String, V> {
 
   private final Map<String, String> labels;

diff --git a/src/main/java/redis/clients/jedis/timeseries/TSKeyedElements.java b/src/main/java/redis/clients/jedis/timeseries/TSKeyedElements.java
@@ -3,6 +3,10 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * @deprecated This class will be removed in next major released.
+ */
+@Deprecated
 public class TSKeyedElements extends TSKeyValue<List<TSElement>> {
 
   public TSKeyedElements(String key, Map<String, String> labels, List<TSElement> elements) {