IJsonManager (org.spincast:spincast-framework 0.9.28 API)

All Known Implementing Classes:

SpincastJsonManager
```
public interface IJsonManager
```
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 `IJsonObject` or a `IJsonArray`, if the object is not of a primitive type (or `BigDecimal`).
`Object`	`clone(Object originalObject, boolean mutable)` Tries to clone an object to a `IJsonObject` or a `IJsonArray`, if the object is not of a primitive type (or `BigDecimal`).
`IJsonArray`	`cloneJsonArray(IJsonArray jsonArray)` Deep copy of the `IJsonArray`, so any modification to the original won't affect the clone, and vice-versa.
`IJsonArray`	`cloneJsonArray(IJsonArray jsonArray, boolean mutable)` Deep copy of the `IJsonArray`, so any modification to the original won't affect the clone, and vice-versa.
`IJsonObject`	`cloneJsonObject(IJsonObject jsonObject)` Deep copy of the `IJsonObject`, so any modification to the original won't affect the clone, and vice-versa.
`IJsonObject`	`cloneJsonObject(IJsonObject jsonObject, boolean mutable)` Deep copy of the `IJsonObject`, so any modification to the original won't affect the clone, and vice-versa.
`Object`	`convertToNativeType(Object originalObject)` Convert a random object to a valid native Json type, if it's not already.
`IJsonObject`	`create()` Creates an empty `JsonObject`
`IJsonObject`	`create(InputStream inputStream)` Creates a `JsonObject` from an inputStream.
`IJsonObject`	`create(Map<String,?> params)` Creates an empty `JsonObject` based on the specified Map.
`IJsonObject`	`create(String jsonString)` Creates a `JsonObject` from a `Json` String.
`IJsonArray`	`createArray()` Creates an empty `JsonArray`.
`IJsonArray`	`createArray(InputStream inputStream)` Creates a `JsonArray` from an inputStream.
`IJsonArray`	`createArray(List<?> elements)` Creates a `JsonArray` from a `List` of elements.
`IJsonArray`	`createArray(String jsonString)` Creates a `JsonArray` from a `Json` String.
`IJsonArrayImmutable`	`createArrayImmutable(IJsonArray jsonArray)` Make a `IJsonArray` immutable, no element could be added or removed on it.
`IJsonObjectImmutable`	`createImmutable(IJsonObject jsonObject)` Make a `IJsonObject` immutable, no element could be added or removed on it.
`<T> T`	`fromJsonInputStream(InputStream inputStream, Class<T> clazz)` Creates an instance of the specified `T` type from a `Json` inputStream.
`Map<String,Object>`	`fromJsonInputStreamToMap(InputStream inputStream)` Creates a `Map<String, Object>` from a `Json` inputStream.
`<T> T`	`fromJsonString(String jsonString, Class<T> clazz)` Creates an instance of the specified `T` type from a `Json` String.
`Map<String,Object>`	`fromJsonStringToMap(String jsonString)` Creates a `Map<String, Object>` from a `Json` String.
`Date`	`parseDateFromJson(String str)` Converts a `Json` date to a Java `UTC` date.
`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
```
IJsonObject create()
```
    Creates an empty JsonObject
  - create
```
IJsonObject create(String jsonString)
```
    Creates a JsonObject from a Json String.
  - create
```
IJsonObject create(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 referecen and vice-versa.
  - create
```
IJsonObject create(InputStream inputStream)
```
    Creates a JsonObject from an inputStream.
  - createImmutable
```
IJsonObjectImmutable createImmutable(IJsonObject jsonObject)
```
    Make a IJsonObject immutable, no element could be added or removed on it.
  - createArray
```
IJsonArray createArray()
```
    Creates an empty JsonArray.
  - createArray
```
IJsonArray createArray(String jsonString)
```
    Creates a JsonArray from a Json String.
  - createArray
```
IJsonArray createArray(List<?> elements)
```
    Creates a JsonArray from a List of elements.
  - createArray
```
IJsonArray createArray(InputStream inputStream)
```
    Creates a JsonArray from an inputStream.
  - createArrayImmutable
```
IJsonArrayImmutable createArrayImmutable(IJsonArray jsonArray)
```
    Make a IJsonArray immutable, no element could be added or removed on it.
  - 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.
  - fromJsonStringToMap
```
Map<String,Object> fromJsonStringToMap(String jsonString)
```
    Creates a Map<String, Object> from a Json String.
  - fromJsonInputStreamToMap
```
Map<String,Object> fromJsonInputStreamToMap(InputStream inputStream)
```
    Creates a Map<String, Object> from a Json inputStream.
  - fromJsonString
```
<T> T fromJsonString(String jsonString,
                     Class<T> clazz)
```
    Creates an instance of the specified T type from a Json String.
  - fromJsonInputStream
```
<T> T fromJsonInputStream(InputStream inputStream,
                          Class<T> clazz)
```
    Creates an instance of the specified T type from a Json inputStream.
  - parseDateFromJson
```
Date parseDateFromJson(String str)
```
    Converts a Json date to a Java UTC date.
  - convertToNativeType
```
Object convertToNativeType(Object originalObject)
```
    Convert a random object to a valid native Json type, if it's not already.
  - clone
```
Object clone(Object originalObject)
```
    Tries to clone an object to a IJsonObject or a IJsonArray, 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 IJsonArray if it is a :
    - IJsonArray
    - Collection
    - Array
  - clone
```
Object clone(Object originalObject,
             boolean mutable)
```
    Tries to clone an object to a IJsonObject or a IJsonArray, 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 IJsonArray if it is a :
    - IJsonArray
    - Collection
    - Array
    Parameters:
    
    mutable - if false, the resulting Object and all its potential children will be immutable.
  - cloneJsonObject
```
IJsonObject cloneJsonObject(IJsonObject jsonObject)
```
    Deep copy of the IJsonObject, so any modification to the original won't affect the clone, and vice-versa.
    The resulting IJsonObject is mutable.
  - cloneJsonObject
```
IJsonObject cloneJsonObject(IJsonObject jsonObject,
                            boolean mutable)
```
    Deep copy of the IJsonObject, so any modification to the original won't affect the clone, and vice-versa.
    
    Parameters:
    
    mutable - if false, the resulting IJsonArray and all its children will be immutable.
  - cloneJsonArray
```
IJsonArray cloneJsonArray(IJsonArray jsonArray)
```
    Deep copy of the IJsonArray, so any modification to the original won't affect the clone, and vice-versa.
    The resulting IJsonArray is mutable.
  - cloneJsonArray
```
IJsonArray cloneJsonArray(IJsonArray jsonArray,
                          boolean mutable)
```
    Deep copy of the IJsonArray, so any modification to the original won't affect the clone, and vice-versa.
    
    Parameters:
    
    mutable - if false, the resulting IJsonArray and all its children will be immutable.

Interface IJsonManager

Method Summary

Method Detail

create

create

create

create

createImmutable

createArray

createArray

createArray

createArray

createArrayImmutable

toJsonString

toJsonString

fromJsonStringToMap

fromJsonInputStreamToMap

fromJsonString

fromJsonInputStream

parseDateFromJson

convertToNativeType

clone

clone

cloneJsonObject

cloneJsonObject

cloneJsonArray

cloneJsonArray