com.marklogic.hub.util.json

Class JSONObject

java.lang.Object

com.marklogic.hub.util.json.JSONObject

public class JSONObject
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
JSONObject()
JSONObject(boolean createMapper)
JSONObject(com.fasterxml.jackson.databind.JsonNode json)
JSONObject(java.lang.Object dataVal)

Method Summary

Modifier and Type	Method and Description
java.lang.String	convertMapToJsonString(java.util.Map<java.lang.String,java.lang.Object> map) Converts a Map (String, Object) to a Json String
java.util.List<java.lang.Object>	getArray(java.lang.String key) Gets a list of Objects by key
java.util.List<java.lang.String>	getArrayString(java.lang.String key) Gets a list of String by key
java.util.List<java.lang.String>	getArrayString(java.lang.String key, boolean allowNull) Gets a list of String by key with/without null values
java.lang.Boolean	getBoolean(java.lang.Object key, java.lang.Boolean defaultVal) Gets a Boolean value by key with a default value
java.lang.Boolean	getBoolean(java.lang.String key) Gets a Boolean value by key
int	getInt(java.lang.Object key, int defaultVal) Gets a int value by key with a default value
int	getInt(java.lang.String key) Gets a int value by key with 0 as default value
int	getJsonArraySize(java.lang.String key) Gets json size if it is an array
long	getLong(java.lang.Object key, long defaultVal) Gets a Long value by key with a default value
long	getLong(java.lang.String key) Gets a Long value by key
java.util.Map<java.lang.String,java.lang.Object>	getMap(java.lang.String key) Gets a Map (String, Object) by key
com.fasterxml.jackson.databind.ObjectMapper	getMapper() Returns the mapper
com.fasterxml.jackson.databind.JsonNode	getNode(java.lang.Object key) Gets a JsonNode value by key
com.fasterxml.jackson.databind.JsonNode	getNode(java.lang.Object key, com.fasterxml.jackson.databind.JsonNode defaultVal) Gets a JsonNode value by key with a default value
java.lang.String	getString(java.lang.Object key) Gets a String value by key
java.lang.String	getString(java.lang.Object key, java.lang.String defaultVal) Gets a String value by key with a default value
boolean	isExist(java.lang.String key) Checks if the key is existed or not
com.fasterxml.jackson.databind.JsonNode	jsonNode() Returns the json instance
void	prettyPrint() Makes pretty print for the json instance
void	put(java.lang.String key, java.lang.Object val) Puts (key, value) pairs to the json instance
void	putArray(java.lang.String key, java.util.List<?> valList) Puts a list of Objects into Json Array of the json instance
void	putArray(java.lang.String key, java.lang.Object... vals) Puts a number of Objects into Json Array of the json instance
void	putMap(java.util.Map<java.lang.String,java.lang.Object> map) Puts map entries to the json instance
static com.fasterxml.jackson.databind.JsonNode	readInput(java.io.InputStream istream) Returns a Json node instance from an input stream
static com.fasterxml.jackson.databind.JsonNode	readInput(java.io.Reader reader) Returns a Json node instance from an input reader
static com.fasterxml.jackson.databind.JsonNode	readInput(java.lang.String jsonString) Returns a Json node instance from a json String
java.lang.String	toString()
static java.lang.String	writeValueAsString(java.lang.Object obj) Returns a json string from an Object with pretty print
static java.lang.String	writeValueAsString(java.lang.Object obj, boolean hasPrettyPrint) Returns a json string from an Object with pretty print as a flag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JSONObject

public JSONObject()

JSONObject

public JSONObject(boolean createMapper)

JSONObject

public JSONObject(java.lang.Object dataVal)
           throws java.io.IOException

Throws:

java.io.IOException

JSONObject

public JSONObject(com.fasterxml.jackson.databind.JsonNode json)

Parameters:

json - json node object

Method Detail

readInput

public static com.fasterxml.jackson.databind.JsonNode readInput(java.lang.String jsonString)
                                                         throws java.io.IOException

Returns a Json node instance from a json String

Parameters:

jsonString - json string

Returns:

a json node

Throws:

java.io.IOException - if I/O error occurs

readInput

public static com.fasterxml.jackson.databind.JsonNode readInput(java.io.InputStream istream)
                                                         throws java.io.IOException

Returns a Json node instance from an input stream

Parameters:

istream - input stream object

Returns:

a json node

Throws:

java.io.IOException - if I/O error occurs

readInput

public static com.fasterxml.jackson.databind.JsonNode readInput(java.io.Reader reader)
                                                         throws java.io.IOException

Returns a Json node instance from an input reader

Parameters:

reader - reader object

Returns:

a json node

Throws:

java.io.IOException - if I/O error occurs

writeValueAsString

public static java.lang.String writeValueAsString(java.lang.Object obj)
                                           throws com.fasterxml.jackson.core.JsonProcessingException

Returns a json string from an Object with pretty print

Parameters:

obj - object to be serialized

Returns:

a string object

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if problem with processing json

writeValueAsString

public static java.lang.String writeValueAsString(java.lang.Object obj,
                                                  boolean hasPrettyPrint)
                                           throws com.fasterxml.jackson.core.JsonProcessingException

Returns a json string from an Object with pretty print as a flag

Parameters:

obj - object to be serialized

hasPrettyPrint - boolean flag to pretty print

Returns:

a string object

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if problem with processing json

jsonNode

public com.fasterxml.jackson.databind.JsonNode jsonNode()

Returns the json instance

Returns:

a json node

getMapper

public com.fasterxml.jackson.databind.ObjectMapper getMapper()

Returns the mapper

Returns:

an object mapper

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isExist

public boolean isExist(java.lang.String key)

Checks if the key is existed or not

Parameters:

key - json key

Returns:

boolean flag indicating existence

getJsonArraySize

public int getJsonArraySize(java.lang.String key)

Gets json size if it is an array

Parameters:

key - json key

Returns:

size of array

getNode

public com.fasterxml.jackson.databind.JsonNode getNode(java.lang.Object key)

Gets a JsonNode value by key

Parameters:

key - json key

Returns:

a json node

getNode

public com.fasterxml.jackson.databind.JsonNode getNode(java.lang.Object key,
                                                       com.fasterxml.jackson.databind.JsonNode defaultVal)

Gets a JsonNode value by key with a default value

Parameters:

key - a json key

defaultVal - default json value to return of key not found

Returns:

a json node

getString

public java.lang.String getString(java.lang.Object key)

Gets a String value by key

Parameters:

key - a json key

Returns:

a string value

getString

public java.lang.String getString(java.lang.Object key,
                                  java.lang.String defaultVal)

Gets a String value by key with a default value

Parameters:

key - a json key

defaultVal - default string value to return of key not found

Returns:

string value

getInt

public int getInt(java.lang.String key)

Gets a int value by key with 0 as default value

Parameters:

key - a json key

Returns:

an integer value

getInt

public int getInt(java.lang.Object key,
                  int defaultVal)

Gets a int value by key with a default value

Parameters:

key - a json key

defaultVal - default integer value to return of key not found

Returns:

an integer value

getBoolean

public java.lang.Boolean getBoolean(java.lang.String key)

Gets a Boolean value by key

Parameters:

key - a json key

Returns:

a boolean value

getBoolean

public java.lang.Boolean getBoolean(java.lang.Object key,
                                    java.lang.Boolean defaultVal)

Gets a Boolean value by key with a default value

Parameters:

key - a json key

defaultVal - default boolean value to return of key not found

Returns:

a boolean value

getLong

public long getLong(java.lang.String key)

Gets a Long value by key

Parameters:

key - a json key

Returns:

a long value

getLong

public long getLong(java.lang.Object key,
                    long defaultVal)

Gets a Long value by key with a default value

Parameters:

key - a json key

defaultVal - default long value to return of key not found

Returns:

a long value

getArray

public java.util.List<java.lang.Object> getArray(java.lang.String key)

Gets a list of Objects by key

Parameters:

key - a json key

Returns:

a list of objects

getMap

public java.util.Map<java.lang.String,java.lang.Object> getMap(java.lang.String key)

Gets a Map (String, Object) by key

Parameters:

key - a json key

Returns:

a map of (String, Object)

convertMapToJsonString

public java.lang.String convertMapToJsonString(java.util.Map<java.lang.String,java.lang.Object> map)
                                        throws com.fasterxml.jackson.core.JsonProcessingException

Converts a Map (String, Object) to a Json String

Parameters:

map - a map of (String, Object)

Returns:

a string

Throws:

com.fasterxml.jackson.core.JsonProcessingException - if problem with processing json

putMap

public void putMap(java.util.Map<java.lang.String,java.lang.Object> map)

Puts map entries to the json instance

Parameters:

map - a map of (String, Object)

getArrayString

public java.util.List<java.lang.String> getArrayString(java.lang.String key,
                                                       boolean allowNull)

Gets a list of String by key with/without null values

Parameters:

key - a json key

allowNull - boolean flag to allow for null values

Returns:

list of string values

getArrayString

public java.util.List<java.lang.String> getArrayString(java.lang.String key)

Gets a list of String by key

Parameters:

key - a json key

Returns:

list of string values

put

public void put(java.lang.String key,
                java.lang.Object val)

Puts (key, value) pairs to the json instance

Parameters:

key - a json key

val - a json value

putArray

public void putArray(java.lang.String key,
                     java.lang.Object... vals)

Puts a number of Objects into Json Array of the json instance

Parameters:

key - a json key

vals - a varargs for object/s

putArray

public void putArray(java.lang.String key,
                     java.util.List<?> valList)

Puts a list of Objects into Json Array of the json instance

Parameters:

key - a json key

valList - a list object of values

prettyPrint

public void prettyPrint()

Makes pretty print for the json instance