aboutsummaryrefslogtreecommitdiffstats
path: root/datarouter-prov/src/main/java/org/json/JSONString.java
diff options
context:
space:
mode:
authorsg481n <sg481n@att.com>2017-10-23 15:57:53 +0000
committersg481n <sg481n@att.com>2017-10-23 15:57:58 +0000
commit1e82726317c05bb164943088d4ebaaeb5300960d (patch)
treed41898281b7fc3130ef98dd4ceac773a190e2320 /datarouter-prov/src/main/java/org/json/JSONString.java
parentee6b47caf5bff344baf3a0616ef3e32c93ba9da3 (diff)
Reinstate JSON license notices in datarouter
Issue-ID: DMAAP-166 Change-Id: I14b15c12156ec783b5bf48e02d18bf5b01d18472 Signed-off-by: sg481n <sg481n@att.com>
Diffstat (limited to 'datarouter-prov/src/main/java/org/json/JSONString.java')
-rw-r--r--datarouter-prov/src/main/java/org/json/JSONString.java16
1 files changed, 14 insertions, 2 deletions
diff --git a/datarouter-prov/src/main/java/org/json/JSONString.java b/datarouter-prov/src/main/java/org/json/JSONString.java
index d8772efe..d01ae339 100644
--- a/datarouter-prov/src/main/java/org/json/JSONString.java
+++ b/datarouter-prov/src/main/java/org/json/JSONString.java
@@ -21,8 +21,20 @@
* *
******************************************************************************/
package org.json;
-
+/**
+ * The <code>JSONString</code> interface allows a <code>toJSONString()</code>
+ * method so that a class can change the behavior of
+ * <code>JSONObject.toString()</code>, <code>JSONArray.toString()</code>,
+ * and <code>JSONWriter.value(</code>Object<code>)</code>. The
+ * <code>toJSONString</code> method will be used instead of the default behavior
+ * of using the Object's <code>toString()</code> method and quoting the result.
+ */
public interface JSONString {
-
+ /**
+ * The <code>toJSONString</code> method allows a class to produce its own JSON
+ * serialization.
+ *
+ * @return A strictly syntactically correct JSON text.
+ */
public String toJSONString();
}