JsonManager (org.spincast:spincast-framework 0.9.29 API)

All Known Implementing Classes:

SpincastJsonManager
```
public interface JsonManager
```
Provides methods to play with Json strings and objects.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Object`	`clone(Object originalObject)` Tries to clone an object to a `JsonObject` or a `JsonArray`, if the object is not of a primitive type (or `BigDecimal`).
`Object`	`clone(Object originalObject, boolean mutable)` Tries to clone an object to a `JsonObject` or a `JsonArray`, if the object is not of a primitive type (or `BigDecimal`).
`JsonArray`	`cloneJsonArray(JsonArray jsonArray, boolean mutable)` Deep copy of the `JsonArray`, so any modification to the original won't affect the clone, and vice-versa.
`JsonObject`	`cloneJsonObject(JsonObject jsonObject, boolean mutable)` Deep copy of the `JsonObject`, so any modification to the original won't affect the clone, and vice-versa.
`String`	`convertToJsonDate(Date date)` Converts a Date to a `Json` date format.
`Object`	`convertToNativeType(Object originalObject)` Convert a random object to a valid native JsonObject type, if it's not already.
`JsonObject`	`create()` Creates an empty `JsonObject`
`JsonArray`	`createArray()` Creates an empty `JsonArray`.
`JsonObject`	`fromClasspathFile(String path)` Creates a `JsonObject` from a classpath Json file.
`JsonObject`	`fromFile(File jsonFile)` Creates a `JsonObject` from a Json file.
`JsonObject`	`fromFile(String jsonFilePath)` Creates a `JsonObject` from the path of a file, on the file system.
`JsonObject`	`fromInputStream(InputStream inputStream)` Creates a `JsonObject` from an inputStream.
`<T> T`	`fromInputStream(InputStream inputStream, Class<T> clazz)` Creates an instance of the specified `T` type from a `Json` inputStream.
`JsonArray`	`fromInputStreamArray(InputStream inputStream)` Creates a `JsonArray` from an inputStream.
`Map<String,Object>`	`fromInputStreamToMap(InputStream inputStream)` Creates a `Map<String, Object>` from a `Json` inputStream.
`JsonArray`	`fromListArray(List<?> elements)` Creates a `JsonArray` from a `List` of elements.
`JsonObject`	`fromMap(Map<String,?> params)` Creates an empty `JsonObject` based on the specified Map.
`JsonObject`	`fromMap(Map<String,?> params, boolean parseKeysAsJsonPaths)` Creates an empty `JsonObject` based on the specified Map.
`JsonObject`	`fromString(String jsonString)` Creates a `JsonObject` from a `Json` String.
`<T> T`	`fromString(String jsonString, Class<T> clazz)` Creates an instance of the specified `T` type from a `Json` String.
`JsonArray`	`fromStringArray(String jsonString)` Creates a `JsonArray` from a `Json` String.
`Map<String,Object>`	`fromStringToMap(String jsonString)` Creates a `Map<String, Object>` from a `Json` String.
`Object`	`getElementAtJsonPath(JsonArray array, String jsonPath)` Gets an element from the `JsonArray` at the specified `JsonPath`.
`Object`	`getElementAtJsonPath(JsonArray array, String jsonPath, Object defaultElement)` Gets an element from the `JsonArray` at the specified `JsonPath`.
`Object`	`getElementAtJsonPath(JsonObject obj, String jsonPath)` Gets an element from the `JsonObject` at the specified `JsonPath`.
`Object`	`getElementAtJsonPath(JsonObject obj, String jsonPath, Object defaultElement)` Gets an element from the `JsonObject` at the specified `JsonPath`.
`boolean`	`isElementExists(JsonArray array, String jsonPath)` Does the array contain an element at the specified `JsonPath` (even if `null`)?
`boolean`	`isElementExists(JsonObject obj, String jsonPath)` Does the object contain an element at the specified `JsonPath` (even if `null`)?
`Date`	`parseDateFromJson(String str)` Converts a `Json` date to a Java `UTC` date.
`void`	`putElementAtJsonPath(JsonObjectOrArray obj, String jsonPath, Object element)` Puts an element in the object at the specified `JsonPath`.
`void`	`putElementAtJsonPath(JsonObjectOrArray obj, String jsonPath, Object element, boolean clone)` Puts a clone of the element in the object at the specified `JsonPath`.
`void`	`removeElementAtJsonPath(JsonArray array, String jsonPath)` Removes an element at the specified `JsonPath` from the array.
`void`	`removeElementAtJsonPath(JsonObject obj, String jsonPath)` Removes an element at the specified `JsonPath` from the object.
`String`	`toJsonString(Object obj)` Gets the `Json` String representation of the specified object.
`String`	`toJsonString(Object obj, boolean pretty)` Gets the `Json` String representation of the specified object.

- Method Detail
  - create
```
JsonObject create()
```
    Creates an empty JsonObject
  - fromString
```
JsonObject fromString(String jsonString)
```
    Creates a JsonObject from a Json String.
  - fromMap
```
JsonObject fromMap(Map<String,?> params)
```
    Creates an empty JsonObject based on the specified Map. An attempt will be made to create a deep copy of every elements so a modification won't affect any external references and vice-versa.
    The keys will be used as is, not parsed as JsonPaths.
  - fromMap
```
JsonObject fromMap(Map<String,?> params,
                   boolean parseKeysAsJsonPaths)
```
    Creates an empty JsonObject based on the specified Map. An attempt will be made to create a deep copy of every elements so a modification won't affect any external references and vice-versa.
    
    Parameters:
    
    parseKeysAsJsonPaths - if true, the keys will be parsed as JsonPaths, otherwise they will ne used as is.
  - fromInputStream
```
JsonObject fromInputStream(InputStream inputStream)
```
    Creates a JsonObject from an inputStream.
  - fromFile
```
JsonObject fromFile(File jsonFile)
```
    Creates a JsonObject from a Json file.
  - fromFile
```
JsonObject fromFile(String jsonFilePath)
```
    Creates a JsonObject from the path of a file, on the file system.
  - fromClasspathFile
```
JsonObject fromClasspathFile(String path)
```
    Creates a JsonObject from a classpath Json file.
    
    Parameters:
    
    the - path to the classpath file. This path always starts from the root of the classpath.
  - fromStringToMap
```
Map<String,Object> fromStringToMap(String jsonString)
```
    Creates a Map<String, Object> from a Json String.
  - fromInputStreamToMap
```
Map<String,Object> fromInputStreamToMap(InputStream inputStream)
```
    Creates a Map<String, Object> from a Json inputStream.
  - fromString
```
<T> T fromString(String jsonString,
                 Class<T> clazz)
```
    Creates an instance of the specified T type from a Json String.
  - fromInputStream
```
<T> T fromInputStream(InputStream inputStream,
                      Class<T> clazz)
```
    Creates an instance of the specified T type from a Json inputStream.
  - createArray
```
JsonArray createArray()
```
    Creates an empty JsonArray.
  - fromStringArray
```
JsonArray fromStringArray(String jsonString)
```
    Creates a JsonArray from a Json String.
  - fromListArray
```
JsonArray fromListArray(List<?> elements)
```
    Creates a JsonArray from a List of elements.
  - fromInputStreamArray
```
JsonArray fromInputStreamArray(InputStream inputStream)
```
    Creates a JsonArray from an inputStream.
  - toJsonString
```
String toJsonString(Object obj)
```
    Gets the Json String representation of the specified object.
  - toJsonString
```
String toJsonString(Object obj,
                    boolean pretty)
```
    Gets the Json String representation of the specified object.
    
    Parameters:
    
    pretty - if true, the generated String will be formatted.
  - parseDateFromJson
```
Date parseDateFromJson(String str)
```
    Converts a Json date to a Java UTC date.
  - convertToJsonDate
```
String convertToJsonDate(Date date)
```
    Converts a Date to a Json date format.
  - convertToNativeType
```
Object convertToNativeType(Object originalObject)
```
    Convert a random object to a valid native JsonObject type, if it's not already.
  - clone
```
Object clone(Object originalObject)
```
    Tries to clone an object to a JsonObject or a JsonArray, if the object is not of a primitive type (or BigDecimal).
    The cloning is made by serializing the Object to a Json string, and deserializing back. So any (de)serialization rules apply.
    
    The non primitive object will be cloned to a JsonArray if it is a :
    - JsonArray
    - Collection
    - Array
  - clone
```
Object clone(Object originalObject,
             boolean mutable)
```
    Tries to clone an object to a JsonObject or a JsonArray, if the object is not of a primitive type (or BigDecimal).
    The cloning is made by serializing the Object to a Json string, and deserializing back. So any (de)serialization rules apply.
    
    The non primitive object will be cloned to a JsonArray if it is a :
    - JsonArray
    - Collection
    - Array
    Parameters:
    
    mutable - if false, the resulting Object and all its potential children will be immutable.
  - cloneJsonObject
```
JsonObject cloneJsonObject(JsonObject jsonObject,
                           boolean mutable)
```
    Deep copy of the JsonObject, so any modification to the original won't affect the clone, and vice-versa.
    Note that if the current object is immutable and the mutable parameter is set to false, then the current object will be returned as is, since no cloning is required.
    
    Parameters:
    
    mutable - if true the resulting array and all its children will be mutable, otherwise they will all be immutable.
  - cloneJsonArray
```
JsonArray cloneJsonArray(JsonArray jsonArray,
                         boolean mutable)
```
    Deep copy of the JsonArray, so any modification to the original won't affect the clone, and vice-versa.
    Note that if the current object is immutable and the mutable parameter is set to false, then the current array will be returned as is, since no cloning is required.
    
    Parameters:
    
    mutable - if true the resulting array and all its children will be mutable, otherwise they will all be immutable.
  - getElementAtJsonPath
```
Object getElementAtJsonPath(JsonObject obj,
                            String jsonPath)
```
    Gets an element from the JsonObject at the specified JsonPath.
    
    Returns:
    
    the element or null if not found.
  - getElementAtJsonPath
```
Object getElementAtJsonPath(JsonObject obj,
                            String jsonPath,
                            Object defaultElement)
```
    Gets an element from the JsonObject at the specified JsonPath.
    
    Returns:
    
    the element or null if not found.
  - getElementAtJsonPath
```
Object getElementAtJsonPath(JsonArray array,
                            String jsonPath)
```
    Gets an element from the JsonArray at the specified JsonPath.
    
    Returns:
    
    the element or null if not found.
  - getElementAtJsonPath
```
Object getElementAtJsonPath(JsonArray array,
                            String jsonPath,
                            Object defaultElement)
```
    Gets an element from the JsonArray at the specified JsonPath.
    
    Returns:
    
    the element or null if not found.
  - putElementAtJsonPath
```
void putElementAtJsonPath(JsonObjectOrArray obj,
                          String jsonPath,
                          Object element)
```
    Puts an element in the object at the specified JsonPath.
    All the hierarchy to the end of the JsonPath is created if required.
  - putElementAtJsonPath
```
void putElementAtJsonPath(JsonObjectOrArray obj,
                          String jsonPath,
                          Object element,
                          boolean clone)
```
    Puts a clone of the element in the object at the specified JsonPath.
    All the hierarchy to the end of the JsonPath is created if required.
  - removeElementAtJsonPath
```
void removeElementAtJsonPath(JsonObject obj,
                             String jsonPath)
```
    Removes an element at the specified JsonPath from the object.
  - removeElementAtJsonPath
```
void removeElementAtJsonPath(JsonArray array,
                             String jsonPath)
```
    Removes an element at the specified JsonPath from the array.
  - isElementExists
```
boolean isElementExists(JsonObject obj,
                        String jsonPath)
```
    Does the object contain an element at the specified JsonPath (even if null)?
  - isElementExists
```
boolean isElementExists(JsonArray array,
                        String jsonPath)
```
    Does the array contain an element at the specified JsonPath (even if null)?

Interface JsonManager

Method Summary

Method Detail

create

fromString

fromMap

fromMap

fromInputStream

fromFile

fromFile

fromClasspathFile

fromStringToMap

fromInputStreamToMap

fromString

fromInputStream

createArray

fromStringArray

fromListArray

fromInputStreamArray

toJsonString

toJsonString

parseDateFromJson

convertToJsonDate

convertToNativeType

clone

clone

cloneJsonObject

cloneJsonArray

getElementAtJsonPath

getElementAtJsonPath

getElementAtJsonPath

getElementAtJsonPath

putElementAtJsonPath

putElementAtJsonPath

removeElementAtJsonPath

removeElementAtJsonPath

isElementExists

isElementExists