OrgJsonValueDeserializer (org.qi4j.core.spi 2.1 API)

java.lang.Object
- org.qi4j.spi.value.ValueDeserializerAdapter<JSONTokener,Object>
- - org.qi4j.valueserialization.orgjson.OrgJsonValueDeserializer

All Implemented Interfaces:

org.qi4j.api.value.ValueDeserializer
```
public class OrgJsonValueDeserializer
extends ValueDeserializerAdapter<JSONTokener,Object>
```
ValueDeserializer reading Values from JSON documents using org.json.

Nested Class Summary
- Nested classes/interfaces inherited from class org.qi4j.spi.value.ValueDeserializerAdapter
  ValueDeserializerAdapter.ComplexDeserializer<T,InputType,InputNodeType>

Constructor Summary

Constructors
Constructor and Description
`OrgJsonValueDeserializer(org.qi4j.api.structure.Application application, org.qi4j.api.structure.Module module, org.qi4j.api.service.ServiceReference<org.qi4j.api.value.ValueDeserializer> serviceRef)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected JSONTokener`	`adaptInput(InputStream input)` This method is always called first, this is a chance to wrap the input type.
`protected Object`	`asSimpleValue(Object inputNode)`
`protected <T> T`	`getObjectFieldValue(Object inputNode, String key, org.qi4j.functional.Function<Object,T> valueDeserializer)` Return null if the field do not exists.
`protected boolean`	`isObjectValue(Object inputNode)`
`protected boolean`	`objectHasField(Object inputNode, String key)`
`protected <T> void`	`putArrayNodeInCollection(Object inputNode, org.qi4j.functional.Function<Object,T> deserializer, Collection<T> collection)`
`protected <K,V> void`	`putArrayNodeInMap(Object inputNode, org.qi4j.functional.Function<Object,K> keyDeserializer, org.qi4j.functional.Function<Object,V> valueDeserializer, Map<K,V> map)`
`protected <V> void`	`putObjectNodeInMap(Object inputNode, org.qi4j.functional.Function<Object,V> valueDeserializer, Map<String,V> map)`
`protected <T> Collection<T>`	`readArrayInCollection(JSONTokener input, org.qi4j.functional.Function<JSONTokener,T> deserializer, Collection<T> collection)`
`protected <K,V> Map<K,V>`	`readMapInMap(JSONTokener input, org.qi4j.functional.Function<JSONTokener,K> keyDeserializer, org.qi4j.functional.Function<JSONTokener,V> valueDeserializer, Map<K,V> map)` A Map<K,V> is serialized in an array of entries objects.
`protected JSONObject`	`readObjectTree(JSONTokener input)`
`protected Object`	`readPlainValue(JSONTokener input)`

Methods inherited from class org.qi4j.spi.value.ValueDeserializerAdapter
deserialize, deserialize, deserialize, deserialize, deserialize, deserialize, deserialize, onDeserializationEnd, onDeserializationStart, registerComplexDeserializer, registerDeserializer

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - OrgJsonValueDeserializer
```
public OrgJsonValueDeserializer(@Structure
                        org.qi4j.api.structure.Application application,
                        @Structure
                        org.qi4j.api.structure.Module module,
                        @Service
                        org.qi4j.api.service.ServiceReference<org.qi4j.api.value.ValueDeserializer> serviceRef)
```
- Method Detail
  - adaptInput
```
protected JSONTokener adaptInput(InputStream input)
                          throws Exception
```
    Description copied from class: ValueDeserializerAdapter
    
    This method is always called first, this is a chance to wrap the input type.
    
    Specified by:
    
    adaptInput in class ValueDeserializerAdapter<JSONTokener,Object>
    
    Parameters:
    input - InputStream to adapt
    
    Returns:
    Adapted input
    
    Throws:
    
    Exception - that will be wrapped in a ValueSerializationException
  - readPlainValue
```
protected Object readPlainValue(JSONTokener input)
                         throws Exception
```
    Specified by:
    
    readPlainValue in class ValueDeserializerAdapter<JSONTokener,Object>
    
    Parameters:
    input - Input
    
    Returns:
    a Plain Value read from the input
    
    Throws:
    
    Exception - that will be wrapped in a ValueSerializationException
  - readArrayInCollection
```
protected <T> Collection<T> readArrayInCollection(JSONTokener input,
                                      org.qi4j.functional.Function<JSONTokener,T> deserializer,
                                      Collection<T> collection)
                                       throws Exception
```
    Specified by:
    
    readArrayInCollection in class ValueDeserializerAdapter<JSONTokener,Object>
    
    Type Parameters:
    T - Parameterized collection type
    Parameters:
    input - Input
    deserializer - Deserialization function
    collection - Collection
    
    Returns:
    The filled collection or null if no array
    
    Throws:
    
    Exception - that will be wrapped in a ValueSerializationException
  - readMapInMap
```
protected <K,V> Map<K,V> readMapInMap(JSONTokener input,
                          org.qi4j.functional.Function<JSONTokener,K> keyDeserializer,
                          org.qi4j.functional.Function<JSONTokener,V> valueDeserializer,
                          Map<K,V> map)
                         throws Exception
```
    Description copied from class: ValueDeserializerAdapter
    A Map<K,V> is serialized in an array of entries objects.
    Here is an example in JSON:
```
 [
     { "key": "foo",       "value": "bar"   },
     { "key": "cathedral", "value": "bazar" }
 ]
 
```
    And an empty Map:
```
[]
```
    This allow to use any type as keys and values while keeping the Map order at the cost of having non-predictible order of key/value inside an entry object.
    Specified by:
    
    readMapInMap in class ValueDeserializerAdapter<JSONTokener,Object>
    
    Type Parameters:
    K - Parameterized map key type
    V - Parameterized map value type
    Parameters:
    input - Input
    keyDeserializer - Map key deserialization function
    valueDeserializer - Map value deserialization function
    map - Map
    
    Returns:
    The filled map or null if no array
    
    Throws:
    
    Exception - that will be wrapped in a ValueSerializationException
  - readObjectTree
```
protected JSONObject readObjectTree(JSONTokener input)
                             throws Exception
```
    Specified by:
    
    readObjectTree in class ValueDeserializerAdapter<JSONTokener,Object>
    
    Parameters:
    input - Input
    
    Returns:
    an InputNodeType or null if the value was null
    
    Throws:
    
    Exception - that will be wrapped in a ValueSerializationException
  - asSimpleValue
```
protected Object asSimpleValue(Object inputNode)
                        throws Exception
```
    Specified by:
    
    asSimpleValue in class ValueDeserializerAdapter<JSONTokener,Object>
    
    Throws:
    
    Exception
  - isObjectValue
```
protected boolean isObjectValue(Object inputNode)
                         throws Exception
```
    Specified by:
    
    isObjectValue in class ValueDeserializerAdapter<JSONTokener,Object>
    
    Throws:
    
    Exception
  - objectHasField
```
protected boolean objectHasField(Object inputNode,
                     String key)
                          throws Exception
```
    Specified by:
    
    objectHasField in class ValueDeserializerAdapter<JSONTokener,Object>
    
    Throws:
    
    Exception
  - getObjectFieldValue
```
protected <T> T getObjectFieldValue(Object inputNode,
                        String key,
                        org.qi4j.functional.Function<Object,T> valueDeserializer)
                         throws Exception
```
    Description copied from class: ValueDeserializerAdapter
    
    Return null if the field do not exists.
    
    Specified by:
    
    getObjectFieldValue in class ValueDeserializerAdapter<JSONTokener,Object>
    
    Type Parameters:
    T - Parameterized object field value type
    Parameters:
    inputNode - Input Node
    key - Object key
    valueDeserializer - Deserialization function
    
    Returns:
    The value of the field.
    
    Throws:
    
    Exception - that will be wrapped in a ValueSerializationException
  - putArrayNodeInCollection
```
protected <T> void putArrayNodeInCollection(Object inputNode,
                                org.qi4j.functional.Function<Object,T> deserializer,
                                Collection<T> collection)
                                 throws Exception
```
    Specified by:
    
    putArrayNodeInCollection in class ValueDeserializerAdapter<JSONTokener,Object>
    
    Throws:
    
    Exception
  - putArrayNodeInMap
```
protected <K,V> void putArrayNodeInMap(Object inputNode,
                           org.qi4j.functional.Function<Object,K> keyDeserializer,
                           org.qi4j.functional.Function<Object,V> valueDeserializer,
                           Map<K,V> map)
                          throws Exception
```
    Specified by:
    
    putArrayNodeInMap in class ValueDeserializerAdapter<JSONTokener,Object>
    
    Throws:
    
    Exception
  - putObjectNodeInMap
```
protected <V> void putObjectNodeInMap(Object inputNode,
                          org.qi4j.functional.Function<Object,V> valueDeserializer,
                          Map<String,V> map)
                           throws Exception
```
    Specified by:
    
    putObjectNodeInMap in class ValueDeserializerAdapter<JSONTokener,Object>
    
    Throws:
    
    Exception

Class OrgJsonValueDeserializer

Nested Class Summary

Nested classes/interfaces inherited from class org.qi4j.spi.value.ValueDeserializerAdapter

Constructor Summary

Method Summary

Methods inherited from class org.qi4j.spi.value.ValueDeserializerAdapter

Methods inherited from class java.lang.Object

Constructor Detail

OrgJsonValueDeserializer

Method Detail

adaptInput

readPlainValue

readArrayInCollection

readMapInMap

readObjectTree

asSimpleValue

isObjectValue

objectHasField

getObjectFieldValue

putArrayNodeInCollection

putArrayNodeInMap

putObjectNodeInMap