Package org.kordamp.json
Interface JSON
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
AbstractJSON
,JSONArray
,JSONNull
,JSONObject
Marker interface, identifies a valid JSON value.
A JSON value may be a
A JSON value may be a
JSONObject
, a JSONArray
or a
JSONNull
.-
Method Summary
Modifier and TypeMethodDescriptionboolean
isArray()
Returns true if this object is a JSONArray, false otherwise.boolean
isEmpty()
Returns true if this object has no elements or keys.int
size()
Returns the number of properties in an object or the size of the array.toString
(int indentFactor) Make a prettyprinted JSON text.toString
(int indentFactor, int indent) Make a prettyprinted JSON text.Write the contents as JSON text to a writer.Writes the canonicalized form of this JSON object.
-
Method Details
-
isArray
boolean isArray()Returns true if this object is a JSONArray, false otherwise. -
isEmpty
boolean isEmpty()Returns true if this object has no elements or keys.- Throws:
JSONException
- if called on a 'null' object
-
size
int size()Returns the number of properties in an object or the size of the array.- Returns:
- the size of an json object or array
- Throws:
JSONException
- if called on a 'null' object
-
toString
Make a prettyprinted JSON text. Warning: This method assumes that the data structure is acyclical.- Parameters:
indentFactor
- The number of spaces to add to each level of indentation.- Returns:
- a printable, displayable, portable, transmittable representation
of the object, beginning with
{
(left brace) and ending with}
(right brace). - Throws:
JSONException
- If the object contains an invalid number.
-
toString
Make a prettyprinted JSON text. Warning: This method assumes that the data structure is acyclical.- Parameters:
indentFactor
- The number of spaces to add to each level of indentation.indent
- The indentation of the top level.- Returns:
- a printable, displayable, transmittable representation of the
object, beginning with
{
(left brace) and ending with}
(right brace). - Throws:
JSONException
- If the object contains an invalid number.
-
write
Write the contents as JSON text to a writer. For compactness, no whitespace is added. Warning: This method assumes that the data structure is acyclical.- Returns:
- The writer.
- Throws:
JSONException
IOException
-
writeCanonical
Writes the canonicalized form of this JSON object.- Throws:
IOException
-