github/jooq
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[#3143] Bad Javadoc in the org.jooq.tools.json package: JSON tools are not "JSONAware"

Browse Source
This commit is contained in:
Lukas Eder 2014-03-24 14:59:01 +01:00
parent 9159d9f14b
commit 54a1f4cbba
3 changed files with 5 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
jOOQ/src/main/java/org/jooq/tools/json/JSONArray.java
View File

@ -53,9 +53,7 @@ public class JSONArray extends ArrayList {
}
/**
* Encode a list into JSON text and write it to out. If this list is also a
* JSONStreamAware or a JSONAware, JSONStreamAware and JSONAware specific
* behaviours will be ignored at this top level.
* Encode a list into JSON text and write it to out.
*
* @see JSONValue#writeJSONString(Object, Writer)
*/
@ -87,9 +85,7 @@ public class JSONArray extends ArrayList {
}
/**
* Convert a list to JSON text. The result is a JSON array. If this list is
* also a JSONAware, JSONAware specific behaviours will be omitted at this
* top level.
* Convert a list to JSON text. The result is a JSON array.
*
* @see JSONValue#toJSONString(Object)
* @return JSON text, or "null" if list is null.

9
jOOQ/src/main/java/org/jooq/tools/json/JSONObject.java
View File

@ -26,6 +26,7 @@ import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
/**
* A JSON object. Key value pairs are unordered. JSONObject supports
* java.util.Map interface.
@ -46,9 +47,7 @@ public class JSONObject extends HashMap{
}
/**
* Encode a map into JSON text and write it to out. If this map is also a
* JSONAware or JSONStreamAware, JSONAware or JSONStreamAware specific
* behaviours will be ignored at this top level.
* Encode a map into JSON text and write it to out.
*
* @see JSONValue#writeJSONString(Object, Writer)
*/
@ -78,9 +77,7 @@ public class JSONObject extends HashMap{
}
/**
* Convert a map to JSON text. The result is a JSON object. If this map is
* also a JSONAware, JSONAware specific behaviours will be omitted at this
* top level.
* Convert a map to JSON text. The result is a JSON object.
*
* @see JSONValue#toJSONString(Object)
* @return JSON text, or "null" if map is null.

15
jOOQ/src/main/java/org/jooq/tools/json/JSONValue.java
View File

@ -33,14 +33,6 @@ public class JSONValue {
/**
* Encode an object into JSON text and write it to out.
* <p>
* If this object is a Map or a List, and it's also a JSONStreamAware or a
* JSONAware, JSONStreamAware or JSONAware will be considered firstly.
* <p>
* DO NOT call this method from writeJSONString(Writer) of a class that
* implements both JSONStreamAware and (Map or List) with "this" as the
* first parameter, use JSONObject.writeJSONString(Map, Writer) or
* JSONArray.writeJSONString(List, Writer) instead.
*
* @see JSONObject#writeJSONString(Map, Writer)
* @see JSONArray#writeJSONString(List, Writer)
@ -99,13 +91,6 @@ public class JSONValue {
/**
* Convert an object to JSON text.
* <p>
* If this object is a Map or a List, and it's also a JSONAware, JSONAware
* will be considered firstly.
* <p>
* DO NOT call this method from toJSONString() of a class that implements
* both JSONAware and Map or List with "this" as the parameter, use
* JSONObject.toJSONString(Map) or JSONArray.toJSONString(List) instead.
*
* @see JSONObject#toJSONString(Map)
* @see JSONArray#toJSONString(List)