Merge pull request #21722 from vespa-engine/bratseth/deprecate-some-orgjson

Deprecate public org.json

3 files changed, 14 insertions, 15 deletions

diff --git a/container-search/src/main/java/com/yahoo/data/JsonProducer.java b/container-search/src/main/java/com/yahoo/data/JsonProducer.java
index 873f2a517d0..763a75d1a46 100644
--- a/container-search/src/main/java/com/yahoo/data/JsonProducer.java
+++ b/container-search/src/main/java/com/yahoo/data/JsonProducer.java
@@ -8,21 +8,17 @@ public interface JsonProducer {
 
     /**
      * Append the JSON representation of this object's data to a StringBuilder.
-     * Note that when passing compact=false the generated string will
-     * be human-readable and containing embedded newlines; also the
-     * exact indentation etc may change, so use compact=true for a
-     * canonical format.
      *
-     * @param target the StringBuilder to append to.
-     * @return the target passed in is also returned (to allow chaining).
+     * @param target the StringBuilder to append to
+     * @return the target passed in is also returned (to allow chaining)
      */
     StringBuilder writeJson(StringBuilder target);
 
     /**
-     * Convenience method equivalent to:
+     * Convenience method equivalent to
      * writeJson(new StringBuilder()).toString()
      *
-     * @return a String containing JSON representation of this object's data.
+     * @return a String containing JSON representation of this object's data
      */
     default String toJson() {
         return writeJson(new StringBuilder()).toString();
diff --git a/container-search/src/main/java/com/yahoo/prelude/hitfield/JSONString.java b/container-search/src/main/java/com/yahoo/prelude/hitfield/JSONString.java
index 10ef3df10f1..3b1b5d5e2d4 100644
--- a/container-search/src/main/java/com/yahoo/prelude/hitfield/JSONString.java
+++ b/container-search/src/main/java/com/yahoo/prelude/hitfield/JSONString.java
@@ -180,6 +180,7 @@ public class JSONString implements Inspectable {
             return renderTarget;
         }
 
+        @Deprecated // TODO: Remove on Vespa 8
         public static StringBuilder renderStruct(StringBuilder renderTarget, JSONObject object, int nestingLevel) {
             StructureFieldRenderer.renderStructure(renderTarget, object, nestingLevel + 1);
             indent(renderTarget, nestingLevel);
@@ -191,7 +192,8 @@ public class JSONString implements Inspectable {
         public abstract void closeTag(StringBuilder renderTarget, int nestingLevel, String closing);
 
         /** Returns a value from an object, or null if not found */
-        protected static Object get(String field,JSONObject source) {
+        @Deprecated // TODO: Remove on Vespa 8
+        protected static Object get(String field, JSONObject source) {
             try {
                 return source.get(field);
             }
@@ -210,7 +212,7 @@ public class JSONString implements Inspectable {
             } else if (value.getClass() == JSONObject.class) {
                 renderStruct(renderTarget, (JSONObject) value, nestingLevel);
             } else {
-                renderTarget.append(value.toString());
+                renderTarget.append(value);
             }
         }
 
@@ -246,14 +248,14 @@ public class JSONString implements Inspectable {
             renderTarget.append('\n');
             indent(renderTarget, nestingLevel);
             renderTarget.append("<item><key>");
-            renderValue(get("key",object), renderTarget, nestingLevel);
+            renderValue(get("key", object), renderTarget, nestingLevel);
             renderTarget.append("</key><value>");
-            renderValue(get("value",object), renderTarget, nestingLevel);
+            renderValue(get("value", object), renderTarget, nestingLevel);
             renderTarget.append("</value></item>");
         }
 
         /** Returns a value from an array, or null if it does not exist */
-        private static Object get(int index,JSONArray source) {
+        private static Object get(int index, JSONArray source) {
             try {
                 return source.get(index);
             }
@@ -279,8 +281,8 @@ public class JSONString implements Inspectable {
         public static void renderStructure(StringBuilder renderTarget, JSONObject structure, int nestingLevel) {
             for (Iterator<?> i = structure.keys(); i.hasNext();) {
                 String key = (String) i.next();
-                Object value=get(key,structure);
-                if (value==null) continue;
+                Object value = get(key, structure);
+                if (value == null) continue;
                 renderTarget.append('\n');
                 indent(renderTarget, nestingLevel);
                 renderTarget.append("<struct-field name=\"").append(key).append("\">");
diff --git a/container-search/src/main/java/com/yahoo/search/result/PositionsData.java b/container-search/src/main/java/com/yahoo/search/result/PositionsData.java
index 67357bde14c..56705c292b4 100644
--- a/container-search/src/main/java/com/yahoo/search/result/PositionsData.java
+++ b/container-search/src/main/java/com/yahoo/search/result/PositionsData.java
@@ -27,6 +27,7 @@ public class PositionsData implements Inspectable, JsonProducer, XmlProducer {
         return value;
     }
 
+    @Override
     public String toString() {
         return toJson();
     }