JSONSerializer (JSON Tools 2.0 API)

java.lang.Object
- com.sdicons.json.serializer.JSONSerializer

public class JSONSerializer
extends Object

Convert a JSON representation to/from a Java representation. The serializer's goal is to preserve as much Java structure as possible: primitive types, arrays, object clusters containing recursive references and so on. As a consequence, the generated JSON is rather terse. The serializer is the best choice in a Java centric application where you want to write some object structures to JSON in a readable form. If the emphasis is on clean JSON, take a look at the Mapper tool, which does not support all Java constructs but which emits nice JSON which can easily be parsed in e.g. Javascript. * The main difference between the serializer and the mapper is that the serializer keeps as much type information and structure information in the JSON data where the mapper uses the type information in the provided Java classes to interpret the JSON data.
Example: The Java model

 
 public class Person {
   private String name;
   private String phoneNumber;
   private int age;
   // Getters and setters omitted.
   // ...
 }

The mapping code

 
 // Create a person.
 Person p = new Person();
 p.setName("Mr. Jason Tools");
 p.setPhoneNumber("0123456789");
 p.setAge(40);
 // Map and print.
 JSONSerializer serializer = new JSONSerializer();
 JSONValue json = serializer.marshal(p);
 System.out.println(json.render(true));

The resulting JSON text

 
 {
    ">" : "O",
    "&" : "id0",
    "c" : "com.sdicons.json.examples.Person",
    "=" :
       {
          "age" :
             {
                ">" : "O",
                "&" : "id1",
                "c" : "java.lang.Integer",
                "=" : "40"
             },
          "name" :
             {
                ">" : "O",
                "&" : "id2",
                "c" : "java.lang.String",
                "=" : "Mr. Jason Tools"
             },
          "phoneNumber" :
             {
                ">" : "O",
                "&" : "id3",
                "c" : "java.lang.String",
                "=" : "0123456789"
             }
       }
 }

See Also:: JSONMapper

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DATESERIALIZE_DEFAULT`
`static String`	`ERR_MISSINGATTR`
`static String`	`ERR_MISSINGATTRVAL`
`static String`	`ERR_MISSINGSTRING`
`static String`	`OBJSERIALIZE_FIELD`
`static String`	`OBJSERIALIZE_PROPERTY`
`static String`	`OPT_DATESERIALIZE`
`static String`	`OPT_OBJSERIALIZE`
`static String`	`RNDR_ARR`
`static String`	`RNDR_ATTR_CLASS`
`static String`	`RNDR_ATTR_ID`
`static String`	`RNDR_ATTR_KIND`
`static String`	`RNDR_ATTR_REF`
`static String`	`RNDR_ATTR_TYPE`
`static String`	`RNDR_ATTR_VALUE`
`static String`	`RNDR_NULL`
`static String`	`RNDR_OBJ`
`static String`	`RNDR_OBJREF`
`static String`	`RNDR_PRIM`
`static String`	`RNDR_PRTITYP_BOOLEAN`
`static String`	`RNDR_PRTITYP_BYTE`
`static String`	`RNDR_PRTITYP_CHAR`
`static String`	`RNDR_PRTITYP_DOUBLE`
`static String`	`RNDR_PRTITYP_FLOAT`
`static String`	`RNDR_PRTITYP_INT`
`static String`	`RNDR_PRTITYP_LONG`
`static String`	`RNDR_PRTITYP_SHORT`

Constructor Summary

Constructors
Constructor and Description

JSONSerializer()

JSONSerializer(ClassSerializer... serializers)

Constructors
Constructor and Description
`JSONSerializer()`
`JSONSerializer(ClassSerializer... serializers)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addHelper(ClassSerializer aHelper)` Add custom helper class.
`Object`	`getSerializeOption(String key, Object defaultValue)`
`boolean`	`hasSerializeOption(String key)`
`JSONObject`	`marshal(boolean aValue)` Convert a boolean primitive to JSON.
`JSONObject`	`marshal(byte aValue)` Convert a byte primitive to JSON.
`JSONObject`	`marshal(char aValue)` Convert a char primitive to JSON.
`JSONObject`	`marshal(double aValue)` Convert a double primitive to JSON.
`JSONObject`	`marshal(float aValue)` Convert a float primitive to JSON.
`JSONObject`	`marshal(int aValue)` Convert an int primitive to JSON.
`JSONObject`	`marshal(long aValue)` Convert a long primitive to JSON.
`JSONObject`	`marshal(Object aObj)` Convert a Java object to JSON.
`JSONObject`	`marshal(short aValue)` Convert a short primitive to JSON.
`JSONObject`	`marshalImpl(Object aObj, HashMap<Object,Object> aPool)`
`static void`	`requireStringAttribute(JSONObject aElement, String anAttribute)`
`void`	`setSerializeOption(String key, Object value)`
`SerializerValue`	`unmarshal(JSONObject aElement)` Convert a JSON representation to the Java primitive or reference.
`Object`	`unmarshalImpl(JSONObject aElement, HashMap<Object,Object> aObjectPool)`
`void`	`useJavaBeanAccess()` The objects that fall back on the general object helper will be serialized by using their JavaBean properties.
`void`	`usePojoAccess()` The objects that fall back on the general object helper will be serialized by using their fields directly.

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

- Field Detail
  - OPT_OBJSERIALIZE
```
public static final String OPT_OBJSERIALIZE
```
    See Also:
    Constant Field Values
  - OBJSERIALIZE_FIELD
```
public static final String OBJSERIALIZE_FIELD
```
    See Also:
    Constant Field Values
  - OBJSERIALIZE_PROPERTY
```
public static final String OBJSERIALIZE_PROPERTY
```
    See Also:
    Constant Field Values
  - OPT_DATESERIALIZE
```
public static final String OPT_DATESERIALIZE
```
    See Also:
    Constant Field Values
  - DATESERIALIZE_DEFAULT
```
public static final String DATESERIALIZE_DEFAULT
```
    See Also:
    Constant Field Values
  - RNDR_NULL
```
public static final String RNDR_NULL
```
    See Also:
    Constant Field Values
  - RNDR_OBJ
```
public static final String RNDR_OBJ
```
    See Also:
    Constant Field Values
  - RNDR_OBJREF
```
public static final String RNDR_OBJREF
```
    See Also:
    Constant Field Values
  - RNDR_PRIM
```
public static final String RNDR_PRIM
```
    See Also:
    Constant Field Values
  - RNDR_ARR
```
public static final String RNDR_ARR
```
    See Also:
    Constant Field Values
  - RNDR_ATTR_ID
```
public static final String RNDR_ATTR_ID
```
    See Also:
    Constant Field Values
  - RNDR_ATTR_KIND
```
public static final String RNDR_ATTR_KIND
```
    See Also:
    Constant Field Values
  - RNDR_ATTR_TYPE
```
public static final String RNDR_ATTR_TYPE
```
    See Also:
    Constant Field Values
  - RNDR_ATTR_VALUE
```
public static final String RNDR_ATTR_VALUE
```
    See Also:
    Constant Field Values
  - RNDR_ATTR_CLASS
```
public static final String RNDR_ATTR_CLASS
```
    See Also:
    Constant Field Values
  - RNDR_ATTR_REF
```
public static final String RNDR_ATTR_REF
```
    See Also:
    Constant Field Values
  - RNDR_PRTITYP_BOOLEAN
```
public static final String RNDR_PRTITYP_BOOLEAN
```
    See Also:
    Constant Field Values
  - RNDR_PRTITYP_BYTE
```
public static final String RNDR_PRTITYP_BYTE
```
    See Also:
    Constant Field Values
  - RNDR_PRTITYP_CHAR
```
public static final String RNDR_PRTITYP_CHAR
```
    See Also:
    Constant Field Values
  - RNDR_PRTITYP_SHORT
```
public static final String RNDR_PRTITYP_SHORT
```
    See Also:
    Constant Field Values
  - RNDR_PRTITYP_INT
```
public static final String RNDR_PRTITYP_INT
```
    See Also:
    Constant Field Values
  - RNDR_PRTITYP_LONG
```
public static final String RNDR_PRTITYP_LONG
```
    See Also:
    Constant Field Values
  - RNDR_PRTITYP_FLOAT
```
public static final String RNDR_PRTITYP_FLOAT
```
    See Also:
    Constant Field Values
  - RNDR_PRTITYP_DOUBLE
```
public static final String RNDR_PRTITYP_DOUBLE
```
    See Also:
    Constant Field Values
  - ERR_MISSINGATTR
```
public static final String ERR_MISSINGATTR
```
    See Also:
    Constant Field Values
  - ERR_MISSINGATTRVAL
```
public static final String ERR_MISSINGATTRVAL
```
    See Also:
    Constant Field Values
  - ERR_MISSINGSTRING
```
public static final String ERR_MISSINGSTRING
```
    See Also:
    Constant Field Values
- Constructor Detail
  - JSONSerializer
```
public JSONSerializer()
```
  - JSONSerializer
```
public JSONSerializer(ClassSerializer... serializers)
```
- Method Detail
  - marshal
```
public JSONObject marshal(boolean aValue)
```
    Convert a boolean primitive to JSON.
    
    Parameters:
    aValue -
    
    Returns:
    An JSON representation of the boolean primitive.
  - marshal
```
public JSONObject marshal(byte aValue)
```
    Convert a byte primitive to JSON.
    
    Parameters:
    aValue -
    
    Returns:
    An JSON representation of the byte primitive.
  - marshal
```
public JSONObject marshal(short aValue)
```
    Convert a short primitive to JSON.
    
    Parameters:
    aValue -
    
    Returns:
    An JSON representation of the short primitive.
  - marshal
```
public JSONObject marshal(char aValue)
```
    Convert a char primitive to JSON.
    
    Parameters:
    aValue -
    
    Returns:
    An JSON representation of the char primitive.
  - marshal
```
public JSONObject marshal(int aValue)
```
    Convert an int primitive to JSON.
    
    Parameters:
    aValue -
    
    Returns:
    An JSON representation of the int primitive.
  - marshal
```
public JSONObject marshal(long aValue)
```
    Convert a long primitive to JSON.
    
    Parameters:
    aValue -
    
    Returns:
    An JSON representation of the long primitive.
  - marshal
```
public JSONObject marshal(float aValue)
```
    Convert a float primitive to JSON.
    
    Parameters:
    aValue -
    
    Returns:
    An JSON representation of the float primitive.
  - marshal
```
public JSONObject marshal(double aValue)
```
    Convert a double primitive to JSON.
    
    Parameters:
    aValue -
    
    Returns:
    An JSON representation of the double primitive.
  - marshal
```
public JSONObject marshal(Object aObj)
                   throws SerializerException
```
    Convert a Java object to JSON.
    
    Parameters:
    aObj -
    
    Returns:
    The JSON representation of the Java object.
    
    Throws:
    
    SerializerException - An error occurred while converting the Java object to JSON.
  - marshalImpl
```
public JSONObject marshalImpl(Object aObj,
                     HashMap<Object,Object> aPool)
                       throws SerializerException
```
    Throws:
    
    SerializerException
  - unmarshal
```
public SerializerValue unmarshal(JSONObject aElement)
                          throws SerializerException
```
    Convert a JSON representation to the Java primitive or reference.
    
    Parameters:
    aElement -
    
    Returns:
    The Java representation of the JSON. This value can represent a Java primitive value or it can represent a Java reference.
    
    Throws:
    
    SerializerException - An error occured while trying to convert the JSON representation into a Java representation.
  - unmarshalImpl
```
public Object unmarshalImpl(JSONObject aElement,
                   HashMap<Object,Object> aObjectPool)
                     throws SerializerException
```
    Throws:
    
    SerializerException
  - requireStringAttribute
```
public static void requireStringAttribute(JSONObject aElement,
                          String anAttribute)
                                   throws SerializerException
```
    Throws:
    
    SerializerException
  - addHelper
```
public void addHelper(ClassSerializer aHelper)
```
    Add custom helper class.
    
    Parameters:
    aHelper - the custom helper you want to add to the serializer.
  - usePojoAccess
```
public void usePojoAccess()
```
    The objects that fall back on the general object helper will be serialized by using their fields directly. Without further annotations, the default constructor without arguments will be used in the POJO. If this is not sufficient, the @JSONConstructor and @JSONConstructorArgs annotations can be used as well in the POJO to indicate which constructor has to be used.
  - useJavaBeanAccess
```
public void useJavaBeanAccess()
```
    The objects that fall back on the general object helper will be serialized by using their JavaBean properties. The JavaBean always needs a default constructor without arguments.
  - setSerializeOption
```
public void setSerializeOption(String key,
                      Object value)
```
  - getSerializeOption
```
public Object getSerializeOption(String key,
                        Object defaultValue)
```
  - hasSerializeOption
```
public boolean hasSerializeOption(String key)
```

Class JSONSerializer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OPT_OBJSERIALIZE

OBJSERIALIZE_FIELD

OBJSERIALIZE_PROPERTY

OPT_DATESERIALIZE

DATESERIALIZE_DEFAULT

RNDR_NULL

RNDR_OBJ

RNDR_OBJREF

RNDR_PRIM

RNDR_ARR

RNDR_ATTR_ID

RNDR_ATTR_KIND

RNDR_ATTR_TYPE

RNDR_ATTR_VALUE

RNDR_ATTR_CLASS

RNDR_ATTR_REF

RNDR_PRTITYP_BOOLEAN

RNDR_PRTITYP_BYTE

RNDR_PRTITYP_CHAR

RNDR_PRTITYP_SHORT

RNDR_PRTITYP_INT

RNDR_PRTITYP_LONG

RNDR_PRTITYP_FLOAT

RNDR_PRTITYP_DOUBLE

ERR_MISSINGATTR

ERR_MISSINGATTRVAL

ERR_MISSINGSTRING

Constructor Detail

JSONSerializer

JSONSerializer

Method Detail

marshal

marshal

marshal

marshal

marshal

marshal

marshal

marshal

marshal

marshalImpl

unmarshal

unmarshalImpl

requireStringAttribute

addHelper

usePojoAccess

useJavaBeanAccess

setSerializeOption

getSerializeOption

hasSerializeOption