com.api.json

Class JSONObject

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

com.api.json.JSONObject

All Implemented Interfaces:

JSONArtifact, Serializable, Cloneable, Map<String,Object>

public class JSONObject
extends HashMap<String,Object>
implements JSONArtifact

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
JSONObject() Constructor

Method Summary

Modifier and Type	Method and Description
static boolean	isValidObject(Object object) Determines whether the supplied object is a valid JSON value
static boolean	isValidType(Class<?> clazz) Determines whether the supplied class is a valid JSON type
Object	merge(String key, Object value, BiFunction<Object,Object,Object> remappingFunction) Provides merger of the supplied key and value according to logic ni the supplied remappingFunction
static JSONObject	parse(InputStream is) Parse the supplied input stream to generate a JSONObject
static JSONObject	parse(Reader reader) Parse the supplied reader to generate a JSONObject
static JSONObject	parse(String input) Parse the supplied input to generate a JSONObject
Object	put(String key, Object value)
void	putAll(Map m)
Object	putIfAbsent(String key, Object value)
Object	replace(String key, Object value)
boolean	replace(String key, Object oldValue, Object value)
String	serialize() Convert this object into a String of JSON text.
String	serialize(boolean verbose)
void	serialize(OutputStream os) Convert this object into a stream of JSON text.
void	serialize(OutputStream os, boolean verbose) Convert this object into a stream of JSON text.
void	serialize(Writer writer) Convert this object into a stream of JSON text.
void	serialize(Writer writer, boolean verbose) Convert this object into a stream of JSON text, specifying verbosity.
String	toString()
String	toString(StringBuffer sb, int indent, int incr) Abstract method to help with recursive formatting of JSON into a String

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, remove, remove, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

JSONObject

public JSONObject()

Constructor

Method Detail

isValidObject

public static boolean isValidObject(Object object)

Determines whether the supplied object is a valid JSON value

Parameters:

object - The object to be tested for validity

Returns:

True if the supplied object is a valid JSON value

isValidType

public static boolean isValidType(Class<?> clazz)

Determines whether the supplied class is a valid JSON type

Parameters:

clazz - The class to be tested for validity

Returns:

True if the supplied class is a valid JSON type

parse

public static JSONObject parse(InputStream is)
                        throws IOException

Parse the supplied input stream to generate a JSONObject

Parameters:

is - InputStream to be parsed

Returns:

JSONObject parsed from the supplied input stream

Throws:

IOException - if an error occurs reading or parsing the input stream

parse

public static JSONObject parse(Reader reader)
                        throws IOException

Parse the supplied reader to generate a JSONObject

Parameters:

reader - Reader to be parsed

Returns:

JSONObject parsed from the supplied reader

Throws:

IOException - if an error occurs reading or parsing the reader

parse

public static JSONObject parse(String input)
                        throws IOException

Parse the supplied input to generate a JSONObject

Parameters:

input - InputStream to be parsed

Returns:

JSONObject parsed from the supplied input

Throws:

IOException - if an error occurs reading or parsing the input

merge

public Object merge(String key,
                    Object value,
                    BiFunction<Object,Object,Object> remappingFunction)

Provides merger of the supplied key and value according to logic ni the supplied remappingFunction

Parameters:

key - The key of the object to be merged

value - The value of the object to be merged

remappingFunction - The function to control how merger is accomplished

Returns:

The resulting object after merger

put

public Object put(String key,
                  Object value)

Specified by:

put in interface Map<String,Object>

Overrides:

put in class HashMap<String,Object>

See Also:

HashMap.put(java.lang.Object, java.lang.Object)

putAll

public void putAll(Map m)

Specified by:

putAll in interface Map<String,Object>

Overrides:

putAll in class HashMap<String,Object>

See Also:

HashMap.putAll(java.util.Map)

putIfAbsent

public Object putIfAbsent(String key,
                          Object value)

Specified by:

putIfAbsent in interface Map<String,Object>

Overrides:

putIfAbsent in class HashMap<String,Object>

See Also:

HashMap.putIfAbsent(java.lang.Object, java.lang.Object)

replace

public Object replace(String key,
                      Object value)

Specified by:

replace in interface Map<String,Object>

Overrides:

replace in class HashMap<String,Object>

See Also:

HashMap.replace(java.lang.Object, java.lang.Object)

replace

public boolean replace(String key,
                       Object oldValue,
                       Object value)

Specified by:

replace in interface Map<String,Object>

Overrides:

replace in class HashMap<String,Object>

See Also:

HashMap.replace(java.lang.Object, java.lang.Object, java.lang.Object)

serialize

public String serialize()
                 throws IOException

Description copied from interface: JSONArtifact

Convert this object into a String of JSON text.

Specified by:

serialize in interface JSONArtifact

Returns:

String containing the JSON formatted according to the verbose flag.

Throws:

IOException - Thrown on IO errors during serialization.

See Also:

JSONArtifact.serialize()

serialize

public String serialize(boolean verbose)
                 throws IOException

Specified by:

serialize in interface JSONArtifact

Parameters:

verbose - Whether or not to write the JSON text in a verbose format.

Returns:

String containing the JSON formatted according to the verbose flag.

Throws:

IOException - Thrown on IO errors during serialization.

See Also:

JSONArtifact.serialize(boolean)

serialize

public void serialize(OutputStream os)
               throws IOException

Description copied from interface: JSONArtifact

Convert this object into a stream of JSON text. Same as calling serialize(os,false); Note that encoding is always written as UTF-8, as per JSON spec.

Specified by:

serialize in interface JSONArtifact

Parameters:

os - The output stream to serialize data to.

Throws:

IOException - Thrown on IO errors during serialization.

See Also:

JSONArtifact.serialize(java.io.OutputStream)

serialize

public void serialize(OutputStream os,
                      boolean verbose)
               throws IOException

Description copied from interface: JSONArtifact

Convert this object into a stream of JSON text. Same as calling serialize(writer,false); Note that encoding is always written as UTF-8, as per JSON spec.

Specified by:

serialize in interface JSONArtifact

Parameters:

os - The output stream to serialize data to.

verbose - Whether or not to write the JSON text in a verbose format.

Throws:

IOException - Thrown on IO errors during serialization.

See Also:

JSONArtifact.serialize(java.io.OutputStream, boolean)

serialize

public void serialize(Writer writer)
               throws IOException

Description copied from interface: JSONArtifact

Convert this object into a stream of JSON text. Same as calling serialize(writer,false);

Specified by:

serialize in interface JSONArtifact

Parameters:

writer - The writer which to serialize the JSON text to.

Throws:

IOException - Thrown on IO errors during serialization.

See Also:

JSONArtifact.serialize(java.io.Writer)

serialize

public void serialize(Writer writer,
                      boolean verbose)
               throws IOException

Description copied from interface: JSONArtifact

Convert this object into a stream of JSON text, specifying verbosity.

Specified by:

serialize in interface JSONArtifact

Parameters:

writer - The writer which to serialize the JSON text to.

verbose - Whether or not to write the JSON text in a verbose format.

Throws:

IOException - Thrown on IO errors during serialization.

See Also:

JSONArtifact.serialize(java.io.Writer, boolean)

toString

public String toString()

Overrides:

toString in class AbstractMap<String,Object>

Returns:

An unformatted rendering of this JSONObject

toString

public String toString(StringBuffer sb,
                       int indent,
                       int incr)

Description copied from interface: JSONArtifact

Abstract method to help with recursive formatting of JSON into a String

Specified by:

toString in interface JSONArtifact

Parameters:

sb - Buffer to receive formatted JSON content

indent - The amount of indentation expected in the formatted output.

incr - the amount of incremental spacing used for formatted output.

Returns:

Formatted JSON output.

See Also:

JSONArtifact.toString(java.lang.StringBuffer, int, int)