PersistorToJSONString (SAFS API DOCUMENT)

java.lang.Object
- org.safs.persist.PersistableChecker
- - org.safs.persist.AbstractPersistor
  - - org.safs.persist.PersistorToString
    - - org.safs.persist.PersistorToHierarchialString
      - org.safs.persist.PersistorToJSONString

All Implemented Interfaces:: Persistor

public class PersistorToJSONString
extends PersistorToHierarchialString

Write Persistable object to a JSON string, such as:

 {
 "Response": {
   "StatusCode": "200",
   "Headers" : "{Date=Tue, 13 Dec 2016 03:32:13 GMT, Content-Length=4574, Content-Type=application/xml}",
   "EntityBody" : "<?xml version=\"1.0\"?><CUSTOMERList xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n    <CUSTOMER xlink:href=\"http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/\">0</CUSTOMER>    \n</CUSTOMERList>",
   "Request": {
      "Method": "GET",
      "Headers": "{Date=Tue, 06 Dec 2016 03:08:12 GMT, Content-Length=4574}"
   }
  }
 }

NOTE: Be careful with the value occupying multiple lines, which should be escaped as characters \n; the double quote " should be escaped as \". The example is shown as above.

Author:: Lei Wang

Field Summary

Fields
Modifier and Type Field and Description

(package private) org.json.JSONObject jsonObject
- Fields inherited from class org.safs.persist.PersistorToHierarchialString
  JSON_ARRAY_BRACKET_LEFT, JSON_ARRAY_BRACKET_RIGHT, JSON_ARRAY_COMMA_SEP
- Fields inherited from class org.safs.persist.PersistorToString
  ignoredFieldsForUnpickle, stringFormat, stringFormatReader

Fields
Modifier and Type	Field and Description
`(package private) org.json.JSONObject`	`jsonObject`

Constructor Summary

Constructors
Constructor and Description

PersistorToJSONString()

PersistorToJSONString(java.io.Reader stringFormatReader)

PersistorToJSONString(java.lang.String stringFormat)

Constructors
Constructor and Description
`PersistorToJSONString()`
`PersistorToJSONString(java.io.Reader stringFormatReader)`
`PersistorToJSONString(java.lang.String stringFormat)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`beforeUnpickle()` Prepare the parser with the string format of a Persistable object.
`protected Persistable`	`doUnpickle()` Convert the string format of a Persistable object to Persistable object.
`protected java.lang.String`	`escape(java.lang.String value)` Escape special characters such as value occupying multiple lines, which should be escaped as characters \n; the double quote should be escaped as \".
`protected java.lang.String`	`getChildBegin(java.lang.String key, java.lang.String value, java.lang.String classname)` This is called inside `PersistorToHierarchialString.parse(Persistable, boolean)` to write "key" and "value" of a child.
`protected java.lang.String`	`getChildEnd(boolean lastChild)` This is called inside `PersistorToHierarchialString.parse(Persistable, boolean)` to write the end of a child, here a newline "\n" is written.
`protected java.lang.String`	`getContainerBegin(java.lang.String className, boolean needLeadingName)` This is called inside `PersistorToHierarchialString.parse(Persistable, boolean)` to write the begin of a container such as: <tagNam> for XML format "tagName" : {\n for JSON format
`protected java.lang.String`	`getContainerEnd(java.lang.String className)` This is called inside `PersistorToHierarchialString.parse(Persistable, boolean)` to write the end of a container such as: </tagNam> for XML file } for JSON file.
`protected boolean`	`stringNeedQuoted()` If the string value needs to be quoted before writing into a kind of persistence. JSON file requires that for string value. In JSON file, For example: "key" : "stringValue" is good "key" : stringValue is bad
`static Persistable`	`unpickleParse(org.json.JSONObject body)` Try to convert JSON File to a `Persistable` object. In JSON file, the special JSON key `Constants.JSONConstants.PROPERTY_CLASSNAME` holds the name of the class which the JSONObject represents; the other keys are the name of the fields of that class.
`protected void`	`writeHeader(Persistable persistable)` This is called before `PersistorToString.write(Persistable)`.
`protected void`	`writeTailer(Persistable persistable)` This is called after `PersistorToString.write(Persistable)`.

Methods inherited from class org.safs.persist.PersistorToHierarchialString
getTagName, parse, parseArrayField, parseFieldValue

Methods inherited from class org.safs.persist.PersistorToString
getPersistenceName, getStringFormat, getStringFormatReader, getType, isIgnoredField, persist, setStringFormat, setStringFormatReader, unpersist, unpickle, write

Methods inherited from class org.safs.persist.PersistableChecker
validate

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

- Field Detail
  - jsonObject
```
org.json.JSONObject jsonObject
```
- Constructor Detail
  - PersistorToJSONString
```
public PersistorToJSONString()
```
  - PersistorToJSONString
```
public PersistorToJSONString(java.lang.String stringFormat)
```
  - PersistorToJSONString
```
public PersistorToJSONString(java.io.Reader stringFormatReader)
```
- Method Detail
  - writeHeader
```
protected void writeHeader(Persistable persistable)
                    throws SAFSException
```
    Description copied from class: PersistorToString
    
    This is called before PersistorToString.write(Persistable).
    
    Overrides:
    
    writeHeader in class PersistorToString
    
    Throws:
    
    SAFSException
  - writeTailer
```
protected void writeTailer(Persistable persistable)
                    throws SAFSException
```
    Description copied from class: PersistorToString
    
    This is called after PersistorToString.write(Persistable).
    
    Overrides:
    
    writeTailer in class PersistorToString
    
    Throws:
    
    SAFSException
  - beforeUnpickle
```
protected void beforeUnpickle()
                       throws SAFSException
```
    Description copied from class: PersistorToString
    
    Prepare the parser with the string format of a Persistable object.
    
    Overrides:
    
    beforeUnpickle in class PersistorToString
    
    Throws:
    
    SAFSException
  - doUnpickle
```
protected Persistable doUnpickle()
                          throws SAFSException
```
    Description copied from class: PersistorToString
    
    Convert the string format of a Persistable object to Persistable object.
    
    Overrides:
    
    doUnpickle in class PersistorToString
    
    Returns:
    
    Persistable, the Persistable object.
    
    Throws:
    
    SAFSException
  - unpickleParse
```
public static Persistable unpickleParse(org.json.JSONObject body)
                                 throws SAFSException
```
    Try to convert JSON File to a Persistable object.
    In JSON file, the special JSON key Constants.JSONConstants.PROPERTY_CLASSNAME holds the name of the class which the JSONObject represents; the other keys are the name of the fields of that class.
    
    Parameters:
    
    body - JSONObject
    
    Returns:
    
    Persistable
    
    Throws:
    
    SAFSException
  - stringNeedQuoted
```
protected boolean stringNeedQuoted()
```
    Description copied from class: PersistorToString
    
    If the string value needs to be quoted before writing into a kind of persistence.
    JSON file requires that for string value.
    In JSON file, For example:
    "key" : "stringValue" is good
    "key" : stringValue is bad
    
    Overrides:
    
    stringNeedQuoted in class PersistorToString
    
    Returns:
    
    boolean true if the value needs to be quoted before writing into persistence.
  - escape
```
protected java.lang.String escape(java.lang.String value)
```
    Escape special characters such as value occupying multiple lines, which should be escaped as characters \n; the double quote should be escaped as \".
    
    Overrides:
    
    escape in class PersistorToString
    
    Parameters:
    
    value - String, the value to escape
    
    Returns:
    
    String, the escaped string
    
    See Also:
    
    PersistorToString.stringNeedQuoted()
  - getContainerBegin
```
protected java.lang.String getContainerBegin(java.lang.String className,
                                             boolean needLeadingName)
```
    Description copied from class: PersistorToHierarchialString
    This is called inside PersistorToHierarchialString.parse(Persistable, boolean) to write the begin of a container such as:
    - <tagNam> for XML format
    - "tagName" : {\n for JSON format
    Specified by:
    
    getContainerBegin in class PersistorToHierarchialString
    
    Parameters:
    
    className - String, the class name of a container. This is a full class-name, which may needs to treated to get the simple class name as the tag-name.
    
    needLeadingName - boolean, if the leading tag name is needed. For example sometimes we don't need the "tagName" for JSON format.
  - getContainerEnd
```
protected java.lang.String getContainerEnd(java.lang.String className)
```
    Description copied from class: PersistorToHierarchialString
    This is called inside PersistorToHierarchialString.parse(Persistable, boolean) to write the end of a container such as:
    - </tagNam> for XML file
    - } for JSON file.
    Specified by:
    
    getContainerEnd in class PersistorToHierarchialString
    
    Parameters:
    
    className - String, the tag name, it is normally a container. This is a full class-name, which may needs to treated to get the simple class name as the tag-name.
  - getChildBegin
```
protected java.lang.String getChildBegin(java.lang.String key,
                                         java.lang.String value,
                                         java.lang.String classname)
```
    Description copied from class: PersistorToHierarchialString
    
    This is called inside PersistorToHierarchialString.parse(Persistable, boolean) to write "key" and "value" of a child.
    
    Specified by:
    
    getChildBegin in class PersistorToHierarchialString
    
    Parameters:
    
    key - String, the key name
    
    value - String, the value
    
    classname - String, the class name of this value. It is not useful with JSON format, but it is useful for XML format.
  - getChildEnd
```
protected java.lang.String getChildEnd(boolean lastChild)
```
    Description copied from class: PersistorToHierarchialString
    
    This is called inside PersistorToHierarchialString.parse(Persistable, boolean) to write the end of a child, here a newline "\n" is written.
    
    Overrides:
    
    getChildEnd in class PersistorToHierarchialString
    
    Parameters:
    
    lastChild - boolean, if this is the last child within the container. it is useful for some file format, such as JSON, if this is false (not the last child), a comma , needs to be added at the end as "key" : "value" ,

Class PersistorToJSONString

Field Summary

Fields inherited from class org.safs.persist.PersistorToHierarchialString

Fields inherited from class org.safs.persist.PersistorToString

Constructor Summary

Method Summary

Methods inherited from class org.safs.persist.PersistorToHierarchialString

Methods inherited from class org.safs.persist.PersistorToString

Methods inherited from class org.safs.persist.PersistableChecker

Methods inherited from class java.lang.Object

Field Detail

jsonObject

Constructor Detail

PersistorToJSONString

PersistorToJSONString

PersistorToJSONString

Method Detail

writeHeader

writeTailer

beforeUnpickle

doUnpickle

unpickleParse

stringNeedQuoted

escape

getContainerBegin

getContainerEnd

getChildBegin

getChildEnd